The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
", + "example": { + "max_cache_retention_days": 80 + }, + "schema": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/cache/retention-limit", + "title": "Set GitHub Actions cache retention limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_retention_days", + "in": "body", + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/cache/storage-limit", + "title": "Get GitHub Actions cache storage limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
", + "example": { + "max_cache_size_gb": 150 + }, + "schema": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/cache/storage-limit", + "title": "Set GitHub Actions cache storage limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_size_gb", + "in": "body", + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/cache/retention-limit", + "title": "Get GitHub Actions cache retention limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
", + "example": { + "max_cache_retention_days": 80 + }, + "schema": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/cache/retention-limit", + "title": "Set GitHub Actions cache retention limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_retention_days", + "in": "body", + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/cache/storage-limit", + "title": "Get GitHub Actions cache storage limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
", + "example": { + "max_cache_size_gb": 150 + }, + "schema": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/cache/storage-limit", + "title": "Set GitHub Actions cache storage limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_size_gb", + "in": "body", + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -1179,6 +1807,360 @@ ] } }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit", + "title": "Get GitHub Actions cache retention limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
", + "example": { + "max_cache_retention_days": 80 + }, + "schema": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit", + "title": "Set GitHub Actions cache retention limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
The maximum number of days to keep caches in this repository.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit", + "title": "Get GitHub Actions cache storage limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
", + "example": { + "max_cache_size_gb": 150 + }, + "schema": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit", + "title": "Set GitHub Actions cache storage limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
The maximum total cache size for this repository, in gigabytes.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -94515,6 +95497,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -95644,6 +96634,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -96456,6 +97454,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -97108,6 +98115,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -98740,6 +99755,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -99587,6 +100611,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -101218,6 +102250,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -102352,6 +103392,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103484,6 +104532,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105887,6 +106943,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -111264,6 +112328,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -112331,6 +113403,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -113873,6 +114953,47 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"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.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page_size", + "description": "The number of results per page (max 10).
", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.
", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost-center" + ] + } } ], "bodyParameters": [], @@ -114036,6 +115157,10 @@ ] }, "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ @@ -114387,7 +115512,22 @@ "description": "Budget updated successfully
", "example": { "message": "Budget successfully updated.", - "id": "550e8400-e29b-41d4-a716-446655440000" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } }, "schema": { "type": "object", @@ -118855,6 +119995,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -118887,6 +120028,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -122287,6 +123429,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -122319,6 +123462,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -125824,6 +126968,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -125856,6 +127001,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -169656,7 +170802,6 @@ "name": "state", "in": "body", "description": "Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -446628,6 +447790,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -447395,7 +448593,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -448033,7 +449231,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -448850,7 +450048,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -449488,7 +450686,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -450017,7 +451215,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -450693,6 +451891,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -451461,7 +452695,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -452099,7 +453333,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -477569,9 +478803,9 @@ }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", - "title": "Get project field for organization", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "title": "Add a field to an organization-owned project.", "category": "projects", "subcategory": "fields", "parameters": [ @@ -477584,15 +478818,6 @@ "type": "integer" } }, - { - "name": "field_id", - "description": "The unique identifier of the field.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", @@ -477603,52 +478828,1473 @@ } } ], - "bodyParameters": [], - "descriptionHTML": "Get a specific field for an organization-owned project.
", - "codeExamples": [ + "bodyParameters": [ { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_number": "PROJECT_NUMBER", - "field_id": "FIELD_ID", - "org": "ORG" + "type": "integer", + "name": "issue_field_id", + "in": "body", + "description": "The ID of the IssueField to create the field for.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the field.
", + "isRequired": true + }, + { + "type": "string", + "name": "data_type", + "in": "body", + "description": "The field's data type.
", + "isRequired": true, + "enum": [ + "iteration" + ] + }, + { + "type": "array of objects", + "name": "single_select_options", + "in": "body", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The display name of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "The color associated with the option.
", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + { + "type": "string", + "name": "description", + "description": "The description of the option.
" } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 12345, - "node_id": "PVTF_lADOABCD1234567890", - "name": "Priority", - "data_type": "single_select", - "project_url": "https://api.github.com/projects/67890", - "options": [ + ] + }, + { + "type": "object", + "name": "iteration_configuration", + "in": "body", + "description": "The configuration for iteration fields.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "start_date", + "description": "The start date of the first iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The default duration for iterations in days. Individual iterations can override this value.
" + }, + { + "type": "array of objects", + "name": "iterations", + "description": "Zero or more iterations for the field.
", + "childParamsGroups": [ { - "id": "option_1", - "name": "Low", - "color": "GREEN", - "description": "Low priority items" + "type": "string", + "name": "title", + "description": "The title of the iteration.
" }, { - "id": "option_2", - "name": "Medium", - "color": "YELLOW", - "description": "Medium priority items" + "type": "string", + "name": "start_date", + "description": "The start date of the iteration.
" }, { - "id": "option_3", - "name": "High", - "color": "RED", - "description": "High priority items" + "type": "integer", + "name": "duration", + "description": "The duration of the iteration in days.
" } - ], - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z" + ] + } + ] + } + ], + "descriptionHTML": "Add a field to an organization-owned project.
", + "codeExamples": [ + { + "key": "text_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a text field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team notes", + "data_type": "text" + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "number_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a number field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Story points", + "data_type": "number" + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "date_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a date field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Due date", + "data_type": "date" + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "single_select_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a single select field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "iteration_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create an iteration field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Response for adding a field to an organization-owned project.
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for organization", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Get a specific field for an organization-owned project.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" }, "schema": { "title": "Projects v2 Field", @@ -478327,6 +480973,1388 @@ "permissions": [] } }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/users/{username}/projectsV2/{project_number}/fields", + "title": "Add field to user owned project", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the field.
", + "isRequired": true + }, + { + "type": "string", + "name": "data_type", + "in": "body", + "description": "The field's data type.
", + "isRequired": true, + "enum": [ + "iteration" + ] + }, + { + "type": "array of objects", + "name": "single_select_options", + "in": "body", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The display name of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "The color associated with the option.
", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + { + "type": "string", + "name": "description", + "description": "The description of the option.
" + } + ] + }, + { + "type": "object", + "name": "iteration_configuration", + "in": "body", + "description": "The configuration for iteration fields.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "start_date", + "description": "The start date of the first iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The default duration for iterations in days. Individual iterations can override this value.
" + }, + { + "type": "array of objects", + "name": "iterations", + "description": "Zero or more iterations for the field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "title", + "description": "The title of the iteration.
" + }, + { + "type": "string", + "name": "start_date", + "description": "The start date of the iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The duration of the iteration in days.
" + } + ] + } + ] + } + ], + "descriptionHTML": "Add a field to a specified user owned project.
", + "codeExamples": [ + { + "key": "text_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a text field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team notes", + "data_type": "text" + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "number_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a number field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Story points", + "data_type": "number" + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "date_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a date field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Due date", + "data_type": "date" + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "single_select_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a single select field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "iteration_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create an iteration field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -478390,21 +482418,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -524524,1184 +528570,6 @@ } ] }, - "projects-classic": { - "collaborators": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100). For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant the collaborator.
", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "permission": "admin", - "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 - } - }, - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "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": [ - "permission", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ], - "columns": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "Name of the project column
", - "isRequired": true - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ] - }, "pulls": { "pulls": [ { @@ -545589,6 +548457,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -545621,6 +548490,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -625435,7 +628305,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -626437,7 +629307,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -627285,7 +630155,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -627923,7 +630793,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -628368,7 +631238,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -629048,7 +631918,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -629828,7 +632698,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -630466,7 +633336,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -631293,7 +634163,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -631931,7 +634801,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -632381,7 +635251,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -633061,7 +635931,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -633842,7 +636712,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -634480,7 +637350,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -639200,6 +642070,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -639480,6 +642351,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -645372,6 +648244,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
An optional comment when closing or reopening an alert. Cannot be updated or deleted.
" + }, + { + "type": "string or null", + "name": "assignee", + "in": "body", + "description": "The username of the user to assign to the alert. Set to null to unassign the alert.
Updates the status of a secret scanning alert in an eligible repository.
\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
Updates the status of a secret scanning alert in an eligible repository.
\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.
\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
State does not match the resolution or resolution comment
" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository
" }, { "httpStatusCode": "503", @@ -680407,897 +683351,6 @@ ] } }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "title": "List team projects", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Check team permissions for a project", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Add or update team project permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Remove a project from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ], - "previews": [] - }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -686522,877 +688575,6 @@ ] } }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/teams/{team_id}/projects", - "title": "List team projects (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Check team permissions for a project (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Add or update team project permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Remove a project from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, { "serverUrl": "https://api.github.com", "verb": "get", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 7d6988091e99..f9dd2abef7b7 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -967,6 +967,320 @@ } ], "cache": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/cache/retention-limit", + "title": "Get GitHub Actions cache retention limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
", + "example": { + "max_cache_retention_days": 80 + }, + "schema": { + "title": "Actions cache retention limit for an enterprise", + "description": "GitHub Actions cache retention policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/cache/retention-limit", + "title": "Set GitHub Actions cache retention limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_retention_days", + "in": "body", + "description": "For repositories & organizations in an enterprise, the maximum duration, in days, for which caches in a repository may be retained.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache retention limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/cache/storage-limit", + "title": "Get GitHub Actions cache storage limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
", + "example": { + "max_cache_size_gb": 150 + }, + "schema": { + "title": "Actions cache storage limit for an enterprise", + "description": "GitHub Actions cache storage policy for an enterprise.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/cache/storage-limit", + "title": "Set GitHub Actions cache storage limit for an enterprise", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_size_gb", + "in": "body", + "description": "For repositories & organizations in an enterprise, the maximum size limit for the sum of all caches in a repository, in gigabytes.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache storage limit for an enterprise. All organizations and repositories under this\nenterprise may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:enterprise scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Enterprise administration\" enterprise permissions": "write" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -1044,6 +1358,320 @@ "disabledForPatV2": true } }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/cache/retention-limit", + "title": "Get GitHub Actions cache retention limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
", + "example": { + "max_cache_retention_days": 80 + }, + "schema": { + "title": "Actions cache retention limit for an organization", + "description": "GitHub Actions cache retention policy for an organization.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.", + "type": "integer", + "examples": [ + 14 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/cache/retention-limit", + "title": "Set GitHub Actions cache retention limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_retention_days", + "in": "body", + "description": "For repositories in this organization, the maximum duration, in days, for which caches in a repository may be retained.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache retention limit for an organization. All repositories under this\norganization may not set a higher cache retention limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/organizations/{org}/actions/cache/storage-limit", + "title": "Get GitHub Actions cache storage limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Gets GitHub Actions cache storage limit for an organization. All repositories under this\norganization may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
", + "example": { + "max_cache_size_gb": 150 + }, + "schema": { + "title": "Actions cache storage limit for an organization", + "description": "GitHub Actions cache storage policy for an organization.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/organizations/{org}/actions/cache/storage-limit", + "title": "Set GitHub Actions cache storage limit for an organization", + "category": "actions", + "subcategory": "cache", + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "integer", + "name": "max_cache_size_gb", + "in": "body", + "description": "For repositories in the organization, the maximum size limit for the sum of all caches in a repository, in gigabytes.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache storage limit for an organization. All organizations and repositories under this\norganization may not set a higher cache storage limit.
\nOAuth tokens and personal access tokens (classic) need the admin:organization scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" organization permissions": "write" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -1256,6 +1884,360 @@ ] } }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit", + "title": "Get GitHub Actions cache retention limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
Gets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
", + "example": { + "max_cache_retention_days": 80 + }, + "schema": { + "title": "Actions cache retention limit for a repository", + "description": "GitHub Actions cache retention policy for a repository.", + "type": "object", + "properties": { + "max_cache_retention_days": { + "description": "The maximum number of days to keep caches in this repository.", + "type": "integer", + "examples": [ + 14 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/cache/retention-limit", + "title": "Set GitHub Actions cache retention limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
The maximum number of days to keep caches in this repository.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache retention limit for a repository. This determines how long caches will be retained for, if\nnot manually removed or evicted due to size constraints.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit", + "title": "Get GitHub Actions cache storage limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
Gets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
", + "example": { + "max_cache_size_gb": 150 + }, + "schema": { + "title": "Actions cache storage limit for a repository", + "description": "GitHub Actions cache storage policy for a repository.", + "type": "object", + "properties": { + "max_cache_size_gb": { + "description": "The maximum total cache size for this repository, in gigabytes.", + "type": "integer", + "examples": [ + 10 + ] + } + } + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "read" + } + ] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/cache/storage-limit", + "title": "Set GitHub Actions cache storage limit for a repository", + "category": "actions", + "subcategory": "cache", + "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.
The maximum total cache size for this repository, in gigabytes.
" + } + ], + "descriptionHTML": "Sets GitHub Actions cache storage limit for a repository. This determines the maximum size of caches that can be\nstored before eviction occurs.
\nOAuth tokens and personal access tokens (classic) need the admin:repository scope to use this endpoint.
Response
" + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "No Content
" + }, + { + "httpStatusCode": "400", + "description": "Bad Request
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Administration\" repository permissions": "write" + } + ] + } + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -105152,6 +106134,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -106297,6 +107287,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -107125,6 +108123,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -107795,6 +108802,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -109443,6 +110458,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -110308,6 +111332,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -111955,6 +112987,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -113105,6 +114145,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -114253,6 +115301,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -116672,6 +117728,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -122065,6 +123129,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -123148,6 +124220,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -124916,6 +125996,47 @@ "schema": { "type": "string" } + }, + { + "name": "page", + "description": "The page number of the results to fetch. For more information, see \"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.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page_size", + "description": "The number of results per page (max 10).
", + "in": "query", + "schema": { + "type": "integer", + "default": 10 + } + }, + { + "name": "scope", + "description": "Filter budgets by scope type.
", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "enterprise", + "organization", + "repository", + "cost-center" + ] + } } ], "bodyParameters": [], @@ -125079,6 +126200,10 @@ ] }, "description": "Array of budget objects for the enterprise" + }, + "has_next_page": { + "type": "boolean", + "description": "Indicates if there are more pages of results available (maps to hasNextPage from billing platform)" } }, "required": [ @@ -125681,7 +126806,22 @@ "description": "Budget updated successfully
", "example": { "message": "Budget successfully updated.", - "budget_id": "2c1feb79-3947-4dc8-a16e-80cbd732cc0b" + "budget": { + "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", + "budget_type": "ProductPricing", + "budget_product_sku": "actions_linux", + "budget_scope": "repository", + "budget_entity_name": "org-name/example-repo-name", + "budget_amount": 0, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": true, + "alert_recipients": [ + "mona", + "lisa" + ] + } + } }, "schema": { "type": "object", @@ -130560,6 +131700,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -130592,6 +131733,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -133992,6 +135134,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -134024,6 +135167,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -137529,6 +138673,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -137561,6 +138706,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -183200,7 +184346,6 @@ "name": "state", "in": "body", "description": "Sets the state of the code scanning alert. You must provide dismissed_reason when you set the state to dismissed.
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -308818,6 +309997,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -309551,7 +310766,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -310189,7 +311404,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -310987,7 +312202,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -311625,7 +312840,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -312557,7 +313772,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -313233,6 +314448,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -313967,7 +315218,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -314605,7 +315856,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -381665,8 +382916,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -467473,6 +468723,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -493389,7 +494647,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -494027,7 +495285,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -494552,7 +495810,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -495228,6 +496486,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -495996,7 +497290,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -496634,7 +497928,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -497452,7 +498746,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -498090,7 +499384,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -498620,7 +499914,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -499296,6 +500590,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -500065,7 +501395,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -500703,7 +502033,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -526287,9 +527617,9 @@ }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", - "title": "Get project field for organization", + "verb": "post", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields", + "title": "Add a field to an organization-owned project.", "category": "projects", "subcategory": "fields", "parameters": [ @@ -526302,15 +527632,6 @@ "type": "integer" } }, - { - "name": "field_id", - "description": "The unique identifier of the field.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, { "name": "org", "description": "The organization name. The name is not case sensitive.
", @@ -526321,52 +527642,1473 @@ } } ], - "bodyParameters": [], - "descriptionHTML": "Get a specific field for an organization-owned project.
", + "bodyParameters": [ + { + "type": "integer", + "name": "issue_field_id", + "in": "body", + "description": "The ID of the IssueField to create the field for.
", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the field.
", + "isRequired": true + }, + { + "type": "string", + "name": "data_type", + "in": "body", + "description": "The field's data type.
", + "isRequired": true, + "enum": [ + "iteration" + ] + }, + { + "type": "array of objects", + "name": "single_select_options", + "in": "body", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The display name of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "The color associated with the option.
", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + { + "type": "string", + "name": "description", + "description": "The description of the option.
" + } + ] + }, + { + "type": "object", + "name": "iteration_configuration", + "in": "body", + "description": "The configuration for iteration fields.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "start_date", + "description": "The start date of the first iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The default duration for iterations in days. Individual iterations can override this value.
" + }, + { + "type": "array of objects", + "name": "iterations", + "description": "Zero or more iterations for the field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "title", + "description": "The title of the iteration.
" + }, + { + "type": "string", + "name": "start_date", + "description": "The start date of the iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The duration of the iteration in days.
" + } + ] + } + ] + } + ], + "descriptionHTML": "Add a field to an organization-owned project.
", "codeExamples": [ { - "key": "default", + "key": "text_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a text field", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team notes", + "data_type": "text" + }, "parameters": { "project_number": "PROJECT_NUMBER", - "field_id": "FIELD_ID", "org": "ORG" } - }, + } + }, + { + "key": "number_field", "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", - "description": "Response
", + "description": "Response for adding a field to an organization-owned project.
", "example": { - "id": 12345, - "node_id": "PVTF_lADOABCD1234567890", - "name": "Priority", - "data_type": "single_select", + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", "project_url": "https://api.github.com/projects/67890", - "options": [ - { - "id": "option_1", - "name": "Low", - "color": "GREEN", - "description": "Low priority items" - }, - { - "id": "option_2", - "name": "Medium", - "color": "YELLOW", - "description": "Medium priority items" - }, - { - "id": "option_3", - "name": "High", - "color": "RED", - "description": "High priority items" - } - ], - "created_at": "2022-04-28T12:00:00Z", - "updated_at": "2022-04-28T12:00:00Z" + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a number field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Story points", + "data_type": "number" + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "date_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a date field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Due date", + "data_type": "date" + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "single_select_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a single select field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + }, + { + "key": "iteration_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response for adding a field to an organization-owned project.
", + "example": { + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ + { + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create an iteration field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + }, + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Response for adding a field to an organization-owned project.
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": true, + "serverToServer": true, + "fineGrainedPat": true, + "permissions": [ + { + "\"Projects\" organization permissions": "write" + } + ], + "allowsPublicRead": true + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for organization", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Get a specific field for an organization-owned project.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" }, "schema": { "title": "Projects v2 Field", @@ -527047,56 +529789,796 @@ }, { "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/users/{username}/projectsV2/{project_number}/fields/{field_id}", - "title": "Get project field for user", + "verb": "post", + "requestPath": "/users/{username}/projectsV2/{project_number}/fields", + "title": "Add field to user owned project", "category": "projects", "subcategory": "fields", "parameters": [ { - "name": "project_number", - "description": "The project's number.
", + "name": "username", + "description": "The handle for the GitHub user account.
", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "field_id", - "description": "The unique identifier of the field.
", + "name": "project_number", + "description": "The project's number.
", "in": "path", "required": true, "schema": { "type": "integer" } + } + ], + "bodyParameters": [ + { + "type": "string", + "name": "name", + "in": "body", + "description": "The name of the field.
", + "isRequired": true }, { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + "type": "string", + "name": "data_type", + "in": "body", + "description": "The field's data type.
", + "isRequired": true, + "enum": [ + "iteration" + ] + }, + { + "type": "array of objects", + "name": "single_select_options", + "in": "body", + "description": "The options available for single select fields. At least one option must be provided when creating a single select field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "name", + "description": "The display name of the option.
" + }, + { + "type": "string", + "name": "color", + "description": "The color associated with the option.
", + "enum": [ + "BLUE", + "GRAY", + "GREEN", + "ORANGE", + "PINK", + "PURPLE", + "RED", + "YELLOW" + ] + }, + { + "type": "string", + "name": "description", + "description": "The description of the option.
" + } + ] + }, + { + "type": "object", + "name": "iteration_configuration", + "in": "body", + "description": "The configuration for iteration fields.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "start_date", + "description": "The start date of the first iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The default duration for iterations in days. Individual iterations can override this value.
" + }, + { + "type": "array of objects", + "name": "iterations", + "description": "Zero or more iterations for the field.
", + "childParamsGroups": [ + { + "type": "string", + "name": "title", + "description": "The title of the iteration.
" + }, + { + "type": "string", + "name": "start_date", + "description": "The start date of the iteration.
" + }, + { + "type": "integer", + "name": "duration", + "description": "The duration of the iteration in days.
" + } + ] + } + ] } ], - "bodyParameters": [], - "descriptionHTML": "Get a specific field for a user-owned project.
", + "descriptionHTML": "Add a field to a specified user owned project.
", "codeExamples": [ { - "key": "default", + "key": "text_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 24680, + "node_id": "PVTF_lADOABCD2468024680", + "name": "Team notes", + "data_type": "text", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-05-15T08:00:00Z", + "updated_at": "2022-05-15T08:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a text field", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Team notes", + "data_type": "text" + }, "parameters": { - "project_number": "PROJECT_NUMBER", - "field_id": "FIELD_ID", - "username": "USERNAME" + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "number_field", + "response": { + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 13579, + "node_id": "PVTF_lADOABCD1357913579", + "name": "Story points", + "data_type": "number", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-01T14:30:00Z", + "updated_at": "2022-06-01T14:30:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] } }, + "request": { + "contentType": "application/json", + "description": "Create a number field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Story points", + "data_type": "number" + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "date_field", "response": { - "statusCode": "200", + "statusCode": "201", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 98765, + "node_id": "PVTF_lADOABCD9876598765", + "name": "Due date", + "data_type": "date", + "project_url": "https://api.github.com/projects/67890", + "created_at": "2022-06-10T09:15:00Z", + "updated_at": "2022-06-10T09:15:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create a date field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Due date", + "data_type": "date" + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + }, + { + "key": "single_select_field", + "response": { + "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { @@ -527108,21 +530590,39 @@ "options": [ { "id": "option_1", - "name": "Low", + "name": { + "html": "Low", + "raw": "Low" + }, "color": "GREEN", - "description": "Low priority items" + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } }, { "id": "option_2", - "name": "Medium", + "name": { + "html": "Medium", + "raw": "Medium" + }, "color": "YELLOW", - "description": "Medium priority items" + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } }, { "id": "option_3", - "name": "High", + "name": { + "html": "High", + "raw": "High" + }, "color": "RED", - "description": "High priority items" + "description": { + "html": "High priority items", + "raw": "High priority items" + } } ], "created_at": "2022-04-28T12:00:00Z", @@ -527320,245 +530820,887 @@ "project_url" ] } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ], - "items": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", - "title": "List items for an organization owned project", - "category": "projects", - "subcategory": "items", - "parameters": [ - { - "name": "project_number", - "description": "The project's number.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "q", - "description": "Search query to filter items, see Filtering projects for more information.
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "fields", - "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "after", - "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "List all items for a specific organization-owned project accessible by the authenticated user.
", - "codeExamples": [ - { - "key": "default", + }, "request": { - "description": "Example", + "contentType": "application/json", + "description": "Create a single select field", "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Priority", + "data_type": "single_select", + "single_select_options": [ + { + "name": { + "raw": "Low", + "html": "Low" + }, + "color": "GREEN", + "description": { + "raw": "Low priority items", + "html": "Low priority items" + } + }, + { + "name": { + "raw": "Medium", + "html": "Medium" + }, + "color": "YELLOW", + "description": { + "raw": "Medium priority items", + "html": "Medium priority items" + } + }, + { + "name": { + "raw": "High", + "html": "High" + }, + "color": "RED", + "description": { + "raw": "High priority items", + "html": "High priority items" + } + } + ] + }, "parameters": { - "project_number": "PROJECT_NUMBER", - "org": "ORG" + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" } - }, + } + }, + { + "key": "iteration_field", "response": { - "statusCode": "200", + "statusCode": "201", "contentType": "application/json", "description": "Response
", "example": { - "id": 13, - "node_id": "PVTI_lAAFAQ0", - "project_url": "https://api.github.com/orgs/github/projectsV2/1", - "content": { - "url": "https://api.github.com/repos/github/Hello-World/pulls/6", - "id": 10, - "node_id": "PR_kwABCg", - "html_url": "https://github.com/github/Hello-World/pull/6", - "diff_url": "https://github.com/github/Hello-World/pull/6.diff", - "patch_url": "https://github.com/github/Hello-World/pull/6.patch", - "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", - "number": 6, - "state": "open", - "locked": false, - "title": "Issue title", - "user": { - "login": "monalisa", - "id": 161, - "node_id": "U_kgDMoQ", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false - }, - "body": "Issue body", - "created_at": "2025-08-01T18:44:50Z", - "updated_at": "2025-08-06T19:25:18Z", - "closed_at": null, - "merged_at": null, - "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", - "assignee": { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - }, - "assignees": [ + "id": 11223, + "node_id": "PVTF_lADOABCD1122311223", + "name": "Sprint", + "data_type": "iteration", + "project_url": "https://api.github.com/projects/67890", + "configuration": { + "duration": 14, + "start_day": 1, + "iterations": [ { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - } - ], - "requested_reviewers": [ + "id": "iter_1", + "title": { + "html": "Sprint 1", + "raw": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false + "id": "iter_2", + "title": { + "html": "Sprint 2", + "raw": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + }, + "created_at": "2022-06-20T16:45:00Z", + "updated_at": "2022-06-20T16:45:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + }, + "request": { + "contentType": "application/json", + "description": "Create an iteration field", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "name": "Sprint", + "data_type": "iteration", + "iteration_configuration": { + "start_day": 1, + "duration": 14, + "iterations": [ + { + "title": { + "raw": "Sprint 1", + "html": "Sprint 1" + }, + "start_date": "2022-07-01", + "duration": 14 + }, + { + "title": { + "raw": "Sprint 2", + "html": "Sprint 2" + }, + "start_date": "2022-07-15", + "duration": 14 + } + ] + } + }, + "parameters": { + "username": "USERNAME", + "project_number": "PROJECT_NUMBER" + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "201", + "description": "Created
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + }, + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/users/{username}/projectsV2/{project_number}/fields/{field_id}", + "title": "Get project field for user", + "category": "projects", + "subcategory": "fields", + "parameters": [ + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "field_id", + "description": "The unique identifier of the field.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [], + "descriptionHTML": "Get a specific field for a user-owned project.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "field_id": "FIELD_ID", + "username": "USERNAME" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 12345, + "node_id": "PVTF_lADOABCD1234567890", + "name": "Priority", + "data_type": "single_select", + "project_url": "https://api.github.com/projects/67890", + "options": [ + { + "id": "option_1", + "name": { + "html": "Low", + "raw": "Low" + }, + "color": "GREEN", + "description": { + "html": "Low priority items", + "raw": "Low priority items" + } + }, + { + "id": "option_2", + "name": { + "html": "Medium", + "raw": "Medium" + }, + "color": "YELLOW", + "description": { + "html": "Medium priority items", + "raw": "Medium priority items" + } + }, + { + "id": "option_3", + "name": { + "html": "High", + "raw": "High" + }, + "color": "RED", + "description": { + "html": "High priority items", + "raw": "High priority items" + } + } + ], + "created_at": "2022-04-28T12:00:00Z", + "updated_at": "2022-04-28T12:00:00Z" + }, + "schema": { + "title": "Projects v2 Field", + "description": "A field inside a projects v2 project", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the field." + }, + "node_id": { + "type": "string", + "description": "The node ID of the field." + }, + "project_url": { + "type": "string", + "description": "The API URL of the project that contains the field.", + "examples": [ + "https://api.github.com/projects/1" + ] + }, + "name": { + "type": "string", + "description": "The name of the field." + }, + "data_type": { + "type": "string", + "description": "The field's data type.", + "enum": [ + "assignees", + "linked_pull_requests", + "reviewers", + "labels", + "milestone", + "repository", + "title", + "text", + "single_select", + "number", + "date", + "iteration", + "issue_type", + "parent_issue", + "sub_issues_progress" + ] + }, + "options": { + "type": "array", + "description": "The options available for single select fields.", + "items": { + "title": "Projects v2 Single Select Option", + "description": "An option for a single select field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the option." + }, + "name": { + "type": "object", + "description": "The display name of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "description": { + "type": "object", + "description": "The description of the option, in raw text and HTML formats.", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ] + }, + "color": { + "type": "string", + "description": "The color associated with the option." + } + }, + "required": [ + "id", + "name", + "description", + "color" + ] + } + }, + "configuration": { + "type": "object", + "description": "Configuration for iteration fields.", + "properties": { + "start_day": { + "type": "integer", + "description": "The day of the week when the iteration starts." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "iterations": { + "type": "array", + "items": { + "title": "Projects v2 Iteration Setting", + "description": "An iteration setting for an iteration field", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The unique identifier of the iteration setting." + }, + "start_date": { + "type": "string", + "format": "date", + "description": "The start date of the iteration." + }, + "duration": { + "type": "integer", + "description": "The duration of the iteration in days." + }, + "title": { + "type": "object", + "properties": { + "raw": { + "type": "string" + }, + "html": { + "type": "string" + } + }, + "required": [ + "raw", + "html" + ], + "description": "The iteration title, in raw text and HTML formats." + }, + "completed": { + "type": "boolean", + "description": "Whether the iteration has been completed." + } + }, + "required": [ + "id", + "start_date", + "duration", + "title", + "completed" + ] + } + } + } + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was created.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "description": "The time when the field was last updated.", + "examples": [ + "2022-04-28T12:00:00Z" + ] + } + }, + "required": [ + "id", + "name", + "data_type", + "created_at", + "updated_at", + "project_url" + ] + } + } + } + ], + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "OK
" + }, + { + "httpStatusCode": "304", + "description": "Not modified
" + }, + { + "httpStatusCode": "401", + "description": "Requires authentication
" + }, + { + "httpStatusCode": "403", + "description": "Forbidden
" + } + ], + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } + } + ], + "items": [ + { + "serverUrl": "https://api.github.com", + "verb": "get", + "requestPath": "/orgs/{org}/projectsV2/{project_number}/items", + "title": "List items for an organization owned project", + "category": "projects", + "subcategory": "items", + "parameters": [ + { + "name": "project_number", + "description": "The project's number.
", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "q", + "description": "Search query to filter items, see Filtering projects for more information.
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "fields", + "description": "Limit results to specific fields, by their IDs. If not specified, the title field will be returned.
\nExample: fields[]=123&fields[]=456&fields[]=789 or fields=123,456,789
A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see \"Using pagination in the REST API.\"
", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see \"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.\"
", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + } + ], + "bodyParameters": [], + "descriptionHTML": "List all items for a specific organization-owned project accessible by the authenticated user.
", + "codeExamples": [ + { + "key": "default", + "request": { + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "parameters": { + "project_number": "PROJECT_NUMBER", + "org": "ORG" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "Response
", + "example": { + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false } ], "requested_teams": [], @@ -571513,4358 +575655,604 @@ "visibility": "public", "forks": 0, "open_issues": 3, - "watchers": 0, - "default_branch": "main" - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/6" - }, - "html": { - "href": "https://github.com/github/Hello-World/pull/6" - }, - "issue": { - "href": "https://api.github.com/repos/github/Hello-World/issues/6" - }, - "comments": { - "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" - } - }, - "author_association": "MEMBER", - "auto_merge": null, - "active_lock_reason": null - }, - "content_type": "PullRequest", - "creator": { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false - }, - "created_at": "2025-08-01T18:44:51Z", - "updated_at": "2025-08-06T19:25:18Z", - "archived_at": null, - "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", - "fields": [ - { - "id": 1, - "name": "Title", - "type": "title", - "value": { - "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "number": 6, - "url": "https://github.com/5/1/pull/6", - "issue_id": 12, - "state": "open", - "state_reason": null, - "is_draft": false - } - }, - { - "id": 2, - "name": "Assignees", - "type": "assignees", - "value": [ - { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - } - ] - }, - { - "id": 3, - "name": "Status", - "type": "single_select", - "value": { - "id": "98236657", - "name": { - "raw": "Done", - "html": "Done" - }, - "color": "PURPLE", - "description": { - "raw": "This has been completed", - "html": "This has been completed" - } - } - }, - { - "id": 4, - "name": "Labels", - "type": "labels", - "value": [ - { - "id": 19, - "node_id": "LA_kwABEw", - "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", - "name": "bug :bug:", - "color": "efe24f", - "default": false, - "description": "Something isn't working" - }, - { - "id": 26, - "node_id": "LA_kwABGg", - "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", - "name": "fun size 🍫", - "color": "f29c24", - "default": false, - "description": "Extra attention is needed" - }, - { - "id": 33, - "node_id": "LA_kwABIQ", - "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", - "name": "🚒 wontfix", - "color": "5891ce", - "default": false, - "description": "This will not be worked on" - } - ] - }, - { - "id": 5, - "name": "Linked pull requests", - "type": "linked_pull_requests", - "value": [] - }, - { - "id": 6, - "name": "Milestone", - "type": "milestone", - "value": { - "url": "https://api.github.com/repos/github/Hello-World/milestones/1", - "html_url": "https://github.com/github/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", - "id": 1, - "node_id": "MI_kwABAQ", - "number": 1, - "title": "Open milestone", - "description": null, - "creator": { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - }, - "open_issues": 2, - "closed_issues": 1, - "state": "open", - "created_at": "2025-08-01T18:44:30Z", - "updated_at": "2025-08-06T19:14:15Z", - "due_on": null, - "closed_at": null - } - }, - { - "id": 7, - "name": "Repository", - "type": "repository", - "value": { - "id": 1, - "node_id": "R_kgAB", - "name": "Hello-World", - "full_name": "github/Hello-World", - "private": false, - "owner": { - "login": "github", - "id": 5, - "node_id": "O_kgAF", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "user_view_type": "public", - "site_admin": false - }, - "html_url": "https://github.com/github/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/github/Hello-World", - "forks_url": "https://api.github.com/repos/github/Hello-World/forks", - "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/github/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/github/Hello-World/events", - "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/github/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/github/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/github/Hello-World/merges", - "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" - } - }, - { - "id": 8, - "name": "Type", - "type": "issue_type", - "value": null - }, - { - "id": 9, - "name": "Reviewers", - "type": "reviewers", - "value": [ - { - "type": "ReviewRequest", - "status": "pending", - "reviewer": { - "avatarUrl": "https://github.com/images/error/octocat_happy.gif", - "id": 2, - "login": "monalisa", - "url": "https://github.com/monalisa", - "name": "monalisa", - "type": "User" - } - } - ] - }, - { - "id": 10, - "name": "Parent issue", - "type": "parent_issue", - "value": null - }, - { - "id": 11, - "name": "Sub-issues progress", - "type": "sub_issues_progress", - "value": null - } - ] - }, - "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." - }, - "project_url": { - "type": "string", - "format": "uri", - "description": "The API URL of the project that contains this item.", - "examples": [ - "https://api.github.com/users/monalisa/2/projectsV2/3" - ] - }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - "content": { - "type": [ - "object", - "null" - ], - "additionalProperties": true, - "description": "The content of the item, which varies by content type." - }, - "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" - ] - }, - "item_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The API URL of this item.", - "examples": [ - "https://api.github.com/users/monalisa/2/projectsV2/items/3" - ] - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - }, - "description": "The fields and values associated with this item." - } - }, - "required": [ - "id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - } - } - }, - { - "key": "iteration_field", - "request": { - "contentType": "application/json", - "description": "Update an iteration field", - "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "fields": [ - { - "id": 1011, - "value": "866ee5b8" - } - ] - }, - "parameters": { - "project_number": "PROJECT_NUMBER", - "username": "USERNAME", - "item_id": "ITEM_ID" - } - }, - "response": { - "statusCode": "200", - "contentType": "application/json", - "description": "Response
", - "example": { - "id": 13, - "node_id": "PVTI_lAAFAQ0", - "project_url": "https://api.github.com/orgs/github/projectsV2/1", - "content": { - "url": "https://api.github.com/repos/github/Hello-World/pulls/6", - "id": 10, - "node_id": "PR_kwABCg", - "html_url": "https://github.com/github/Hello-World/pull/6", - "diff_url": "https://github.com/github/Hello-World/pull/6.diff", - "patch_url": "https://github.com/github/Hello-World/pull/6.patch", - "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", - "number": 6, - "state": "open", - "locked": false, - "title": "Issue title", - "user": { - "login": "monalisa", - "id": 161, - "node_id": "U_kgDMoQ", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false - }, - "body": "Issue body", - "created_at": "2025-08-01T18:44:50Z", - "updated_at": "2025-08-06T19:25:18Z", - "closed_at": null, - "merged_at": null, - "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", - "assignee": { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - }, - "assignees": [ - { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - } - ], - "requested_reviewers": [ - { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false - } - ], - "requested_teams": [], - "labels": [ - { - "id": 19, - "node_id": "LA_kwABEw", - "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", - "name": "bug :bug:", - "color": "efe24f", - "default": false, - "description": "Something isn't working" - }, - { - "id": 26, - "node_id": "LA_kwABGg", - "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", - "name": "fun size 🍫", - "color": "f29c24", - "default": false, - "description": "Extra attention is needed" - }, - { - "id": 33, - "node_id": "LA_kwABIQ", - "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", - "name": "🚒 wontfix", - "color": "5891ce", - "default": false, - "description": "This will not be worked on" - } - ], - "milestone": { - "url": "https://api.github.com/repos/github/Hello-World/milestones/1", - "html_url": "https://github.com/github/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", - "id": 1, - "node_id": "MI_kwABAQ", - "number": 1, - "title": "Open milestone", - "description": null, - "creator": { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false - }, - "open_issues": 2, - "closed_issues": 1, - "state": "open", - "created_at": "2025-08-01T18:44:30Z", - "updated_at": "2025-08-06T19:14:15Z", - "due_on": null, - "closed_at": null - }, - "draft": false, - "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", - "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", - "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", - "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", - "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", - "head": { - "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", - "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", - "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", - "user": { - "login": "github", - "id": 5, - "node_id": "O_kgAF", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "user_view_type": "public", - "site_admin": false - }, - "repo": { - "id": 1, - "node_id": "R_kgAB", - "name": "Hello-World", - "full_name": "github/Hello-World", - "private": false, - "owner": { - "login": "github", - "id": 5, - "node_id": "O_kgAF", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "user_view_type": "public", - "site_admin": false - }, - "html_url": "https://github.com/github/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/github/Hello-World", - "forks_url": "https://api.github.com/repos/github/Hello-World/forks", - "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/github/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/github/Hello-World/events", - "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/github/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/github/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/github/Hello-World/merges", - "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", - "created_at": "2025-08-01T18:44:14Z", - "updated_at": "2025-08-01T18:48:38Z", - "pushed_at": "2025-08-01T18:44:50Z", - "git_url": "git://github.localhost/github/Hello-World.git", - "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", - "clone_url": "https://github.com/github/Hello-World.git", - "svn_url": "https://github.com/github/Hello-World", - "homepage": null, - "size": 6, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "has_discussions": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 3, - "license": null, - "allow_forking": true, - "is_template": false, - "web_commit_signoff_required": false, - "topics": [], - "visibility": "public", - "forks": 0, - "open_issues": 3, - "watchers": 0, - "default_branch": "main" - } - }, - "base": { - "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", - "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", - "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", - "user": { - "login": "github", - "id": 5, - "node_id": "O_kgAF", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "user_view_type": "public", - "site_admin": false - }, - "repo": { - "id": 1, - "node_id": "R_kgAB", - "name": "Hello-World", - "full_name": "github/Hello-World", - "private": false, - "owner": { - "login": "github", - "id": 5, - "node_id": "O_kgAF", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "user_view_type": "public", - "site_admin": false - }, - "html_url": "https://github.com/github/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/github/Hello-World", - "forks_url": "https://api.github.com/repos/github/Hello-World/forks", - "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/github/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/github/Hello-World/events", - "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/github/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/github/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/github/Hello-World/merges", - "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", - "created_at": "2025-08-01T18:44:14Z", - "updated_at": "2025-08-01T18:48:38Z", - "pushed_at": "2025-08-01T18:44:50Z", - "git_url": "git://github.localhost/github/Hello-World.git", - "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", - "clone_url": "https://github.com/github/Hello-World.git", - "svn_url": "https://github.com/github/Hello-World", - "homepage": null, - "size": 6, - "stargazers_count": 0, - "watchers_count": 0, - "language": null, - "has_issues": true, - "has_projects": true, - "has_downloads": true, - "has_wiki": true, - "has_pages": false, - "has_discussions": false, - "forks_count": 0, - "mirror_url": null, - "archived": false, - "disabled": false, - "open_issues_count": 3, - "license": null, - "allow_forking": true, - "is_template": false, - "web_commit_signoff_required": false, - "topics": [], - "visibility": "public", - "forks": 0, - "open_issues": 3, - "watchers": 0, - "default_branch": "main" - } - }, - "_links": { - "self": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/6" - }, - "html": { - "href": "https://github.com/github/Hello-World/pull/6" - }, - "issue": { - "href": "https://api.github.com/repos/github/Hello-World/issues/6" - }, - "comments": { - "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" - }, - "review_comments": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" - }, - "review_comment": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" - }, - "commits": { - "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" - }, - "statuses": { - "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" - } - }, - "author_association": "MEMBER", - "auto_merge": null, - "active_lock_reason": null - }, - "content_type": "PullRequest", - "creator": { - "login": "monalisa", - "id": 2, - "node_id": "U_kgAC", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/monalisa", - "html_url": "https://github.com/monalisa", - "followers_url": "https://api.github.com/users/monalisa/followers", - "following_url": "https://api.github.com/users/monalisa/following{/other_user}", - "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", - "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", - "organizations_url": "https://api.github.com/users/monalisa/orgs", - "repos_url": "https://api.github.com/users/monalisa/repos", - "events_url": "https://api.github.com/users/monalisa/events{/privacy}", - "received_events_url": "https://api.github.com/users/monalisa/received_events", - "type": "User", - "user_view_type": "public", - "site_admin": false - }, - "created_at": "2025-08-01T18:44:51Z", - "updated_at": "2025-08-06T19:25:18Z", - "archived_at": null, - "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", - "fields": [ - { - "id": 1, - "name": "Title", - "type": "title", - "value": { - "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", - "number": 6, - "url": "https://github.com/5/1/pull/6", - "issue_id": 12, - "state": "open", - "state_reason": null, - "is_draft": false - } - }, - { - "id": 2, - "name": "Assignees", - "type": "assignees", - "value": [ - { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - } - ] - }, - { - "id": 3, - "name": "Status", - "type": "single_select", - "value": { - "id": "98236657", - "name": { - "raw": "Done", - "html": "Done" - }, - "color": "PURPLE", - "description": { - "raw": "This has been completed", - "html": "This has been completed" - } - } - }, - { - "id": 4, - "name": "Labels", - "type": "labels", - "value": [ - { - "id": 19, - "node_id": "LA_kwABEw", - "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", - "name": "bug :bug:", - "color": "efe24f", - "default": false, - "description": "Something isn't working" - }, - { - "id": 26, - "node_id": "LA_kwABGg", - "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", - "name": "fun size 🍫", - "color": "f29c24", - "default": false, - "description": "Extra attention is needed" - }, - { - "id": 33, - "node_id": "LA_kwABIQ", - "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", - "name": "🚒 wontfix", - "color": "5891ce", - "default": false, - "description": "This will not be worked on" - } - ] - }, - { - "id": 5, - "name": "Linked pull requests", - "type": "linked_pull_requests", - "value": [] - }, - { - "id": 6, - "name": "Milestone", - "type": "milestone", - "value": { - "url": "https://api.github.com/repos/github/Hello-World/milestones/1", - "html_url": "https://github.com/github/Hello-World/milestone/1", - "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", - "id": 1, - "node_id": "MI_kwABAQ", - "number": 1, - "title": "Open milestone", - "description": null, - "creator": { - "login": "octocat", - "id": 175, - "node_id": "U_kgDMrw", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/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 - }, - "open_issues": 2, - "closed_issues": 1, - "state": "open", - "created_at": "2025-08-01T18:44:30Z", - "updated_at": "2025-08-06T19:14:15Z", - "due_on": null, - "closed_at": null - } - }, - { - "id": 7, - "name": "Repository", - "type": "repository", - "value": { - "id": 1, - "node_id": "R_kgAB", - "name": "Hello-World", - "full_name": "github/Hello-World", - "private": false, - "owner": { - "login": "github", - "id": 5, - "node_id": "O_kgAF", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/users/github/repos", - "events_url": "https://api.github.com/users/github/events{/privacy}", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "user_view_type": "public", - "site_admin": false - }, - "html_url": "https://github.com/github/Hello-World", - "description": null, - "fork": false, - "url": "https://api.github.com/repos/github/Hello-World", - "forks_url": "https://api.github.com/repos/github/Hello-World/forks", - "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", - "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", - "teams_url": "https://api.github.com/repos/github/Hello-World/teams", - "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", - "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", - "events_url": "https://api.github.com/repos/github/Hello-World/events", - "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", - "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", - "tags_url": "https://api.github.com/repos/github/Hello-World/tags", - "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", - "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", - "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", - "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", - "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", - "languages_url": "https://api.github.com/repos/github/Hello-World/languages", - "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", - "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", - "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", - "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", - "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", - "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", - "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", - "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", - "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", - "merges_url": "https://api.github.com/repos/github/Hello-World/merges", - "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", - "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", - "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", - "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", - "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", - "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", - "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", - "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" - } - }, - { - "id": 8, - "name": "Type", - "type": "issue_type", - "value": null - }, - { - "id": 9, - "name": "Reviewers", - "type": "reviewers", - "value": [ - { - "type": "ReviewRequest", - "status": "pending", - "reviewer": { - "avatarUrl": "https://github.com/images/error/octocat_happy.gif", - "id": 2, - "login": "monalisa", - "url": "https://github.com/monalisa", - "name": "monalisa", - "type": "User" - } - } - ] - }, - { - "id": 10, - "name": "Parent issue", - "type": "parent_issue", - "value": null - }, - { - "id": 11, - "name": "Sub-issues progress", - "type": "sub_issues_progress", - "value": null - } - ] - }, - "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." - }, - "project_url": { - "type": "string", - "format": "uri", - "description": "The API URL of the project that contains this item.", - "examples": [ - "https://api.github.com/users/monalisa/2/projectsV2/3" - ] - }, - "content_type": { - "title": "Projects v2 Item Content Type", - "description": "The type of content tracked in a project item", - "type": "string", - "enum": [ - "Issue", - "PullRequest", - "DraftIssue" - ] - }, - "content": { - "type": [ - "object", - "null" - ], - "additionalProperties": true, - "description": "The content of the item, which varies by content type." - }, - "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" - ] - }, - "item_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "description": "The API URL of this item.", - "examples": [ - "https://api.github.com/users/monalisa/2/projectsV2/items/3" - ] - }, - "fields": { - "type": "array", - "items": { - "type": "object", - "additionalProperties": true - }, - "description": "The fields and values associated with this item." - } - }, - "required": [ - "id", - "content_type", - "created_at", - "updated_at", - "archived_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/users/{username}/projectsV2/{project_number}/items/{item_id}", - "title": "Delete project item for user", - "category": "projects", - "subcategory": "items", - "parameters": [ - { - "name": "project_number", - "description": "The project's number.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "item_id", - "description": "The unique identifier of the project item.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Delete a specific item from a user-owned project.
", - "codeExamples": [ - { - "key": "default", - "request": { - "description": "Example", - "acceptHeader": "application/vnd.github.v3+json", - "parameters": { - "project_number": "PROJECT_NUMBER", - "username": "USERNAME", - "item_id": "ITEM_ID" - } - }, - "response": { - "statusCode": "204", - "description": "Response
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": false, - "serverToServer": false, - "fineGrainedPat": false, - "permissions": [] - } - } - ] - }, - "projects-classic": { - "cards": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Get a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:21:06Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:20:22Z" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Update an existing project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "note", - "in": "body", - "description": "The project card's note
" - }, - { - "type": "boolean", - "name": "archived", - "in": "body", - "description": "Whether or not the card is archived
" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:21:06Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:20:22Z" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", - "title": "Delete a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", - "title": "Move a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "card_id", - "description": "The unique identifier of the card.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "The position of the card in a column. Can be one of: top, bottom, or after:<card_id> to place after the specified card.
The unique identifier of the column the card should be moved to
" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - }, - { - "httpStatusCode": "503", - "description": "Service Unavailable
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "List project cards", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state.
", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - ], - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:21:06Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:20:22Z" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", - "title": "Create a project card", - "category": "projects-classic", - "subcategory": "cards", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string or null", - "name": "note", - "in": "body", - "description": "The project card's note
", - "isRequired": true - }, - { - "type": "integer", - "name": "content_id", - "in": "body", - "description": "The unique identifier of the content associated with the card
", - "isRequired": true - }, - { - "type": "string", - "name": "content_type", - "in": "body", - "description": "The piece of content associated with the card
", - "isRequired": true - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "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": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - }, - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/cards/1478" - ] - }, - "id": { - "description": "The project card's ID", - "type": "integer", - "format": "int64", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDExOlByb2plY3RDYXJkMTQ3OA==" - ] - }, - "note": { - "type": [ - "string", - "null" - ], - "examples": [ - "Add payload for delete Project column" - ] - }, - "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" - ] - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:21:06Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:20:22Z" - ] - }, - "archived": { - "description": "Whether or not the card is archived", - "type": "boolean", - "examples": [ - false - ] - }, - "column_name": { - "type": "string" - }, - "project_id": { - "type": "string" - }, - "column_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "content_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test/issues/3" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed
" - }, - { - "httpStatusCode": "503", - "description": "Service Unavailable
" - } - ], - "previews": [] - } - ], - "collaborators": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100). For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant the collaborator.
", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/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/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", "type": "User", + "user_view_type": "public", "site_admin": false - } - }, - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } }, - "user": { - "anyOf": [ + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ { - "type": "null" + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": { + "raw": "Done", + "html": "Done" }, + "color": "PURPLE", + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } } ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null } - }, - "required": [ - "permission", - "user" ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ], - "columns": [ - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + }, + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", "type": "object", "properties": { - "url": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] + "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", + "description": "The API URL of the project that contains this item.", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, - "cards_url": { + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" ] }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "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" ] }, - "node_id": { + "created_at": { "type": "string", + "format": "date-time", + "description": "The time when the item was created.", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "2022-04-28T12:00:00Z" ] }, - "name": { - "description": "Name of the project column", + "updated_at": { "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", "examples": [ - "Remaining tasks" + "2022-04-28T12:00:00Z" ] }, - "created_at": { - "type": "string", + "archived_at": { + "type": [ + "string", + "null" + ], "format": "date-time", + "description": "The time when the item was archived.", "examples": [ - "2016-09-05T14:18:44Z" + "2022-04-28T12:00:00Z" ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", "examples": [ - "2016-09-05T14:22:28Z" + "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." } }, "required": [ "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", + "content_type", "created_at", - "updated_at" + "updated_at", + "archived_at" ] } } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" }, { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "Name of the project column
", - "isRequired": true - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "id": 13, + "node_id": "PVTI_lAAFAQ0", + "project_url": "https://api.github.com/orgs/github/projectsV2/1", + "content": { + "url": "https://api.github.com/repos/github/Hello-World/pulls/6", + "id": 10, + "node_id": "PR_kwABCg", + "html_url": "https://github.com/github/Hello-World/pull/6", + "diff_url": "https://github.com/github/Hello-World/pull/6.diff", + "patch_url": "https://github.com/github/Hello-World/pull/6.patch", + "issue_url": "https://api.github.com/repos/github/Hello-World/issues/6", + "number": 6, + "state": "open", + "locked": false, + "title": "Issue title", + "user": { + "login": "monalisa", + "id": 161, + "node_id": "U_kgDMoQ", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "body": "Issue body", + "created_at": "2025-08-01T18:44:50Z", + "updated_at": "2025-08-06T19:25:18Z", + "closed_at": null, + "merged_at": null, + "merge_commit_sha": "98e25bad5878e54d22e5338cbc905dd2deedfa34", + "assignee": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + }, + "assignees": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + } + ], + "requested_reviewers": [ + { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + } + ], + "requested_teams": [], + "labels": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ], + "milestone": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + }, + "draft": false, + "commits_url": "https://api.github.com/repos/github/Hello-World/pulls/6/commits", + "review_comments_url": "https://api.github.com/repos/github/Hello-World/pulls/6/comments", + "review_comment_url": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}", + "comments_url": "https://api.github.com/repos/github/Hello-World/issues/6/comments", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "head": { + "label": "github:branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "ref": "branch-2ee3da8fde8a1adfe6d0809a1a414e4f", + "sha": "a3258d3434ecb2058b2784c8eb8610c2e9937a0d", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "base": { + "label": "github:branch-0f4ceb14cbe39e4786ffbabb776da599", + "ref": "branch-0f4ceb14cbe39e4786ffbabb776da599", + "sha": "9a9f5a8d77bdc2540412900d3c930fe36a82b5ed", + "user": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "repo": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments", + "created_at": "2025-08-01T18:44:14Z", + "updated_at": "2025-08-01T18:48:38Z", + "pushed_at": "2025-08-01T18:44:50Z", + "git_url": "git://github.localhost/github/Hello-World.git", + "ssh_url": "ssh://git@localhost:3035/github/Hello-World.git", + "clone_url": "https://github.com/github/Hello-World.git", + "svn_url": "https://github.com/github/Hello-World", + "homepage": null, + "size": 6, + "stargazers_count": 0, + "watchers_count": 0, + "language": null, + "has_issues": true, + "has_projects": true, + "has_downloads": true, + "has_wiki": true, + "has_pages": false, + "has_discussions": false, + "forks_count": 0, + "mirror_url": null, + "archived": false, + "disabled": false, + "open_issues_count": 3, + "license": null, + "allow_forking": true, + "is_template": false, + "web_commit_signoff_required": false, + "topics": [], + "visibility": "public", + "forks": 0, + "open_issues": 3, + "watchers": 0, + "default_branch": "main" + } + }, + "_links": { + "self": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6" + }, + "html": { + "href": "https://github.com/github/Hello-World/pull/6" + }, + "issue": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6" + }, + "comments": { + "href": "https://api.github.com/repos/github/Hello-World/issues/6/comments" + }, + "review_comments": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/comments" + }, + "review_comment": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/comments{/number}" + }, + "commits": { + "href": "https://api.github.com/repos/github/Hello-World/pulls/6/commits" + }, + "statuses": { + "href": "https://api.github.com/repos/github/Hello-World/statuses/a3258d3434ecb2058b2784c8eb8610c2e9937a0d" + } + }, + "author_association": "MEMBER", + "auto_merge": null, + "active_lock_reason": null + }, + "content_type": "PullRequest", + "creator": { + "login": "monalisa", + "id": 2, + "node_id": "U_kgAC", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/monalisa", + "html_url": "https://github.com/monalisa", + "followers_url": "https://api.github.com/users/monalisa/followers", + "following_url": "https://api.github.com/users/monalisa/following{/other_user}", + "gists_url": "https://api.github.com/users/monalisa/gists{/gist_id}", + "starred_url": "https://api.github.com/users/monalisa/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/monalisa/subscriptions", + "organizations_url": "https://api.github.com/users/monalisa/orgs", + "repos_url": "https://api.github.com/users/monalisa/repos", + "events_url": "https://api.github.com/users/monalisa/events{/privacy}", + "received_events_url": "https://api.github.com/users/monalisa/received_events", + "type": "User", + "user_view_type": "public", + "site_admin": false + }, + "created_at": "2025-08-01T18:44:51Z", + "updated_at": "2025-08-06T19:25:18Z", + "archived_at": null, + "item_url": "https://api.github.com/orgs/github/projectsV2/1/items/13", + "fields": [ + { + "id": 1, + "name": "Title", + "type": "title", + "value": { + "raw": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "html": "It seemed to me that any civilization that had so far lost its head as to need to include a set of detailed instructions for use in a packet of toothpicks, was no longer a civilization in which I could live and stay sane.", + "number": 6, + "url": "https://github.com/5/1/pull/6", + "issue_id": 12, + "state": "open", + "state_reason": null, + "is_draft": false + } + }, + { + "id": 2, + "name": "Assignees", + "type": "assignees", + "value": [ + { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + } + ] + }, + { + "id": 3, + "name": "Status", + "type": "single_select", + "value": { + "id": "98236657", + "name": { + "raw": "Done", + "html": "Done" + }, + "color": "PURPLE", + "description": { + "raw": "This has been completed", + "html": "This has been completed" + } + } + }, + { + "id": 4, + "name": "Labels", + "type": "labels", + "value": [ + { + "id": 19, + "node_id": "LA_kwABEw", + "url": "https://api.github.com/repos/github/Hello-World/labels/bug%20:bug:", + "name": "bug :bug:", + "color": "efe24f", + "default": false, + "description": "Something isn't working" + }, + { + "id": 26, + "node_id": "LA_kwABGg", + "url": "https://api.github.com/repos/github/Hello-World/labels/fun%20size%20%F0%9F%8D%AB", + "name": "fun size 🍫", + "color": "f29c24", + "default": false, + "description": "Extra attention is needed" + }, + { + "id": 33, + "node_id": "LA_kwABIQ", + "url": "https://api.github.com/repos/github/Hello-World/labels/%F0%9F%9A%92%20wontfix", + "name": "🚒 wontfix", + "color": "5891ce", + "default": false, + "description": "This will not be worked on" + } + ] + }, + { + "id": 5, + "name": "Linked pull requests", + "type": "linked_pull_requests", + "value": [] + }, + { + "id": 6, + "name": "Milestone", + "type": "milestone", + "value": { + "url": "https://api.github.com/repos/github/Hello-World/milestones/1", + "html_url": "https://github.com/github/Hello-World/milestone/1", + "labels_url": "https://api.github.com/repos/github/Hello-World/milestones/1/labels", + "id": 1, + "node_id": "MI_kwABAQ", + "number": 1, + "title": "Open milestone", + "description": null, + "creator": { + "login": "octocat", + "id": 175, + "node_id": "U_kgDMrw", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/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 + }, + "open_issues": 2, + "closed_issues": 1, + "state": "open", + "created_at": "2025-08-01T18:44:30Z", + "updated_at": "2025-08-06T19:14:15Z", + "due_on": null, + "closed_at": null + } + }, + { + "id": 7, + "name": "Repository", + "type": "repository", + "value": { + "id": 1, + "node_id": "R_kgAB", + "name": "Hello-World", + "full_name": "github/Hello-World", + "private": false, + "owner": { + "login": "github", + "id": 5, + "node_id": "O_kgAF", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "user_view_type": "public", + "site_admin": false + }, + "html_url": "https://github.com/github/Hello-World", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/github/Hello-World", + "forks_url": "https://api.github.com/repos/github/Hello-World/forks", + "keys_url": "https://api.github.com/repos/github/Hello-World/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/github/Hello-World/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/github/Hello-World/teams", + "hooks_url": "https://api.github.com/repos/github/Hello-World/hooks", + "issue_events_url": "https://api.github.com/repos/github/Hello-World/issues/events{/number}", + "events_url": "https://api.github.com/repos/github/Hello-World/events", + "assignees_url": "https://api.github.com/repos/github/Hello-World/assignees{/user}", + "branches_url": "https://api.github.com/repos/github/Hello-World/branches{/branch}", + "tags_url": "https://api.github.com/repos/github/Hello-World/tags", + "blobs_url": "https://api.github.com/repos/github/Hello-World/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/github/Hello-World/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/github/Hello-World/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/github/Hello-World/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/github/Hello-World/statuses/{sha}", + "languages_url": "https://api.github.com/repos/github/Hello-World/languages", + "stargazers_url": "https://api.github.com/repos/github/Hello-World/stargazers", + "contributors_url": "https://api.github.com/repos/github/Hello-World/contributors", + "subscribers_url": "https://api.github.com/repos/github/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/github/Hello-World/subscription", + "commits_url": "https://api.github.com/repos/github/Hello-World/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/github/Hello-World/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/github/Hello-World/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/github/Hello-World/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/github/Hello-World/contents/{+path}", + "compare_url": "https://api.github.com/repos/github/Hello-World/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/github/Hello-World/merges", + "archive_url": "https://api.github.com/repos/github/Hello-World/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/github/Hello-World/downloads", + "issues_url": "https://api.github.com/repos/github/Hello-World/issues{/number}", + "pulls_url": "https://api.github.com/repos/github/Hello-World/pulls{/number}", + "milestones_url": "https://api.github.com/repos/github/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/github/Hello-World/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/github/Hello-World/labels{/name}", + "releases_url": "https://api.github.com/repos/github/Hello-World/releases{/id}", + "deployments_url": "https://api.github.com/repos/github/Hello-World/deployments" + } + }, + { + "id": 8, + "name": "Type", + "type": "issue_type", + "value": null + }, + { + "id": 9, + "name": "Reviewers", + "type": "reviewers", + "value": [ + { + "type": "ReviewRequest", + "status": "pending", + "reviewer": { + "avatarUrl": "https://github.com/images/error/octocat_happy.gif", + "id": 2, + "login": "monalisa", + "url": "https://github.com/monalisa", + "name": "monalisa", + "type": "User" + } + } + ] + }, + { + "id": 10, + "name": "Parent issue", + "type": "parent_issue", + "value": null + }, + { + "id": 11, + "name": "Sub-issues progress", + "type": "sub_issues_progress", + "value": null + } + ] + }, + "schema": { + "title": "Projects v2 Item", + "description": "An item belonging to a project", "type": "object", "properties": { - "url": { + "id": { + "type": "number", + "description": "The unique identifier of the project item." + }, + "node_id": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] + "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", + "description": "The API URL of the project that contains this item.", "examples": [ - "https://api.github.com/projects/120" + "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, - "cards_url": { + "content_type": { + "title": "Projects v2 Item Content Type", + "description": "The type of content tracked in a project item", "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" + "enum": [ + "Issue", + "PullRequest", + "DraftIssue" ] }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 + "content": { + "type": [ + "object", + "null" + ], + "additionalProperties": true, + "description": "The content of the item, which varies by content type." + }, + "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" ] }, - "node_id": { + "created_at": { "type": "string", + "format": "date-time", + "description": "The time when the item was created.", "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "2022-04-28T12:00:00Z" ] }, - "name": { - "description": "Name of the project column", + "updated_at": { "type": "string", + "format": "date-time", + "description": "The time when the item was last updated.", "examples": [ - "Remaining tasks" + "2022-04-28T12:00:00Z" ] }, - "created_at": { - "type": "string", + "archived_at": { + "type": [ + "string", + "null" + ], "format": "date-time", + "description": "The time when the item was archived.", "examples": [ - "2016-09-05T14:18:44Z" + "2022-04-28T12:00:00Z" ] }, - "updated_at": { - "type": "string", - "format": "date-time", + "item_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The API URL of this item.", "examples": [ - "2016-09-05T14:22:28Z" + "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] + }, + "fields": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": true + }, + "description": "The fields and values associated with this item." } }, "required": [ "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", + "content_type", "created_at", - "updated_at" + "updated_at", + "archived_at" ] } } @@ -575961,10 +577279,6 @@ "httpStatusCode": "200", "description": "OK
" }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, { "httpStatusCode": "401", "description": "Requires authentication
" @@ -575972,77 +577286,53 @@ { "httpStatusCode": "403", "description": "Forbidden
" + }, + { + "httpStatusCode": "404", + "description": "Resource not found
" + }, + { + "httpStatusCode": "422", + "description": "Validation failed, or the endpoint has been spammed.
" } ], - "previews": [] + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } }, { "serverUrl": "https://api.github.com", "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects-classic", - "subcategory": "columns", + "requestPath": "/users/{username}/projectsV2/{project_number}/items/{item_id}", + "title": "Delete project item for user", + "category": "projects", + "subcategory": "items", "parameters": [ { - "name": "column_id", - "description": "The unique identifier of the column.
", + "name": "project_number", + "description": "The project's number.
", "in": "path", "required": true, "schema": { "type": "integer" } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" }, { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" + "name": "username", + "description": "The handle for the GitHub user account.
", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", + "name": "item_id", + "description": "The unique identifier of the project item.
", "in": "path", "required": true, "schema": { @@ -576050,51 +577340,30 @@ } } ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nDelete a specific item from a user-owned project.
", "codeExamples": [ { "key": "default", "request": { - "contentType": "application/json", - "description": "Move the column to the end of the board", + "description": "Example", "acceptHeader": "application/vnd.github.v3+json", - "bodyParameters": { - "position": "last" - }, "parameters": { - "column_id": "COLUMN_ID" + "project_number": "PROJECT_NUMBER", + "username": "USERNAME", + "item_id": "ITEM_ID" } }, "response": { - "statusCode": "201", - "contentType": "application/json", - "description": "Response
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } + "statusCode": "204", + "description": "Response
" } } ], "statusCodes": [ { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" + "httpStatusCode": "204", + "description": "No Content
" }, { "httpStatusCode": "401", @@ -576103,13 +577372,15 @@ { "httpStatusCode": "403", "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" } ], - "previews": [] + "previews": [], + "progAccess": { + "userToServerRest": false, + "serverToServer": false, + "fineGrainedPat": false, + "permissions": [] + } } ] }, @@ -596000,6 +597271,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -596032,6 +597304,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -676909,7 +678182,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -677911,7 +679184,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -678760,7 +680033,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -679398,7 +680671,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -679844,7 +681117,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -680524,7 +681797,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -681305,7 +682578,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -681943,7 +683216,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -682771,7 +684044,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -683409,7 +684682,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -683860,7 +685133,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -684540,7 +685813,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -685322,7 +686595,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -685960,7 +687233,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -693245,6 +694518,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -693525,6 +694799,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -699429,6 +700704,29 @@ "type": "string" } }, + { + "name": "assignee", + "in": "query", + "description": "Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
Filters alerts by assignee. Use * to get all assigned alerts, none to get all unassigned alerts, or a GitHub username to get alerts assigned to a specific user.
The property to sort the results by. created means when the alert was created. updated means when the alert was updated or resolved.
An optional comment when closing or reopening an alert. Cannot be updated or deleted.
" + }, + { + "type": "string or null", + "name": "assignee", + "in": "body", + "description": "The username of the user to assign to the alert. Set to null to unassign the alert.
Updates the status of a secret scanning alert in an eligible repository.
\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
Updates the status of a secret scanning alert in an eligible repository.
\nYou can also use this endpoint to assign or unassign an alert to a user who has write access to the repository.
\nThe authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
\nOAuth app tokens and personal access tokens (classic) need the repo or security_events scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the public_repo scope instead.
State does not match the resolution or resolution comment
" + "description": "State does not match the resolution or resolution comment, or assignee does not have write access to the repository
" }, { "httpStatusCode": "503", @@ -740190,897 +741560,6 @@ ] } }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects", - "title": "List team projects", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Check team permissions for a project", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Add or update team project permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Remove a project from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ], - "previews": [] - }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -746317,877 +746796,6 @@ ] } }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/teams/{team_id}/projects", - "title": "List team projects (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "get", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Check team permissions for a project (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "put", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Add or update team project permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "https://api.github.com", - "verb": "delete", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Remove a project from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, { "serverUrl": "https://api.github.com", "verb": "get", diff --git a/src/rest/data/ghes-3.14-2022-11-28/schema.json b/src/rest/data/ghes-3.14-2022-11-28/schema.json index 1d08670b082b..5dc818a10efe 100644 --- a/src/rest/data/ghes-3.14-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.14-2022-11-28/schema.json @@ -94093,6 +94093,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -95205,6 +95213,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -96000,6 +96016,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -96633,6 +96658,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -98248,6 +98281,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -99076,6 +99118,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -100684,6 +100734,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -101801,6 +101859,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -102916,6 +102982,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105302,6 +105376,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -107792,6 +107874,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -108842,6 +108932,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -113391,6 +113489,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -113423,6 +113522,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -116801,6 +116901,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -116833,6 +116934,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -120316,6 +120418,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -120348,6 +120451,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -169558,6 +169662,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -169590,6 +169695,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -175392,6 +175498,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -175424,6 +175531,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -176517,6 +176625,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -176549,6 +176658,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -177230,6 +177340,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -177262,6 +177373,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -177975,6 +178087,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -178007,6 +178120,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -221664,6 +221778,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -223112,6 +223234,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -224085,6 +224215,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -281906,8 +282044,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -332136,6 +332273,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -333190,6 +333335,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -334259,6 +334412,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -335235,6 +335396,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -336308,6 +336477,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -337285,6 +337462,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -338296,6 +338481,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -339358,6 +339551,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -342698,6 +342899,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -358428,7 +358637,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -359432,7 +359641,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -360664,7 +360873,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -361875,7 +362084,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -362884,7 +363093,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -364107,7 +364316,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -384826,7 +385035,7 @@ } ], "bodyParameters": [], - "descriptionHTML": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nAdds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nRemoves a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nReturns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nGets information about a project column.
", + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nUpdate an existing project column
", + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nDeletes a project column.
", + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nMove a project column
", + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nRequest Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -491506,7 +491717,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -492727,7 +492938,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -493581,7 +493792,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -494785,7 +494996,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -499601,6 +499812,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -499874,6 +500086,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -509885,7 +510098,6 @@ "name": "state", "in": "body", "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
Lists the organization projects for a team.
\nNote
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Note
\n\nYou can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Note
\n\nYou can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.
Note
\n\nYou can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new List team projects endpoint.
Lists the organization projects for a team.
", + "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Check team permissions for a project endpoint.
\nChecks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nWarning
\n\nEndpoint closing down notice: This endpoint route is closing down and will be removed from the Teams API. We recommend migrating your existing code to use the new Add or update team project permissions endpoint.
\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nThe level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -96982,6 +97007,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -98605,6 +98638,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -99442,6 +99484,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -101064,6 +101114,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -102189,6 +102247,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103312,6 +103378,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105706,6 +105780,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -108204,6 +108286,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -109262,6 +109352,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -113831,6 +113929,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -113863,6 +113962,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117253,6 +117353,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117285,6 +117386,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -120780,6 +120882,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -120812,6 +120915,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -173721,6 +173825,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -173753,6 +173858,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -179555,6 +179661,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -179587,6 +179694,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -180680,6 +180788,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -180712,6 +180821,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -181393,6 +181503,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -181425,6 +181536,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -182138,6 +182250,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -182170,6 +182283,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -224561,6 +224675,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -226017,6 +226139,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -226998,6 +227128,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -284923,8 +285061,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -335393,6 +335530,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -336455,6 +336600,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -337532,6 +337685,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -338516,6 +338677,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -339597,6 +339766,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -340582,6 +340759,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -341601,6 +341786,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -342671,6 +342864,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -346019,6 +346220,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -361891,7 +362100,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -362407,7 +362616,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -362924,7 +363133,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -364233,7 +364442,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -364749,7 +364958,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -365550,7 +365759,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -366066,7 +366275,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -366588,7 +366797,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -367888,7 +368097,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -368404,7 +368613,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -413472,6 +413681,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -413504,6 +413714,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -492152,7 +492363,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -492928,7 +493139,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -493760,7 +493971,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -494276,7 +494487,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -494715,7 +494926,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -495267,7 +495478,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -496031,7 +496242,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -496547,7 +496758,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -497358,7 +497569,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -497874,7 +498085,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -498318,7 +498529,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -498870,7 +499081,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -499635,7 +499846,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -500151,7 +500362,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -504492,6 +504703,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -504765,6 +504977,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -514794,7 +515007,6 @@ "name": "state", "in": "body", "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -97007,6 +97032,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -98638,6 +98671,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -99484,6 +99526,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -101114,6 +101164,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -102247,6 +102305,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103378,6 +103444,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105780,6 +105854,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -108286,6 +108368,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -109352,6 +109442,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -113929,6 +114027,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -113961,6 +114060,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117351,6 +117451,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117383,6 +117484,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -120878,6 +120980,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -120910,6 +121013,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -177371,6 +177475,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -177403,6 +177508,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -183205,6 +183311,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -183237,6 +183344,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -184330,6 +184438,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -184362,6 +184471,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185043,6 +185153,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185075,6 +185186,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185788,6 +185900,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185820,6 +185933,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -229697,6 +229811,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -231161,6 +231283,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -232150,6 +232280,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -290083,8 +290221,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -340553,6 +340690,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -341623,6 +341768,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -342708,6 +342861,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -343700,6 +343861,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -344789,6 +344958,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -345782,6 +345959,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -346809,6 +346994,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -347887,6 +348080,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -351265,6 +351466,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -367149,7 +367358,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -367665,7 +367874,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -368183,7 +368392,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -369493,7 +369702,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -370009,7 +370218,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -370811,7 +371020,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -371327,7 +371536,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -371850,7 +372059,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -373151,7 +373360,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -373667,7 +373876,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -419391,6 +419600,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -419423,6 +419633,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -498074,7 +498285,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -498850,7 +499061,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -499683,7 +499894,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -500199,7 +500410,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -500639,7 +500850,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -501191,7 +501402,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -501956,7 +502167,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -502472,7 +502683,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -503284,7 +503495,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -503800,7 +504011,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -504245,7 +504456,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -504797,7 +505008,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -505563,7 +505774,7 @@ "properties": { "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -506079,7 +506290,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -510420,6 +510631,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -510693,6 +510905,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -521611,7 +521824,6 @@ "name": "state", "in": "body", "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -97199,6 +97224,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -98830,6 +98863,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -99676,6 +99718,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -101306,6 +101356,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -102439,6 +102497,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103570,6 +103636,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -105972,6 +106046,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -108478,6 +108560,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -109544,6 +109634,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -114137,6 +114235,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -114169,6 +114268,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117569,6 +117669,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117601,6 +117702,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -121106,6 +121208,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -121138,6 +121241,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -178075,6 +178179,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -178107,6 +178212,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -183919,6 +184025,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -183951,6 +184058,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185058,6 +185166,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185090,6 +185199,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185778,6 +185888,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185810,6 +185921,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -186530,6 +186642,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -186562,6 +186675,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -230499,6 +230613,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -231963,6 +232085,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -232952,6 +233082,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -290990,8 +291128,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -341491,6 +341628,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -342561,6 +342706,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -343646,6 +343799,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -344638,6 +344799,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -345727,6 +345896,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -346720,6 +346897,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -347747,6 +347932,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -348825,6 +349018,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -352203,6 +352404,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -368568,7 +368777,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -369206,7 +369415,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -369729,7 +369938,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -370405,6 +370614,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -371179,7 +371424,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -371817,7 +372062,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -372631,7 +372876,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -373269,7 +373514,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -373797,7 +374042,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -374473,6 +374718,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -375238,7 +375519,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -375876,7 +376157,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -395233,1184 +395514,6 @@ } ] }, - "projects-classic": { - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100). For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant the collaborator.
", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "permission": "admin", - "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 - } - }, - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "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": [ - "permission", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "Name of the project column
", - "isRequired": true - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ] - }, "pulls": { "pulls": [ { @@ -416298,6 +415401,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -416330,6 +415434,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -495954,7 +495059,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -496956,7 +496061,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -497801,7 +496906,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -498439,7 +497544,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -498884,7 +497989,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -499564,7 +498669,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -500341,7 +499446,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -500979,7 +500084,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -501803,7 +500908,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -502441,7 +501546,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -502891,7 +501996,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -503571,7 +502676,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -504349,7 +503454,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -504987,7 +504092,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -509340,6 +508445,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -509620,6 +508726,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -520578,7 +519685,6 @@ "name": "state", "in": "body", "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Check team permissions for a project", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Add or update team project permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Remove a project from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ], - "previews": [] - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -535346,877 +533561,6 @@ ] } }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects", - "title": "List team projects (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Check team permissions for a project (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Add or update team project permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Remove a project from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", diff --git a/src/rest/data/ghes-3.18-2022-11-28/schema.json b/src/rest/data/ghes-3.18-2022-11-28/schema.json index 320a99de65c0..a83740722327 100644 --- a/src/rest/data/ghes-3.18-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.18-2022-11-28/schema.json @@ -94689,6 +94689,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -95817,6 +95825,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -96628,6 +96644,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -97279,6 +97304,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -98910,6 +98943,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.
", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -99756,6 +99798,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -101386,6 +101436,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -102519,6 +102577,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -103650,6 +103716,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -106052,6 +106126,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -108558,6 +108640,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -109624,6 +109714,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -114217,6 +114315,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -114249,6 +114348,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117649,6 +117749,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117681,6 +117782,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -121186,6 +121288,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -121218,6 +121321,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -178219,6 +178323,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -178251,6 +178356,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -184063,6 +184169,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -184095,6 +184202,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185202,6 +185310,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185234,6 +185343,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185922,6 +186032,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -185954,6 +186065,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -186674,6 +186786,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -186706,6 +186819,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -232816,6 +232930,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -234280,6 +234402,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -235269,6 +235399,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -293307,8 +293445,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -343818,6 +343955,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -344888,6 +345033,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -345973,6 +346126,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -346965,6 +347126,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -348054,6 +348223,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -349047,6 +349224,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -350074,6 +350259,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -351152,6 +351345,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -354530,6 +354731,14 @@ "write" ] }, + "artifact_metadata": { + "type": "string", + "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", + "enum": [ + "read", + "write" + ] + }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", @@ -370905,7 +371114,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -371543,7 +371752,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -372066,7 +372275,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -372742,6 +372951,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -373516,7 +373761,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -374154,7 +374399,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -374968,7 +375213,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -375606,7 +375851,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -376134,7 +376379,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -376810,6 +377055,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -377575,7 +377856,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -378213,7 +378494,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -397979,1184 +398260,6 @@ } ] }, - "projects-classic": { - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100). For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant the collaborator.
", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "permission": "admin", - "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 - } - }, - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "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": [ - "permission", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "Name of the project column
", - "isRequired": true - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - } - ] - }, "pulls": { "pulls": [ { @@ -419044,6 +418147,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -419076,6 +418180,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -498725,7 +497830,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -499727,7 +498832,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -500572,7 +499677,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -501210,7 +500315,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -501655,7 +500760,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -502335,7 +501440,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -503112,7 +502217,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -503750,7 +502855,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -504574,7 +503679,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -505212,7 +504317,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -505662,7 +504767,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -506342,7 +505447,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -507120,7 +506225,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -507758,7 +506863,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -512116,6 +511221,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -512396,6 +511502,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -523256,7 +522363,6 @@ "name": "state", "in": "body", "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Check team permissions for a project", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Add or update team project permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Remove a project from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ], - "previews": [] - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -539351,877 +537566,6 @@ ] } }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects", - "title": "List team projects (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Check team permissions for a project (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Add or update team project permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Remove a project from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", diff --git a/src/rest/data/ghes-3.19-2022-11-28/schema.json b/src/rest/data/ghes-3.19-2022-11-28/schema.json index 73cb1798686c..671d2f98812b 100644 --- a/src/rest/data/ghes-3.19-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.19-2022-11-28/schema.json @@ -117836,6 +117836,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -117868,6 +117869,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -121268,6 +121270,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -121300,6 +121303,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -124805,6 +124809,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -124837,6 +124842,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -142162,209 +142168,13 @@ ], "bodyParameters": [ { - "type": "string", - "name": "name", - "in": "body", - "description": "The name of the check. For example, \"code-coverage\".
", - "isRequired": true - }, - { - "type": "string", - "name": "head_sha", - "in": "body", - "description": "The SHA of the commit.
", - "isRequired": true - }, - { - "type": "string", - "name": "details_url", - "in": "body", - "description": "The URL of the integrator's site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.
" - }, - { - "type": "string", - "name": "external_id", - "in": "body", - "description": "A reference for the run on the integrator's system.
" - }, - { - "type": "string", + "type": "", "name": "status", "in": "body", - "description": "The current status of the check run. Only GitHub Actions can set a status of waiting, pending, or requested.
The time that the check run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Required if you provide completed_at or a status of completed. The final conclusion of the check.\nNote: Providing conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.
The time the check completed. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run.
The title of the check run.
", - "isRequired": true - }, - { - "type": "string", - "name": "summary", - "description": "The summary of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "text", - "description": "The details of the check run. This parameter supports Markdown. Maximum length: 65535 characters.
" - }, - { - "type": "array of objects", - "name": "annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the Checks and Files changed tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the Update a check run endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about how you can view annotations on GitHub, see \"About status checks\".
", - "childParamsGroups": [ - { - "type": "string", - "name": "path", - "description": "The path of the file to add an annotation to. For example, assets/css/main.css.
The start line of the annotation. Line numbers start at 1.
", - "isRequired": true - }, - { - "type": "integer", - "name": "end_line", - "description": "The end line of the annotation.
", - "isRequired": true - }, - { - "type": "integer", - "name": "start_column", - "description": "The start column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values. Column numbers start at 1.
The end column of the annotation. Annotations only support start_column and end_column on the same line. Omit this parameter if start_line and end_line have different values.
The level of the annotation.
", - "isRequired": true, - "enum": [ - "notice", - "warning", - "failure" - ] - }, - { - "type": "string", - "name": "message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.
", - "isRequired": true - }, - { - "type": "string", - "name": "title", - "description": "The title that represents the annotation. The maximum size is 255 characters.
" - }, - { - "type": "string", - "name": "raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.
" - } - ] - }, - { - "type": "array of objects", - "name": "images", - "description": "Adds images to the output displayed in the GitHub pull request UI.
", - "childParamsGroups": [ - { - "type": "string", - "name": "alt", - "description": "The alternative text for the image.
", - "isRequired": true - }, - { - "type": "string", - "name": "image_url", - "description": "The full URL of the image.
", - "isRequired": true - }, - { - "type": "string", - "name": "caption", - "description": "A short image description.
" - } - ] - } - ] - }, - { - "type": "array of objects", - "name": "actions", - "in": "body", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the check_run.requested_action webhook to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. To learn more about check runs and requested actions, see \"Check runs and requested actions.\"
The text to be displayed on a button in the web UI. The maximum size is 20 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.
", - "isRequired": true - }, - { - "type": "string", - "name": "identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.
", - "isRequired": true - } + "completed" ] } ], @@ -183692,6 +183502,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -183724,6 +183535,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -189536,6 +189348,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -189568,6 +189381,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -190675,6 +190489,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -190707,6 +190522,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -191395,6 +191211,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -191427,6 +191244,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -192147,6 +191965,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -192179,6 +191998,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -303427,8 +303247,7 @@ "permissions": { "metadata": "read", "contents": "read", - "issues": "write", - "single_file": "write" + "issues": "write" }, "events": [ "push", @@ -393983,7 +393802,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -394621,7 +394440,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -395144,7 +394963,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -395820,6 +395639,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -396594,7 +396449,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -397232,7 +397087,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -398046,7 +397901,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -398684,7 +398539,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -399212,7 +399067,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -399888,6 +399743,42 @@ ] } ] + }, + { + "type": "object", + "name": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "copilot_code_review" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "boolean", + "name": "review_draft_pull_requests", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review.
" + }, + { + "type": "boolean", + "name": "review_on_push", + "description": "Copilot automatically reviews each new push to the pull request.
" + } + ] + } + ] } ], "oneOfObject": true @@ -400653,7 +400544,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -401291,7 +401182,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -473052,1289 +472943,6 @@ } ] }, - "projects-classic": { - "collaborators": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", - "title": "List project collaborators", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. outside means outside collaborators of a project that are not a member of the project's organization. direct means collaborators with permissions to a project, regardless of organization membership status. all means all collaborators the authenticated user can see.
The number of results per page (max 100). For more information, see \"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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "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" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Add project collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant the collaborator.
", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write" - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", - "title": "Remove user as a collaborator", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", - "title": "Get project permission for a user", - "category": "projects-classic", - "subcategory": "collaborators", - "parameters": [ - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "username", - "description": "The handle for the GitHub user account.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "permission": "admin", - "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 - } - }, - "schema": { - "title": "Project Collaborator Permission", - "description": "Project Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "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": [ - "permission", - "user" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "admin" - } - ] - } - } - ], - "columns": [ - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/projects/columns/{column_id}", - "title": "Get a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "read" - }, - { - "\"Projects\" organization permissions": "read" - } - ], - "allowsPublicRead": true - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", - "title": "Update an existing project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "name", - "in": "body", - "description": "Name of the project column
", - "isRequired": true - } - ], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - }, - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367" - ] - }, - "project_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/120" - ] - }, - "cards_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/columns/367/cards" - ] - }, - "id": { - "description": "The unique identifier of the project column", - "type": "integer", - "examples": [ - 42 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEzOlByb2plY3RDb2x1bW4zNjc=" - ] - }, - "name": { - "description": "Name of the project column", - "type": "string", - "examples": [ - "Remaining tasks" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:18:44Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2016-09-05T14:22:28Z" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", - "title": "Delete a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", - "title": "Move a project column", - "category": "projects-classic", - "subcategory": "columns", - "parameters": [ - { - "name": "column_id", - "description": "The unique identifier of the column.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "position", - "in": "body", - "description": "The position of the column in a project. Can be one of: first, last, or after:<column_id> to place after the specified column.
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": null, - "schema": { - "type": "object", - "properties": {}, - "additionalProperties": false - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "201", - "description": "Created
" - }, - { - "httpStatusCode": "304", - "description": "Not modified
" - }, - { - "httpStatusCode": "401", - "description": "Requires authentication
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Projects\" repository permissions": "write" - }, - { - "\"Projects\" organization permissions": "write" - } - ] - } - } - ] - }, "pulls": { "pulls": [ { @@ -494222,6 +492830,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -494254,6 +492863,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -573903,7 +572513,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -574905,7 +573515,7 @@ "allOf": [ { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -575750,7 +574360,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -576388,7 +574998,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -576833,7 +575443,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -577513,7 +576123,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -578290,7 +576900,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -578928,7 +577538,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -579752,7 +578362,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -580390,7 +579000,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -580840,7 +579450,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -581520,7 +580130,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -582298,7 +580908,7 @@ }, "automatic_copilot_code_review_enabled": { "type": "boolean", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review." + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit." }, "dismiss_stale_reviews_on_push": { "type": "boolean", @@ -582936,7 +581546,7 @@ }, { "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -587642,6 +586252,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -587922,6 +586533,7 @@ }, "date": { "type": "string", + "format": "date-time", "examples": [ "\"2007-10-29T02:42:39.000-07:00\"" ] @@ -600847,7 +599459,6 @@ "name": "state", "in": "body", "description": "Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Check team permissions for a project", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Add or update team project permissions", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read", - "\"Projects\" organization permissions": "admin" - } - ] - } - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "title": "Remove a project from a team", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the team name.
", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - } - ], - "previews": [], - "progAccess": { - "userToServerRest": true, - "serverToServer": true, - "fineGrainedPat": true, - "permissions": [ - { - "\"Members\" organization permissions": "read", - "\"Projects\" organization permissions": "admin" - } - ] - } - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", @@ -618768,877 +616446,6 @@ ] } }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects", - "title": "List team projects (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "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.\"
", - "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.\"
", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - } - ], - "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "get", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Check team permissions for a project (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
", - "example": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "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": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } - }, - "schema": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": [ - "string", - "null" - ] - }, - "number": { - "type": "integer" - }, - "state": { - "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" - ] - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "200", - "description": "OK
" - }, - { - "httpStatusCode": "404", - "description": "Not Found if project is not managed by this team
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "put", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Add or update team project permissions (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [ - { - "type": "string", - "name": "permission", - "in": "body", - "description": "The permission to grant to the team for this project. Default: the team's permission attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling this endpoint. For more information, see \"HTTP method.\"
Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "403", - "description": "Forbidden if the project is not owned by the organization
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, - { - "serverUrl": "http(s)://HOSTNAME/api/v3", - "verb": "delete", - "requestPath": "/teams/{team_id}/projects/{project_id}", - "title": "Remove a project from a team (Legacy)", - "category": "teams", - "subcategory": "teams", - "parameters": [ - { - "name": "team_id", - "description": "The unique identifier of the team.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "project_id", - "description": "The unique identifier of the project.
", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "bodyParameters": [], - "descriptionHTML": "Warning
\n\nClosing down notice: Projects (classic) is being deprecated in favor of the new Projects experience.\nSee the changelog for more information.
\nResponse
" - } - } - ], - "statusCodes": [ - { - "httpStatusCode": "204", - "description": "No Content
" - }, - { - "httpStatusCode": "404", - "description": "Resource not found
" - }, - { - "httpStatusCode": "422", - "description": "Validation failed, or the endpoint has been spammed.
" - } - ], - "previews": [] - }, { "serverUrl": "http(s)://HOSTNAME/api/v3", "verb": "get", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index bb77b7ad19e2..2374ba64b746 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -50,5 +50,5 @@ ] } }, - "sha": "dafe0f9ac291168cb41ccc752fbdde576ae44f63" + "sha": "5b1274f51ab314e4957866bd009106ea1aeedddf" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index a4fbedef34a0..c695f29bb21a 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -10798,6 +10798,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -10834,6 +10843,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -11731,6 +11748,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -11767,6 +11793,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -14775,7 +14809,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -14956,6 +14990,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -15152,446 +15191,456 @@ } ] }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "in": "body", - "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.
An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "Someone reopened a code scanning alert.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "The code scanning alert involved in the event.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", - "isRequired": true - }, - { - "type": "object or null", - "name": "most_recent_instance", + "name": "url", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "Identifies the configuration under which the analysis was executed.
" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.
", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "The code scanning alert number.
", "isRequired": true }, { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "A short description of the rule used to detect the alert.
", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "A unique identifier for the rule used to detect the alert.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "The severity of the alert.
", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "The version of the tool used to detect the alert.
", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, { - "type": "string", + "type": "string or null", + "name": "commit_oid", + "in": "body", + "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.
An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "Someone reopened a code scanning alert.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "string", + "name": "category", + "description": "Identifies the configuration under which the analysis was executed.
" + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "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.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + ] + }, + { + "type": "string or null", + "name": "state", + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", "name": "commit_oid", "in": "body", "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.
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -237483,7 +237532,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -237988,7 +238037,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -238668,7 +238717,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -239173,7 +239222,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -239853,7 +239902,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -240329,7 +240378,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -241009,7 +241058,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -241297,7 +241346,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -241977,7 +242026,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -242270,7 +242319,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -242950,7 +242999,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -243902,304 +243951,1876 @@ "name": "sender", "in": "body", "description": "A GitHub user.
", - "isRequired": true, + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "reopen", + "category": "repository_vulnerability_alert" + }, + "resolve": { + "descriptionHtml": "A repository vulnerability alert was marked as resolved.
", + "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "affected_package_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "affected_range", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "dismiss_reason", + "description": "" + }, + { + "type": "string", + "name": "dismissed_at", + "description": "" + }, + { + "type": "object or null", + "name": "dismisser", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "external_identifier", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "external_reference", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "fix_reason", + "description": "" + }, + { + "type": "string", + "name": "fixed_at", + "description": "" + }, + { + "type": "string", + "name": "fixed_in", + "description": "" + }, + { + "type": "string", + "name": "ghsa_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "fixed", + "open" + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "resolve", + "category": "repository_vulnerability_alert" + } + }, + "secret_scanning_alert": { + "assigned": { + "descriptionHtml": "A secret scanning alert was assigned.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_reviewer_comment", + "description": "An optional comment when reviewing a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_comment", + "description": "An optional comment when requesting a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_html_url", + "description": "The URL to a push protection bypass request.
" + }, + { + "type": "boolean or null", + "name": "publicly_leaked", + "description": "Whether the detected secret was publicly leaked.
" + }, + { + "type": "boolean or null", + "name": "multi_repo", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" + }, + { + "type": "object", + "name": "assigned_to", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "assignee", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "assigned", + "category": "secret_scanning_alert" + }, + "created": { + "descriptionHtml": "A secret scanning alert was created.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_reviewer_comment", + "description": "An optional comment when reviewing a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_comment", + "description": "An optional comment when requesting a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_html_url", + "description": "The URL to a push protection bypass request.
" + }, + { + "type": "boolean or null", + "name": "publicly_leaked", + "description": "Whether the detected secret was publicly leaked.
" + }, + { + "type": "boolean or null", + "name": "multi_repo", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" + }, + { + "type": "object", + "name": "assigned_to", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", - "organization" + "organization", + "app" ], - "action": "reopen", - "category": "repository_vulnerability_alert" + "action": "created", + "category": "secret_scanning_alert" }, - "resolve": { - "descriptionHtml": "A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "affected_package_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "affected_range", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "dismiss_reason", - "description": "" - }, - { - "type": "string", - "name": "dismissed_at", - "description": "" - }, - { - "type": "object or null", - "name": "dismisser", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "external_identifier", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "external_reference", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "fix_reason", - "description": "" - }, - { - "type": "string", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "fixed_in", - "description": "" - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "fixed", - "open" - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "resolve", - "category": "repository_vulnerability_alert" - } - }, - "secret_scanning_alert": { - "created": { - "descriptionHtml": "A secret scanning alert was created.
", + "publicly_leaked": { + "descriptionHtml": "A secret scanning alert was detected in a public repo.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -244209,7 +245830,7 @@ "description": "", "isRequired": true, "enum": [ - "created" + "publicly_leaked" ], "childParamsGroups": [] }, @@ -244913,11 +246534,11 @@ "organization", "app" ], - "action": "created", + "action": "publicly_leaked", "category": "secret_scanning_alert" }, - "publicly_leaked": { - "descriptionHtml": "A secret scanning alert was detected in a public repo.
", + "reopened": { + "descriptionHtml": "A previously closed secret scanning alert was reopened.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -244927,7 +246548,7 @@ "description": "", "isRequired": true, "enum": [ - "publicly_leaked" + "reopened" ], "childParamsGroups": [] }, @@ -245631,11 +247252,11 @@ "organization", "app" ], - "action": "publicly_leaked", + "action": "reopened", "category": "secret_scanning_alert" }, - "reopened": { - "descriptionHtml": "A previously closed secret scanning alert was reopened.
", + "resolved": { + "descriptionHtml": "A secret scanning alert was closed.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -245645,7 +247266,7 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "resolved" ], "childParamsGroups": [] }, @@ -246349,11 +247970,11 @@ "organization", "app" ], - "action": "reopened", + "action": "resolved", "category": "secret_scanning_alert" }, - "resolved": { - "descriptionHtml": "A secret scanning alert was closed.
", + "unassigned": { + "descriptionHtml": "A secret scanning alert was unassigned.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -246363,7 +247984,7 @@ "description": "", "isRequired": true, "enum": [ - "resolved" + "unassigned" ], "childParamsGroups": [] }, @@ -247025,6 +248646,142 @@ } ] }, + { + "type": "object", + "name": "assignee", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, { "type": "object", "name": "enterprise", @@ -247067,7 +248824,7 @@ "organization", "app" ], - "action": "resolved", + "action": "unassigned", "category": "secret_scanning_alert" }, "validated": { diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index cee13e3ee544..667d0447cd24 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -12737,6 +12737,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -12773,6 +12782,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13670,6 +13687,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -13706,6 +13732,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16714,7 +16748,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16895,6 +16929,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -17091,446 +17130,456 @@ } ] }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - } - ] - }, - { - "type": "string or null", - "name": "commit_oid", - "in": "body", - "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.
An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization", - "app" - ], - "action": "reopened", - "category": "code_scanning_alert" - }, - "reopened_by_user": { - "descriptionHtml": "Someone reopened a code scanning alert.
", - "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", - "bodyParameters": [ - { - "type": "string", - "name": "action", - "in": "body", - "description": "", - "isRequired": true, - "enum": [ - "reopened_by_user" - ], - "childParamsGroups": [] - }, - { - "type": "object", - "name": "alert", - "in": "body", - "description": "The code scanning alert involved in the event.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "array of objects", - "name": "assignees", - "description": "", - "childParamsGroups": [ - { - "type": "string or null", - "name": "name", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "avatar_url", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "gravatar_id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "html_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "followers_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "following_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "gists_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "organizations_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "repos_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "received_events_url", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "type", - "description": "", - "isRequired": true - }, - { - "type": "boolean", - "name": "site_admin", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "starred_at", - "description": "" - }, - { - "type": "string", - "name": "user_view_type", - "description": "" - } - ] - }, - { - "type": "string", - "name": "created_at", - "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" - }, - { - "type": "null", - "name": "dismissed_reason", - "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", - "isRequired": true - }, - { - "type": "object or null", - "name": "most_recent_instance", + "name": "url", "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "analysis_key", - "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", - "isRequired": true - }, - { - "type": "string", - "name": "category", - "description": "Identifies the configuration under which the analysis was executed.
" - }, - { - "type": "array of strings", - "name": "classifications", - "description": "" - }, - { - "type": "string", - "name": "commit_sha", - "description": "" - }, - { - "type": "string", - "name": "environment", - "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.
", - "isRequired": true - }, - { - "type": "object", - "name": "location", - "description": "", - "childParamsGroups": [ - { - "type": "integer", - "name": "end_column", - "description": "" - }, - { - "type": "integer", - "name": "end_line", - "description": "" - }, - { - "type": "string", - "name": "path", - "description": "" - }, - { - "type": "integer", - "name": "start_column", - "description": "" - }, - { - "type": "integer", - "name": "start_line", - "description": "" - } - ] - }, - { - "type": "object", - "name": "message", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "text", - "description": "" - } - ] - }, - { - "type": "string", - "name": "ref", - "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", - "isRequired": true, - "enum": [ - "open", - "dismissed", - "fixed" - ] - } - ] - }, - { - "type": "integer", - "name": "number", - "description": "The code scanning alert number.
", "isRequired": true }, { - "type": "object", - "name": "rule", - "description": "", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "description", - "description": "A short description of the rule used to detect the alert.
", - "isRequired": true - }, - { - "type": "string", - "name": "id", - "description": "A unique identifier for the rule used to detect the alert.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "severity", - "description": "The severity of the alert.
", - "isRequired": true, - "enum": [ - "none", - "note", - "warning", - "error", - null - ] - } - ] - }, - { - "type": "string or null", - "name": "state", - "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", - "isRequired": true - }, - { - "type": "string or null", - "name": "version", - "description": "The version of the tool used to detect the alert.
", - "isRequired": true - } - ] - }, - { - "type": "string", - "name": "url", - "description": "", - "isRequired": true + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, { - "type": "string", + "type": "string or null", + "name": "commit_oid", + "in": "body", + "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.
An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
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.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "reopened", + "category": "code_scanning_alert" + }, + "reopened_by_user": { + "descriptionHtml": "Someone reopened a code scanning alert.
", + "summaryHtml": "This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see \"About code scanning\" and \"About code scanning alerts.\" For information about the API to manage code scanning, see \"Code scanning\" in the REST API documentation.
\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "reopened_by_user" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "The code scanning alert involved in the event.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "array of objects", + "name": "assignees", + "description": "", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The dismissal comment associated with the dismissal of the alert.
" + }, + { + "type": "null", + "name": "dismissed_reason", + "description": "The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.
The time that the alert was fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The GitHub URL of the alert resource.
", + "isRequired": true + }, + { + "type": "object or null", + "name": "most_recent_instance", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "analysis_key", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
", + "isRequired": true + }, + { + "type": "string", + "name": "category", + "description": "Identifies the configuration under which the analysis was executed.
" + }, + { + "type": "array of strings", + "name": "classifications", + "description": "" + }, + { + "type": "string", + "name": "commit_sha", + "description": "" + }, + { + "type": "string", + "name": "environment", + "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.
", + "isRequired": true + }, + { + "type": "object", + "name": "location", + "description": "", + "childParamsGroups": [ + { + "type": "integer", + "name": "end_column", + "description": "" + }, + { + "type": "integer", + "name": "end_line", + "description": "" + }, + { + "type": "string", + "name": "path", + "description": "" + }, + { + "type": "integer", + "name": "start_column", + "description": "" + }, + { + "type": "integer", + "name": "start_line", + "description": "" + } + ] + }, + { + "type": "object", + "name": "message", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "text", + "description": "" + } + ] + }, + { + "type": "string", + "name": "ref", + "description": "The full Git reference, formatted as refs/heads/<branch name>.
State of a code scanning alert.
", + "isRequired": true, + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + ] + }, + { + "type": "integer", + "name": "number", + "description": "The code scanning alert number.
", + "isRequired": true + }, + { + "type": "object", + "name": "rule", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "description", + "description": "A short description of the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string", + "name": "id", + "description": "A unique identifier for the rule used to detect the alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "severity", + "description": "The severity of the alert.
", + "isRequired": true, + "enum": [ + "none", + "note", + "warning", + "error", + null + ] + } + ] + }, + { + "type": "string or null", + "name": "state", + "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a null value until they are dismissed or fixed.
The name of the tool used to generate the code scanning analysis alert.
", + "isRequired": true + }, + { + "type": "string or null", + "name": "version", + "description": "The version of the tool used to detect the alert.
", + "isRequired": true + } + ] + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + } + ] + }, + { + "type": "string", "name": "commit_oid", "in": "body", "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.
Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -244311,7 +244360,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -244817,7 +244866,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -245497,7 +245546,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -246003,7 +246052,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -246683,7 +246732,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -247159,7 +247208,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -247839,7 +247888,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -248127,7 +248176,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -248807,7 +248856,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -249100,7 +249149,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -249780,7 +249829,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -250732,304 +250781,1876 @@ "name": "sender", "in": "body", "description": "A GitHub user.
", - "isRequired": true, + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "reopen", + "category": "repository_vulnerability_alert" + }, + "resolve": { + "descriptionHtml": "A repository vulnerability alert was marked as resolved.
", + "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "affected_package_name", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "affected_range", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "created_at", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "dismiss_reason", + "description": "" + }, + { + "type": "string", + "name": "dismissed_at", + "description": "" + }, + { + "type": "object or null", + "name": "dismisser", + "description": "", + "childParamsGroups": [ + { + "type": "string", + "name": "avatar_url", + "description": "" + }, + { + "type": "boolean", + "name": "deleted", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "events_url", + "description": "" + }, + { + "type": "string", + "name": "followers_url", + "description": "" + }, + { + "type": "string", + "name": "following_url", + "description": "" + }, + { + "type": "string", + "name": "gists_url", + "description": "" + }, + { + "type": "string", + "name": "gravatar_id", + "description": "" + }, + { + "type": "string", + "name": "html_url", + "description": "" + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "name", + "description": "" + }, + { + "type": "string", + "name": "node_id", + "description": "" + }, + { + "type": "string", + "name": "organizations_url", + "description": "" + }, + { + "type": "string", + "name": "received_events_url", + "description": "" + }, + { + "type": "string", + "name": "repos_url", + "description": "" + }, + { + "type": "boolean", + "name": "site_admin", + "description": "" + }, + { + "type": "string", + "name": "starred_url", + "description": "" + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "" + }, + { + "type": "string", + "name": "type", + "description": "", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + { + "type": "string", + "name": "url", + "description": "" + } + ] + }, + { + "type": "string", + "name": "external_identifier", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "external_reference", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "fix_reason", + "description": "" + }, + { + "type": "string", + "name": "fixed_at", + "description": "" + }, + { + "type": "string", + "name": "fixed_in", + "description": "" + }, + { + "type": "string", + "name": "ghsa_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "number", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "severity", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "state", + "description": "", + "isRequired": true, + "enum": [ + "fixed", + "open" + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "isRequired": true, + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization" + ], + "action": "resolve", + "category": "repository_vulnerability_alert" + } + }, + "secret_scanning_alert": { + "assigned": { + "descriptionHtml": "A secret scanning alert was assigned.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "assigned" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_reviewer_comment", + "description": "An optional comment when reviewing a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_comment", + "description": "An optional comment when requesting a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_html_url", + "description": "The URL to a push protection bypass request.
" + }, + { + "type": "boolean or null", + "name": "publicly_leaked", + "description": "Whether the detected secret was publicly leaked.
" + }, + { + "type": "boolean or null", + "name": "multi_repo", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" + }, + { + "type": "object", + "name": "assigned_to", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "assignee", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", + "childParamsGroups": [] + } + ], + "availability": [ + "repository", + "organization", + "app" + ], + "action": "assigned", + "category": "secret_scanning_alert" + }, + "created": { + "descriptionHtml": "A secret scanning alert was created.
", + "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", + "bodyParameters": [ + { + "type": "string", + "name": "action", + "in": "body", + "description": "", + "isRequired": true, + "enum": [ + "created" + ], + "childParamsGroups": [] + }, + { + "type": "object", + "name": "alert", + "in": "body", + "description": "", + "isRequired": true, + "childParamsGroups": [ + { + "type": "integer", + "name": "number", + "description": "The security alert number.
" + }, + { + "type": "string", + "name": "created_at", + "description": "The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
The REST API URL of the alert resource.
" + }, + { + "type": "string", + "name": "html_url", + "description": "The GitHub URL of the alert resource.
" + }, + { + "type": "string", + "name": "locations_url", + "description": "The REST API URL of the code locations for this alert.
" + }, + { + "type": "string or null", + "name": "resolution", + "description": "The reason for resolving the alert.
", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + "pattern_deleted", + "pattern_edited", + null + ] + }, + { + "type": "string or null", + "name": "resolved_at", + "description": "The time that the alert was resolved in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "resolution_comment", + "description": "An optional comment to resolve an alert.
" + }, + { + "type": "string", + "name": "secret_type", + "description": "The type of secret that secret scanning detected.
" + }, + { + "type": "string", + "name": "secret_type_display_name", + "description": "User-friendly name for the detected secret, matching the secret_type.\nFor a list of built-in patterns, see \"Supported secret scanning patterns.\"
The token status as of the latest validity check.
", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + { + "type": "boolean or null", + "name": "push_protection_bypassed", + "description": "Whether push protection was bypassed for the detected secret.
" + }, + { + "type": "object", + "name": "push_protection_bypassed_by", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypassed_at", + "description": "The time that push protection was bypassed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_reviewer_comment", + "description": "An optional comment when reviewing a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_comment", + "description": "An optional comment when requesting a push protection bypass.
" + }, + { + "type": "string or null", + "name": "push_protection_bypass_request_html_url", + "description": "The URL to a push protection bypass request.
" + }, + { + "type": "boolean or null", + "name": "publicly_leaked", + "description": "Whether the detected secret was publicly leaked.
" + }, + { + "type": "boolean or null", + "name": "multi_repo", + "description": "Whether the detected secret was found in multiple repositories in the same organization or business.
" + }, + { + "type": "object", + "name": "assigned_to", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + } + ] + }, + { + "type": "object", + "name": "enterprise", + "in": "body", + "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", "childParamsGroups": [] } ], "availability": [ "repository", - "organization" + "organization", + "app" ], - "action": "reopen", - "category": "repository_vulnerability_alert" + "action": "created", + "category": "secret_scanning_alert" }, - "resolve": { - "descriptionHtml": "A repository vulnerability alert was marked as resolved.
", - "summaryHtml": "This event occurs when there is activity relating to a security vulnerability alert in a repository.
\n\nClosing down notice: This event is closing down. Use the dependabot_alert event instead.
The security alert of the vulnerable dependency.
", - "isRequired": true, - "childParamsGroups": [ - { - "type": "string", - "name": "affected_package_name", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "affected_range", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "created_at", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "dismiss_reason", - "description": "" - }, - { - "type": "string", - "name": "dismissed_at", - "description": "" - }, - { - "type": "object or null", - "name": "dismisser", - "description": "", - "childParamsGroups": [ - { - "type": "string", - "name": "avatar_url", - "description": "" - }, - { - "type": "boolean", - "name": "deleted", - "description": "" - }, - { - "type": "string or null", - "name": "email", - "description": "" - }, - { - "type": "string", - "name": "events_url", - "description": "" - }, - { - "type": "string", - "name": "followers_url", - "description": "" - }, - { - "type": "string", - "name": "following_url", - "description": "" - }, - { - "type": "string", - "name": "gists_url", - "description": "" - }, - { - "type": "string", - "name": "gravatar_id", - "description": "" - }, - { - "type": "string", - "name": "html_url", - "description": "" - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "login", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "name", - "description": "" - }, - { - "type": "string", - "name": "node_id", - "description": "" - }, - { - "type": "string", - "name": "organizations_url", - "description": "" - }, - { - "type": "string", - "name": "received_events_url", - "description": "" - }, - { - "type": "string", - "name": "repos_url", - "description": "" - }, - { - "type": "boolean", - "name": "site_admin", - "description": "" - }, - { - "type": "string", - "name": "starred_url", - "description": "" - }, - { - "type": "string", - "name": "subscriptions_url", - "description": "" - }, - { - "type": "string", - "name": "type", - "description": "", - "enum": [ - "Bot", - "User", - "Organization" - ] - }, - { - "type": "string", - "name": "url", - "description": "" - } - ] - }, - { - "type": "string", - "name": "external_identifier", - "description": "", - "isRequired": true - }, - { - "type": "string or null", - "name": "external_reference", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "fix_reason", - "description": "" - }, - { - "type": "string", - "name": "fixed_at", - "description": "" - }, - { - "type": "string", - "name": "fixed_in", - "description": "" - }, - { - "type": "string", - "name": "ghsa_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "id", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "node_id", - "description": "", - "isRequired": true - }, - { - "type": "integer", - "name": "number", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "severity", - "description": "", - "isRequired": true - }, - { - "type": "string", - "name": "state", - "description": "", - "isRequired": true, - "enum": [ - "fixed", - "open" - ] - } - ] - }, - { - "type": "object", - "name": "enterprise", - "in": "body", - "description": "An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"About enterprise accounts.\"
The GitHub App installation. Webhook payloads contain the installation property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"Using webhooks with GitHub Apps.\"
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.
The repository on GitHub where the event occurred. Webhook payloads contain the repository property\nwhen the event occurs from activity in a repository.
A GitHub user.
", - "isRequired": true, - "childParamsGroups": [] - } - ], - "availability": [ - "repository", - "organization" - ], - "action": "resolve", - "category": "repository_vulnerability_alert" - } - }, - "secret_scanning_alert": { - "created": { - "descriptionHtml": "A secret scanning alert was created.
", + "publicly_leaked": { + "descriptionHtml": "A secret scanning alert was detected in a public repo.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -251039,7 +252660,7 @@ "description": "", "isRequired": true, "enum": [ - "created" + "publicly_leaked" ], "childParamsGroups": [] }, @@ -251743,11 +253364,11 @@ "organization", "app" ], - "action": "created", + "action": "publicly_leaked", "category": "secret_scanning_alert" }, - "publicly_leaked": { - "descriptionHtml": "A secret scanning alert was detected in a public repo.
", + "reopened": { + "descriptionHtml": "A previously closed secret scanning alert was reopened.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -251757,7 +253378,7 @@ "description": "", "isRequired": true, "enum": [ - "publicly_leaked" + "reopened" ], "childParamsGroups": [] }, @@ -252461,11 +254082,11 @@ "organization", "app" ], - "action": "publicly_leaked", + "action": "reopened", "category": "secret_scanning_alert" }, - "reopened": { - "descriptionHtml": "A previously closed secret scanning alert was reopened.
", + "resolved": { + "descriptionHtml": "A secret scanning alert was closed.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -252475,7 +254096,7 @@ "description": "", "isRequired": true, "enum": [ - "reopened" + "resolved" ], "childParamsGroups": [] }, @@ -253179,11 +254800,11 @@ "organization", "app" ], - "action": "reopened", + "action": "resolved", "category": "secret_scanning_alert" }, - "resolved": { - "descriptionHtml": "A secret scanning alert was closed.
", + "unassigned": { + "descriptionHtml": "A secret scanning alert was unassigned.
", "summaryHtml": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"About secret scanning.\" For information about the API to manage secret scanning alerts, see \"Secret scanning\" in the REST API documentation.
\nFor activity relating to secret scanning alert locations, use the secret_scanning_alert_location event.
To subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.
", "bodyParameters": [ { @@ -253193,7 +254814,7 @@ "description": "", "isRequired": true, "enum": [ - "resolved" + "unassigned" ], "childParamsGroups": [] }, @@ -253855,6 +255476,142 @@ } ] }, + { + "type": "object", + "name": "assignee", + "in": "body", + "description": "A GitHub user.
", + "childParamsGroups": [ + { + "type": "string or null", + "name": "name", + "description": "" + }, + { + "type": "string or null", + "name": "email", + "description": "" + }, + { + "type": "string", + "name": "login", + "description": "", + "isRequired": true + }, + { + "type": "integer", + "name": "id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "node_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "avatar_url", + "description": "", + "isRequired": true + }, + { + "type": "string or null", + "name": "gravatar_id", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "html_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "followers_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "following_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "gists_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "subscriptions_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "organizations_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "repos_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "received_events_url", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true + }, + { + "type": "boolean", + "name": "site_admin", + "description": "", + "isRequired": true + }, + { + "type": "string", + "name": "starred_at", + "description": "" + }, + { + "type": "string", + "name": "user_view_type", + "description": "" + } + ] + }, { "type": "object", "name": "enterprise", @@ -253897,7 +255654,7 @@ "organization", "app" ], - "action": "resolved", + "action": "unassigned", "category": "secret_scanning_alert" }, "validated": { diff --git a/src/webhooks/data/ghes-3.14/schema.json b/src/webhooks/data/ghes-3.14/schema.json index 6ed68107747f..46a20dae5feb 100644 --- a/src/webhooks/data/ghes-3.14/schema.json +++ b/src/webhooks/data/ghes-3.14/schema.json @@ -12420,6 +12420,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -12456,6 +12465,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13353,6 +13370,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -13389,6 +13415,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16397,7 +16431,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16578,6 +16612,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -16774,11 +16813,21 @@ } ] }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, { "type": "string", "name": "url", "description": "", "isRequired": true + }, + { + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, @@ -201986,7 +202035,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -202921,7 +202970,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -203856,7 +203905,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -204766,7 +204815,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -205488,7 +205537,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -206215,7 +206264,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", diff --git a/src/webhooks/data/ghes-3.15/schema.json b/src/webhooks/data/ghes-3.15/schema.json index f7f18d82d5d6..fd0e76260a60 100644 --- a/src/webhooks/data/ghes-3.15/schema.json +++ b/src/webhooks/data/ghes-3.15/schema.json @@ -12603,6 +12603,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -12639,6 +12648,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13536,6 +13553,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -13572,6 +13598,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16580,7 +16614,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16761,6 +16795,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -16957,11 +16996,21 @@ } ] }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, { "type": "string", "name": "url", "description": "", "isRequired": true + }, + { + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, @@ -202246,7 +202295,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -202798,7 +202847,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -203294,7 +203343,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -203846,7 +203895,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -204342,7 +204391,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -204894,7 +204943,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -205365,7 +205414,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -205917,7 +205966,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -206200,7 +206249,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -206752,7 +206801,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -207040,7 +207089,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -207592,7 +207641,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], diff --git a/src/webhooks/data/ghes-3.16/schema.json b/src/webhooks/data/ghes-3.16/schema.json index 5c3f93a7ed16..333aa1af2a40 100644 --- a/src/webhooks/data/ghes-3.16/schema.json +++ b/src/webhooks/data/ghes-3.16/schema.json @@ -12603,6 +12603,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -12639,6 +12648,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13536,6 +13553,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -13572,6 +13598,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16580,7 +16614,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16761,6 +16795,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -16957,11 +16996,21 @@ } ] }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, { "type": "string", "name": "url", "description": "", "isRequired": true + }, + { + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, @@ -204251,7 +204300,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -204803,7 +204852,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -205300,7 +205349,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -205852,7 +205901,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -206349,7 +206398,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -206901,7 +206950,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -207372,7 +207421,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -207924,7 +207973,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -208207,7 +208256,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -208759,7 +208808,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -209047,7 +209096,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -209599,7 +209648,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], diff --git a/src/webhooks/data/ghes-3.17/schema.json b/src/webhooks/data/ghes-3.17/schema.json index 647631ee6b86..300b7d16c326 100644 --- a/src/webhooks/data/ghes-3.17/schema.json +++ b/src/webhooks/data/ghes-3.17/schema.json @@ -12667,6 +12667,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -12703,6 +12712,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13600,6 +13617,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -13636,6 +13662,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16644,7 +16678,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16825,6 +16859,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -17021,11 +17060,21 @@ } ] }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, { "type": "string", "name": "url", "description": "", "isRequired": true + }, + { + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, @@ -206955,7 +207004,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -207635,7 +207684,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -208137,7 +208186,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -208817,7 +208866,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -209319,7 +209368,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -209999,7 +210048,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -210475,7 +210524,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -211155,7 +211204,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -211443,7 +211492,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -212123,7 +212172,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -212416,7 +212465,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -213096,7 +213145,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], diff --git a/src/webhooks/data/ghes-3.18/schema.json b/src/webhooks/data/ghes-3.18/schema.json index b8f3f1e18fc4..b1880bf70069 100644 --- a/src/webhooks/data/ghes-3.18/schema.json +++ b/src/webhooks/data/ghes-3.18/schema.json @@ -12687,6 +12687,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -12723,6 +12732,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13620,6 +13637,15 @@ "write" ] }, + { + "type": "string", + "name": "artifact_metadata", + "description": "", + "enum": [ + "read", + "write" + ] + }, { "type": "string", "name": "attestations", @@ -13656,6 +13682,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16664,7 +16698,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16845,6 +16879,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -17041,11 +17080,21 @@ } ] }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, { "type": "string", "name": "url", "description": "", "isRequired": true + }, + { + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, @@ -207098,7 +207147,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -207778,7 +207827,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -208280,7 +208329,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -208960,7 +209009,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -209462,7 +209511,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -210142,7 +210191,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -210618,7 +210667,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -211298,7 +211347,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -211586,7 +211635,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -212266,7 +212315,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -212559,7 +212608,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -213239,7 +213288,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], diff --git a/src/webhooks/data/ghes-3.19/schema.json b/src/webhooks/data/ghes-3.19/schema.json index 19fe3532679e..86ffb5237695 100644 --- a/src/webhooks/data/ghes-3.19/schema.json +++ b/src/webhooks/data/ghes-3.19/schema.json @@ -12732,6 +12732,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -13674,6 +13682,14 @@ "write" ] }, + { + "type": "string", + "name": "copilot_requests", + "description": "", + "enum": [ + "write" + ] + }, { "type": "string", "name": "deployments", @@ -16682,7 +16698,7 @@ "childParamsGroups": [] }, { - "type": "object or null", + "type": "object", "name": "alert", "in": "body", "description": "The code scanning alert involved in the event.
", @@ -16863,6 +16879,11 @@ "description": "The GitHub URL of the alert resource.
", "isRequired": true }, + { + "type": "string", + "name": "instances_url", + "description": "" + }, { "type": "object or null", "name": "most_recent_instance", @@ -17059,11 +17080,21 @@ } ] }, + { + "type": "string or null", + "name": "updated_at", + "description": "" + }, { "type": "string", "name": "url", "description": "", "isRequired": true + }, + { + "type": "null", + "name": "dismissal_approved_by", + "description": "" } ] }, @@ -226986,7 +227017,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -227666,7 +227697,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -228168,7 +228199,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -228848,7 +228879,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -229350,7 +229381,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -230030,7 +230061,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -230506,7 +230537,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -231186,7 +231217,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -231474,7 +231505,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -232154,7 +232185,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], @@ -232447,7 +232478,7 @@ { "type": "boolean", "name": "automatic_copilot_code_review_enabled", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
" + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
" }, { "type": "boolean", @@ -233127,7 +233158,7 @@ { "type": "object", "name": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review.
", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.
", "isRequired": [ "type" ], diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 4c0b862cfe7f..8c9c948966e1 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "dafe0f9ac291168cb41ccc752fbdde576ae44f63" + "sha": "5b1274f51ab314e4957866bd009106ea1aeedddf" } \ No newline at end of file diff --git a/src/workflows/cmp-files.ts b/src/workflows/cmp-files.ts deleted file mode 100755 index 91708766dd9b..000000000000 --- a/src/workflows/cmp-files.ts +++ /dev/null @@ -1,29 +0,0 @@ -// [start-readme] -// -// Given N files. Exit 0 if they all exist and are identical in content. -// -// [end-readme] - -import fs from 'fs' - -import { program } from 'commander' - -program.description('Compare N files').arguments('[files...]').parse(process.argv) - -main(program.args) - -function main(files: string[]) { - if (files.length < 2) throw new Error('Must be at least 2 files') - try { - const contents = files.map((file) => fs.readFileSync(file, 'utf-8')) - if (new Set(contents).size > 1) { - process.exit(1) - } - } catch (error: any) { - if (error.code === 'ENOENT') { - process.exit(1) - } else { - throw error - } - } -} diff --git a/src/workflows/husky/post-checkout b/src/workflows/husky/post-checkout deleted file mode 100755 index 2b3c7447881d..000000000000 --- a/src/workflows/husky/post-checkout +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/sh -[ -n "$CI" ] && exit 0 - -# Ignore this check if user has DOCS_NO_AUTO_NPM set in their environment -if [ -n "$DOCS_NO_AUTO_NPM" ]; then - echo "Skipping auto-npm install because DOCS_NO_AUTO_NPM is set" - exit 0 -fi - -# Same process in husky/post-merge -echo "Checking if packages need to be installed..." -if npm run cmp-files -- package-lock.json .installed.package-lock.json; then - echo "Packages are up-to-date" -else - echo "Installing packages..." - npm install - echo "Packages are now up-to-date" -fi diff --git a/src/workflows/husky/post-merge b/src/workflows/husky/post-merge deleted file mode 100755 index a5f5599caad4..000000000000 --- a/src/workflows/husky/post-merge +++ /dev/null @@ -1,18 +0,0 @@ -#!/bin/sh -[ -n "$CI" ] && exit 0 - -# Ignore this check if user has DOCS_NO_AUTO_NPM set in their environment -if [ -n "$DOCS_NO_AUTO_NPM" ]; then - echo "Skipping auto-npm install because DOCS_NO_AUTO_NPM is set" - exit 0 -fi - -# Same process in husky/post-checkout -echo "Checking if packages need to be installed..." -if npm run cmp-files -- package-lock.json .installed.package-lock.json; then - echo "Packages are up-to-date" -else - echo "Installing packages..." - npm install - echo "Packages are now up-to-date" -fi