From e1701e0b698dddc3c09d959103a604741b572634 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Wed, 13 Apr 2022 04:35:54 -0700 Subject: [PATCH 1/2] Update OpenAPI Descriptions --- lib/rest/static/decorated/api.github.com.json | 8 +- lib/rest/static/decorated/ghes-3.1.json | 8 +- lib/rest/static/decorated/ghes-3.2.json | 8 +- lib/rest/static/decorated/ghes-3.3.json | 8 +- lib/rest/static/decorated/ghes-3.4.json | 8 +- lib/rest/static/decorated/github.ae.json | 8 +- .../dereferenced/api.github.com.deref.json | 15 +- .../static/dereferenced/ghes-3.1.deref.json | 180 +++++++++++++++++- .../static/dereferenced/ghes-3.2.deref.json | 180 +++++++++++++++++- .../static/dereferenced/ghes-3.3.deref.json | 180 +++++++++++++++++- .../static/dereferenced/ghes-3.4.deref.json | 180 +++++++++++++++++- .../static/dereferenced/github.ae.deref.json | 15 +- 12 files changed, 714 insertions(+), 84 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index dc7ff5c7a6..d7a63c0d48 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -28150,7 +28150,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -28172,7 +28172,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Response for in_progress conclusion", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -28269,7 +28269,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -87761,7 +87761,7 @@ ] }, { - "serverUrl": "https%3A%2F%2Fuploads.github.com", + "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 7d062ced20..81f196252f 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -22607,7 +22607,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -22629,7 +22629,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Response for in_progress conclusion", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -22726,7 +22726,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -68313,7 +68313,7 @@ ] }, { - "serverUrl": "https%3A%2F%2Fuploads.github.com", + "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 877c18f946..ac2de8231b 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -23663,7 +23663,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -23685,7 +23685,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Response for in_progress conclusion", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -23782,7 +23782,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -70724,7 +70724,7 @@ ] }, { - "serverUrl": "https%3A%2F%2Fuploads.github.com", + "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", diff --git a/lib/rest/static/decorated/ghes-3.3.json b/lib/rest/static/decorated/ghes-3.3.json index 1b06bcca41..3f6a252832 100644 --- a/lib/rest/static/decorated/ghes-3.3.json +++ b/lib/rest/static/decorated/ghes-3.3.json @@ -23737,7 +23737,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -23759,7 +23759,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Response for in_progress conclusion", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -23856,7 +23856,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -71200,7 +71200,7 @@ ] }, { - "serverUrl": "https%3A%2F%2Fuploads.github.com", + "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", diff --git a/lib/rest/static/decorated/ghes-3.4.json b/lib/rest/static/decorated/ghes-3.4.json index 13e21e364e..cc578c74e1 100644 --- a/lib/rest/static/decorated/ghes-3.4.json +++ b/lib/rest/static/decorated/ghes-3.4.json @@ -25124,7 +25124,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -25146,7 +25146,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Response for in_progress conclusion", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -25243,7 +25243,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -75517,7 +75517,7 @@ ] }, { - "serverUrl": "https%3A%2F%2Fuploads.github.com", + "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 6c0b571d3e..7367db26b5 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -21036,7 +21036,7 @@ "key": "example-of-in-progress-conclusion", "request": { "contentType": "application/json", - "description": "Response for in_progress conclusion", + "description": "Example of an in_progress conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -21058,7 +21058,7 @@ "response": { "statusCode": "201", "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Response for in_progress conclusion", "example": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -21155,7 +21155,7 @@ "key": "example-of-completed-conclusion", "request": { "contentType": "application/json", - "description": "Response for completed conclusion", + "description": "Example of a completed conclusion", "acceptHeader": "application/vnd.github.v3+json", "bodyParameters": { "name": "mighty_readme", @@ -66000,7 +66000,7 @@ ] }, { - "serverUrl": "https%3A%2F%2Fuploads.github.com", + "serverUrl": "https://uploads.github.com", "verb": "post", "requestPath": "/repos/{owner}/{repo}/releases/{release_id}/assets", "title": "Upload a release asset", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 5cd8e730ff..e295ac6282 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -211651,7 +211651,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Response for in_progress conclusion", + "summary": "Example of an in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -211666,7 +211666,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Example of a completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -212874,7 +212874,7 @@ } }, "example-of-in-progress-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Response for in_progress conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -432155,13 +432155,8 @@ }, "servers": [ { - "url": "{origin}", - "variables": { - "origin": { - "default": "https://uploads.github.com", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" - } - } + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], "parameters": [ diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 1913ac860d..133046fee3 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -168290,7 +168290,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Response for in_progress conclusion", + "summary": "Example of an in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -168305,7 +168305,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Example of a completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -169513,7 +169513,7 @@ } }, "example-of-in-progress-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Response for in_progress conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -365544,13 +365544,8 @@ }, "servers": [ { - "url": "{origin}", - "variables": { - "origin": { - "default": "https://uploads.github.com", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" - } - } + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], "parameters": [ @@ -387151,6 +387146,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-the-configuration-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -387235,6 +387245,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#start-a-configuration-process" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -387260,6 +387285,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-the-maintenance-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -387342,6 +387382,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -387448,6 +387503,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -388112,6 +388182,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#set-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "204": { "description": "Response" @@ -388159,6 +388244,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#get-all-authorized-ssh-keys" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -388218,6 +388318,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#add-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "201": { "description": "Response", @@ -388299,6 +388414,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#remove-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -388382,6 +388512,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#create-a-github-enterprise-server-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -388434,6 +388579,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.1/rest/reference/enterprise-admin#upgrade-a-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index a8a50dc567..36c0553f2f 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -172617,7 +172617,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Response for in_progress conclusion", + "summary": "Example of an in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -172632,7 +172632,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Example of a completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -173840,7 +173840,7 @@ } }, "example-of-in-progress-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Response for in_progress conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -373666,13 +373666,8 @@ }, "servers": [ { - "url": "{origin}", - "variables": { - "origin": { - "default": "https://uploads.github.com", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" - } - } + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], "parameters": [ @@ -396965,6 +396960,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-the-configuration-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -397049,6 +397059,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#start-a-configuration-process" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -397074,6 +397099,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-the-maintenance-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -397156,6 +397196,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -397262,6 +397317,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -397926,6 +397996,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#set-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "204": { "description": "Response" @@ -397973,6 +398058,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#get-all-authorized-ssh-keys" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -398032,6 +398132,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#add-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "201": { "description": "Response", @@ -398113,6 +398228,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#remove-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -398196,6 +398326,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#create-a-github-enterprise-server-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -398248,6 +398393,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.2/rest/reference/enterprise-admin#upgrade-a-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" diff --git a/lib/rest/static/dereferenced/ghes-3.3.deref.json b/lib/rest/static/dereferenced/ghes-3.3.deref.json index 391ca75ce3..5e700ed47f 100644 --- a/lib/rest/static/dereferenced/ghes-3.3.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.3.deref.json @@ -176035,7 +176035,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Response for in_progress conclusion", + "summary": "Example of an in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -176050,7 +176050,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Example of a completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -177258,7 +177258,7 @@ } }, "example-of-in-progress-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Response for in_progress conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -377252,13 +377252,8 @@ }, "servers": [ { - "url": "{origin}", - "variables": { - "origin": { - "default": "https://uploads.github.com", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" - } - } + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], "parameters": [ @@ -400668,6 +400663,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-the-configuration-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -400752,6 +400762,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#start-a-configuration-process" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -400777,6 +400802,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-the-maintenance-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -400859,6 +400899,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -400965,6 +401020,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -401629,6 +401699,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#set-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "204": { "description": "Response" @@ -401676,6 +401761,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#get-all-authorized-ssh-keys" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -401735,6 +401835,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#add-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "201": { "description": "Response", @@ -401816,6 +401931,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#remove-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -401899,6 +402029,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#create-a-github-enterprise-server-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -401951,6 +402096,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/enterprise-admin#upgrade-a-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" diff --git a/lib/rest/static/dereferenced/ghes-3.4.deref.json b/lib/rest/static/dereferenced/ghes-3.4.deref.json index 3c78e41c88..288e4318f3 100644 --- a/lib/rest/static/dereferenced/ghes-3.4.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.4.deref.json @@ -191743,7 +191743,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Response for in_progress conclusion", + "summary": "Example of an in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -191758,7 +191758,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Example of a completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -192966,7 +192966,7 @@ } }, "example-of-in-progress-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Response for in_progress conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -393181,13 +393181,8 @@ }, "servers": [ { - "url": "{origin}", - "variables": { - "origin": { - "default": "https://uploads.github.com", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" - } - } + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], "parameters": [ @@ -416794,6 +416789,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#get-the-configuration-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -416878,6 +416888,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#start-a-configuration-process" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -416903,6 +416928,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#get-the-maintenance-status" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -416985,6 +417025,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#enable-or-disable-maintenance-mode" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -417091,6 +417146,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#get-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -417755,6 +417825,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#set-settings" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "204": { "description": "Response" @@ -417802,6 +417887,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#get-all-authorized-ssh-keys" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -417861,6 +417961,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#add-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "201": { "description": "Response", @@ -417942,6 +418057,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#remove-an-authorized-ssh-key" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "200": { "description": "Response", @@ -418025,6 +418155,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#create-a-github-enterprise-server-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" @@ -418077,6 +418222,21 @@ "description": "API method documentation", "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/enterprise-admin#upgrade-a-license" }, + "servers": [ + { + "url": "{protocol}://{hostname}", + "variables": { + "hostname": { + "default": "HOSTNAME", + "description": "Self-hosted Enterprise Server hostname" + }, + "protocol": { + "default": "http", + "description": "Self-hosted Enterprise Server protocol" + } + } + } + ], "responses": { "202": { "description": "Response" diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 05f1e88daf..f29092d9b5 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -156353,7 +156353,7 @@ }, "examples": { "example-of-in-progress-conclusion": { - "summary": "Response for in_progress conclusion", + "summary": "Example of an in_progress conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -156368,7 +156368,7 @@ } }, "example-of-completed-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Example of a completed conclusion", "value": { "name": "mighty_readme", "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -157576,7 +157576,7 @@ } }, "example-of-in-progress-conclusion": { - "summary": "Response for completed conclusion", + "summary": "Response for in_progress conclusion", "value": { "id": 4, "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", @@ -356984,13 +356984,8 @@ }, "servers": [ { - "url": "{origin}", - "variables": { - "origin": { - "default": "https://uploads.github.com", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" - } - } + "url": "https://uploads.github.com", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint" } ], "parameters": [ From 38929cbda5478d90d8203eced5cc3e54b15ba17a Mon Sep 17 00:00:00 2001 From: Brad Willis Date: Wed, 13 Apr 2022 07:44:43 -0400 Subject: [PATCH 2/2] Update adding-a-new-gpg-key-to-your-github-account.md --- .../adding-a-new-gpg-key-to-your-github-account.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md b/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md index eaae511761..036d501525 100644 --- a/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md +++ b/content/authentication/managing-commit-signature-verification/adding-a-new-gpg-key-to-your-github-account.md @@ -19,6 +19,8 @@ Before adding a new GPG key to your account on {% ifversion ghae %}{% data varia - [Checked for existing GPG keys](/articles/checking-for-existing-gpg-keys) - [Generated and copied a new GPG key](/articles/generating-a-new-gpg-key) +You can add multiple public keys to your GitHub account. Commits signed by any of the corresponding private keys will show as verified. If you remove a public key, any commits signed by the corresponding private key will no longer show as verified. + {% data reusables.gpg.supported-gpg-key-algorithms %} When verifying a signature, we extract the signature and attempt to parse its key-id. We match the key-id with keys uploaded to {% data variables.product.product_name %}. Until you upload your GPG key to {% data variables.product.product_name %}, we cannot verify your signatures.