diff --git a/lib/redirects/static/client-side-rest-api-redirects.json b/lib/redirects/static/client-side-rest-api-redirects.json index 49fa8be4f8..111b457391 100644 --- a/lib/redirects/static/client-side-rest-api-redirects.json +++ b/lib/redirects/static/client-side-rest-api-redirects.json @@ -38,6 +38,7 @@ "/rest/repos#get-latest-pages-build": "/rest/pages#get-latest-pages-build", "/rest/repos#get-github-pages-build": "/rest/pages#get-github-pages-build", "/rest/repos#get-a-dns-health-check-for-github-pages": "/rest/pages#get-a-dns-health-check-for-github-pages", + "/rest/repos#create-a-github-pages-deployment": "/rest/pages#create-a-github-pages-deployment", "/rest/repos#get-the-weekly-commit-activity": "/rest/metrics/statistics#get-the-weekly-commit-activity", "/rest/repos#get-the-last-year-of-commit-activity": "/rest/metrics/statistics#get-the-last-year-of-commit-activity", "/rest/repos#get-all-contributor-commit-activity": "/rest/metrics/statistics#get-all-contributor-commit-activity", diff --git a/lib/rest/static/apps/enabled-for-apps.json b/lib/rest/static/apps/enabled-for-apps.json index 7bfbb1ef71..4df4ce0a74 100644 --- a/lib/rest/static/apps/enabled-for-apps.json +++ b/lib/rest/static/apps/enabled-for-apps.json @@ -2464,6 +2464,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/pages/builds/{build_id}" }, + { + "slug": "create-a-github-pages-deployment", + "subcategory": "pages", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployment" + }, { "slug": "get-a-dns-health-check-for-github-pages", "subcategory": "pages", diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 9639e0c876..aa8faf9e5a 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -366062,7 +366062,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -366321,7 +366321,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -422273,6 +422273,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -422657,6 +422671,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -423844,6 +423872,164 @@ ], "subcategory": "pages" }, + { + "serverUrl": "https://api.github.com", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/pages/deployment", + "title": "Create a GitHub Pages deployment", + "category": "pages", + "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. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "string", + "description": "

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.

", + "name": "artifact_url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository.", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The target environment for this GitHub Pages deployment.

", + "default": "github-pages", + "name": "environment", + "in": "body", + "rawType": "string", + "rawDescription": "The target environment for this GitHub Pages deployment.", + "isRequired": false, + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

A unique string that represents the version of the build for this deployment.

", + "default": "GITHUB_SHA", + "name": "pages_build_version", + "in": "body", + "rawType": "string", + "rawDescription": "A unique string that represents the version of the build for this deployment.", + "isRequired": true, + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The OIDC token issued by GitHub Actions certifying the origin of the deployment.

", + "name": "oidc_token", + "in": "body", + "rawType": "string", + "rawDescription": "The OIDC token issued by GitHub Actions certifying the origin of the deployment.", + "isRequired": true, + "childParamsGroups": [] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "artifact_url": "https://downloadcontent/", + "environment": "github-pages", + "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251", + "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA", + "preview": false + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "200", + "contentType": "application/json", + "description": "

Response

", + "example": { + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", + "page_url": "developer.github.com" + }, + "schema": { + "title": "GitHub Pages", + "description": "The GitHub Pages deployment status.", + "type": "object", + "properties": { + "status_url": { + "type": "string", + "description": "The URI to monitor GitHub Pages deployment status.", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + ] + }, + "page_url": { + "type": "string", + "description": "The URI to the deployed GitHub Pages.", + "format": "uri", + "examples": [ + "hello-world.github.io" + ] + }, + "preview_url": { + "type": "string", + "description": "The URI to the deployed GitHub Pages preview.", + "format": "uri", + "examples": [ + "monalisa-1231a2312sa32-23sda74.drafts.github.io" + ] + } + }, + "required": [ + "status_url", + "page_url" + ] + } + } + } + ], + "previews": [], + "descriptionHTML": "

Create a GitHub Pages deployment for a repository.

\n

Users must have write permissions. GitHub Apps must have the pages:write permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "200", + "description": "

OK

" + }, + { + "httpStatusCode": "400", + "description": "

Bad Request

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + }, + { + "httpStatusCode": "422", + "description": "

Validation failed

" + } + ], + "subcategory": "pages" + }, { "serverUrl": "https://api.github.com", "verb": "get", @@ -482768,7 +482954,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -483053,7 +483239,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -494271,12 +494457,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index f38cea48c9..721669cef0 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -295814,7 +295814,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -296073,7 +296073,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -312805,6 +312805,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -313191,6 +313205,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -372722,7 +372750,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -373007,7 +373035,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -389821,12 +389849,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 2f9a681c24..09a3eec681 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -297028,7 +297028,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -297287,7 +297287,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -314413,6 +314413,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -314797,6 +314811,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -374409,7 +374437,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -374694,7 +374722,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -385860,12 +385888,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 902f701d57..661f610f8f 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -304983,7 +304983,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -305242,7 +305242,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -334392,6 +334392,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -334776,6 +334790,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -394388,7 +394416,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -394673,7 +394701,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -405839,12 +405867,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/decorated/ghes-3.5.json b/lib/rest/static/decorated/ghes-3.5.json index e1d33a656f..ee13757f1c 100644 --- a/lib/rest/static/decorated/ghes-3.5.json +++ b/lib/rest/static/decorated/ghes-3.5.json @@ -314974,7 +314974,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -315233,7 +315233,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -344389,6 +344389,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -344773,6 +344787,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -404324,7 +404352,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -404609,7 +404637,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -415781,12 +415809,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/decorated/ghes-3.6.json b/lib/rest/static/decorated/ghes-3.6.json index 8e8b9bc393..2fe8932f68 100644 --- a/lib/rest/static/decorated/ghes-3.6.json +++ b/lib/rest/static/decorated/ghes-3.6.json @@ -316348,7 +316348,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -316607,7 +316607,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -345811,6 +345811,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -346195,6 +346209,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -405794,7 +405822,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -406079,7 +406107,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -417297,12 +417325,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 9c50257b42..11920eb30c 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -270559,7 +270559,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "", + "description": "

Response

", "example": [ { "author": { @@ -270818,7 +270818,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "" + "description": "

OK

" }, { "httpStatusCode": "202", @@ -291785,6 +291785,20 @@ } ], "bodyParameters": [ + { + "type": "string", + "description": "

The process in which the Page will be built. Possible values are \"legacy\" and \"workflow\".

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "isRequired": false, + "childParamsGroups": [] + }, { "type": "object", "description": "

The source branch and directory used to publish your Pages site.

", @@ -292169,6 +292183,20 @@ "isRequired": false, "childParamsGroups": [] }, + { + "type": "string", + "description": "

The process by which the GitHub Pages site will be built. workflow means that the site is built by a custom GitHub Actions workflow. legacy means that the site is built by GitHub when changes are pushed to a specific branch.

", + "enum": [ + "legacy", + "workflow" + ], + "name": "build_type", + "in": "body", + "rawType": "string", + "rawDescription": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "isRequired": false, + "childParamsGroups": [] + }, { "anyOf": [ { @@ -350300,7 +350328,7 @@ "response": { "statusCode": "200", "contentType": "application/json", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

", + "description": "

Response

", "example": { "url": "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", "browser_download_url": "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", @@ -350585,7 +350613,7 @@ "statusCodes": [ { "httpStatusCode": "200", - "description": "

To download the asset's binary content, set the Accept header of the request to application/octet-stream. The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a 200 or 302 response.

" + "description": "

OK

" }, { "httpStatusCode": "302", @@ -361762,12 +361790,12 @@ }, { "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", "default": false, "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "isRequired": false, "childParamsGroups": [] }, diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 20eb946f93..e6658fb64a 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -160930,7 +160930,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -393156,6 +393156,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -393184,6 +393192,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -393580,6 +393593,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -393617,6 +393638,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -394983,6 +395009,314 @@ } } }, + "/repos/{owner}/{repo}/pages/deployment": { + "post": { + "summary": "Create a GitHub Pages deployment", + "description": "Create a GitHub Pages deployment for a repository.\n\nUsers must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-pages-deployment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/repos#create-a-github-pages-deployment" + }, + "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. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "description": "The object used to create GitHub Pages deployment", + "properties": { + "artifact_url": { + "type": "string", + "description": "The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository." + }, + "environment": { + "type": "string", + "description": "The target environment for this GitHub Pages deployment.", + "default": "github-pages" + }, + "pages_build_version": { + "type": "string", + "description": "A unique string that represents the version of the build for this deployment.", + "default": "GITHUB_SHA" + }, + "oidc_token": { + "type": "string", + "description": "The OIDC token issued by GitHub Actions certifying the origin of the deployment." + } + }, + "required": [ + "artifact_url", + "pages_build_version", + "oidc_token" + ] + }, + "examples": { + "default": { + "value": { + "artifact_url": "https://downloadcontent/", + "environment": "github-pages", + "pages_build_version": "4fd754f7e594640989b406850d0bc8f06a121251", + "oidc_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsIng1dCI6IlV2R1h4SUhlY0JFc1JCdEttemUxUEhfUERiVSIsImtpZCI6IjUyRjE5N0M0ODFERTcwMTEyQzQ0MUI0QTlCMzdCNTNDN0ZDRjBEQjUifQ.eyJqdGkiOiJhMWIwNGNjNy0zNzZiLTQ1N2QtOTMzNS05NTY5YmVjZDExYTIiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjYiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM5MDAwODU2LCJleHAiOjE2MzkwMDE3NTYsImlhdCI6MTYzOTAwMTQ1Nn0.VP8WictbQECKozE2SgvKb2FqJ9hisWsoMkYRTqfBrQfZTCXi5IcFEdgDMB2X7a99C2DeUuTvHh9RMKXLL2a0zg3-Sd7YrO7a2ll2kNlnvyIypcN6AeIc7BxHsTTnZN9Ud_xmEsTrSRGOEKmzCFkULQ6N4zlVD0sidypmXlMemmWEcv_ZHqhioEI_VMp5vwXQurketWH7qX4oDgG4okyYtPrv5RQHbfQcVo9izaPJ_jnsDd0CBA0QOx9InjPidtIkMYQLyUgJy33HLJy86EFNUnAf8UhBQuQi5mAsEpEzBBuKpG3PDiPtYCHOk64JZkZGd5mR888a5sbHRiaF8hm8YA", + "preview": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "GitHub Pages", + "description": "The GitHub Pages deployment status.", + "type": "object", + "properties": { + "status_url": { + "type": "string", + "description": "The URI to monitor GitHub Pages deployment status.", + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status" + ] + }, + "page_url": { + "type": "string", + "description": "The URI to the deployed GitHub Pages.", + "format": "uri", + "examples": [ + "hello-world.github.io" + ] + }, + "preview_url": { + "type": "string", + "description": "The URI to the deployed GitHub Pages preview.", + "format": "uri", + "examples": [ + "monalisa-1231a2312sa32-23sda74.drafts.github.io" + ] + } + }, + "required": [ + "status_url", + "page_url" + ] + }, + "examples": { + "default": { + "value": { + "status_url": "https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status", + "page_url": "developer.github.com" + } + } + } + } + } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "422": { + "description": "Validation failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": [ + "string", + "null" + ] + }, + { + "type": [ + "integer", + "null" + ] + }, + { + "type": [ + "array", + "null" + ], + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "pages" + } + } + }, "/repos/{owner}/{repo}/pages/health": { "get": { "summary": "Get a DNS health check for GitHub Pages", @@ -445047,7 +445381,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -453703,7 +454037,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 87b49775a2..9b7294b918 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -129651,7 +129651,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -330590,6 +330590,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -330618,6 +330626,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -331020,6 +331033,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -331057,6 +331078,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -376283,7 +376309,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -383890,7 +383916,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index b18e266e9d..858907a6ba 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -130890,7 +130890,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -332999,6 +332999,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -333027,6 +333035,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -333423,6 +333436,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -333460,6 +333481,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -378656,7 +378682,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -386619,7 +386645,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 64f7b02988..acdadde77d 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -141113,7 +141113,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -349545,6 +349545,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -349573,6 +349581,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -349969,6 +349982,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -350006,6 +350027,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -395202,7 +395228,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -403364,7 +403390,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.5.deref.json b/lib/rest/static/dereferenced/ghes-3.5.deref.json index ddca9e1781..9c4b400686 100644 --- a/lib/rest/static/dereferenced/ghes-3.5.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.5.deref.json @@ -143370,7 +143370,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -359684,6 +359684,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -359712,6 +359720,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -360108,6 +360121,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -360145,6 +360166,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -405341,7 +405367,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.5/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -413517,7 +413543,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/ghes-3.6.deref.json b/lib/rest/static/dereferenced/ghes-3.6.deref.json index cf092341fd..050f9abf25 100644 --- a/lib/rest/static/dereferenced/ghes-3.6.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.6.deref.json @@ -144229,7 +144229,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -361578,6 +361578,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -361606,6 +361614,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -362002,6 +362015,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -362039,6 +362060,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -407283,7 +407309,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/enterprise-server@3.6/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -416070,7 +416096,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 2097a4a9de..46d2db5d0b 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -107540,7 +107540,7 @@ }, "private": { "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://docs.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", "default": false }, "visibility": { @@ -317677,6 +317677,14 @@ ], "description": "The source branch and directory used to publish your Pages site.", "properties": { + "build_type": { + "type": "string", + "description": "The process in which the Page will be built. Possible values are `\"legacy\"` and `\"workflow\"`.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "type": "object", "description": "The source branch and directory used to publish your Pages site.", @@ -317705,6 +317713,11 @@ "required": [ "source" ] + }, + { + "required": [ + "build_type" + ] } ] }, @@ -318101,6 +318114,14 @@ "type": "boolean", "description": "Configures access controls for the GitHub Pages site. If public is set to `true`, the site is accessible to anyone on the internet. If set to `false`, the site will only be accessible to users who have at least `read` access to the repository that published the site. This includes anyone in your Enterprise if the repository is set to `internal` visibility. This feature is only available to repositories in an organization on an Enterprise plan." }, + "build_type": { + "type": "string", + "description": "The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.", + "enum": [ + "legacy", + "workflow" + ] + }, "source": { "anyOf": [ { @@ -318138,6 +318159,11 @@ } }, "anyOf": [ + { + "required": [ + "build_type" + ] + }, { "required": [ "source" @@ -362948,7 +362974,7 @@ ], "responses": { "200": { - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://docs.github.com/github-ae@latest/rest/overview/media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "description": "Response", "content": { "application/json": { "schema": { @@ -370571,7 +370597,7 @@ ], "responses": { "200": { - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "Response", "content": { "application/json": { "schema": { diff --git a/script/rest/utils/rest-api-overrides.json b/script/rest/utils/rest-api-overrides.json index 9e7824688d..425f7d0699 100644 --- a/script/rest/utils/rest-api-overrides.json +++ b/script/rest/utils/rest-api-overrides.json @@ -195,6 +195,11 @@ "subcategory": null, "originalUrl": "/rest/reference/repos#get-a-dns-health-check-for-github-pages" }, + "repos/create-pages-deployment": { + "category": "pages", + "subcategory": null, + "originalUrl": "/rest/reference/repos#create-a-github-pages-deployment" + }, "repos/get-code-frequency-stats": { "category": "metrics", "subcategory": "statistics",