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 {"code":"deadline_exceeded","msg":"operation timed out"}