diff options
author | github-openapi-bot <security+github-openapi-bot@github.com> | 2022-08-30 15:43:23 -0700 |
---|---|---|
committer | github-openapi-bot <security+github-openapi-bot@github.com> | 2022-08-30 15:43:23 -0700 |
commit | c633f51e5a234fbc9293e877f6fe28df4db524fe (patch) | |
tree | 2e5c50c92597bc276bccc5ef029515153c2ffd7d /descriptions-next/api.github.com | |
parent | 1a07184a55bce611206b0359977569c8134f46a9 (diff) | |
download | rest-api-description-c633f51e5a234fbc9293e877f6fe28df4db524fe.tar.gz rest-api-description-c633f51e5a234fbc9293e877f6fe28df4db524fe.zip |
Update OpenAPI 3.1 Descriptions
Diffstat (limited to 'descriptions-next/api.github.com')
4 files changed, 1670 insertions, 13 deletions
diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 534285832..61ce16864 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -56273,6 +56273,248 @@ } } }, + "/user/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for the authenticated user", + "description": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ssh-signing-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "post": { + "summary": "Create a SSH signing key for the authenticated user", + "description": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "operationId": "users/create-ssh-signing-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "examples": [ + "Personal MacBook Air" + ] + }, + "key": { + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + } + }, + "required": [ + "key" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ssh-signing-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key" + } + } + } + } + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + "get": { + "summary": "Get an SSH signing key for the authenticated user", + "description": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/get-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ssh-signing-key-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ssh-signing-key" + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "delete": { + "summary": "Delete an SSH signing key for the authenticated user", + "description": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/delete-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/ssh-signing-key-id" + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "$ref": "#/components/responses/not_modified" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", @@ -58206,6 +58448,62 @@ } } }, + "/users/{username}/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for a user", + "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/username" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/ssh-signing-key" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/ssh-signing-key-items" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", @@ -88387,6 +88685,32 @@ "plan" ] }, + "ssh-signing-key": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, "starred-repository": { "title": "Starred Repository", "description": "Starred Repository", @@ -112804,6 +113128,33 @@ } ] }, + "ssh-signing-key-items": { + "value": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ] + }, + "ssh-signing-key": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + }, "starred-repository-items-alternative-response-with-star-creation-timestamps": { "summary": "Alternative response with star creation timestamps", "value": [ @@ -115039,6 +115390,15 @@ "schema": { "type": "integer" } + }, + "ssh-signing-key-id": { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } }, "headers": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 29eb179fe..2706f47a8 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -40409,6 +40409,176 @@ paths: enabledForGitHubApps: false category: collaborators subcategory: invitations + "/user/ssh_signing_keys": + get: + summary: List SSH signing keys for the authenticated user + description: Lists the SSH signing keys for the authenticated user's GitHub + account. You must authenticate with Basic Authentication, or you must authenticate + with OAuth with at least `read:ssh_signing_key` scope. For more information, + see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + tags: + - users + operationId: users/list-ssh-signing-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-signing-key" + examples: + default: + "$ref": "#/components/examples/ssh-signing-key-items" + headers: + Link: + "$ref": "#/components/headers/link" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: ssh-signing-keys + post: + summary: Create a SSH signing key for the authenticated user + description: Creates an SSH signing key for the authenticated user's GitHub + account. You must authenticate with Basic Authentication, or you must authenticate + with OAuth with at least `write:ssh_signing_key` scope. For more information, + see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + operationId: users/create-ssh-signing-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + title: + description: A descriptive name for the new key. + type: string + examples: + - Personal MacBook Air + key: + description: The public SSH key to add to your GitHub account. For + more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + type: string + pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + required: + - key + type: object + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ssh-signing-key" + examples: + default: + "$ref": "#/components/examples/ssh-signing-key" + '422': + "$ref": "#/components/responses/validation_failed" + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + "/user/ssh_signing_keys/{ssh_signing_key_id}": + get: + summary: Get an SSH signing key for the authenticated user + description: Gets extended details for an SSH signing key. You must authenticate + with Basic Authentication, or you must authenticate with OAuth with at least + `read:ssh_signing_key` scope. For more information, see "[Understanding scopes + for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + tags: + - users + operationId: users/get-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user + parameters: + - "$ref": "#/components/parameters/ssh-signing-key-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/ssh-signing-key" + examples: + default: + "$ref": "#/components/examples/ssh-signing-key" + '404': + "$ref": "#/components/responses/not_found" + '304': + "$ref": "#/components/responses/not_modified" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + delete: + summary: Delete an SSH signing key for the authenticated user + description: Deletes an SSH signing key from the authenticated user's GitHub + account. You must authenticate with Basic Authentication, or you must authenticate + with OAuth with at least `admin:ssh_signing_key` scope. For more information, + see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + tags: + - users + operationId: users/delete-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user + parameters: + - "$ref": "#/components/parameters/ssh-signing-key-id" + responses: + '204': + description: Response + '304': + "$ref": "#/components/responses/not_modified" + '404': + "$ref": "#/components/responses/not_found" + '403': + "$ref": "#/components/responses/forbidden" + '401': + "$ref": "#/components/responses/requires_authentication" + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys "/user/starred": get: summary: List repositories starred by the authenticated user @@ -41721,6 +41891,41 @@ paths: enabledForGitHubApps: false category: billing subcategory: + "/users/{username}/ssh_signing_keys": + get: + summary: List SSH signing keys for a user + description: Lists the SSH signing keys for a user. This operation is accessible + by anyone. + tags: + - users + operationId: users/list-ssh-signing-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + "$ref": "#/components/schemas/ssh-signing-key" + examples: + default: + "$ref": "#/components/examples/ssh-signing-key-items" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: ssh-signing-keys "/users/{username}/starred": get: summary: List repositories starred by a user @@ -63348,6 +63553,25 @@ components: - free_trial_ends_on - account - plan + ssh-signing-key: + title: SSH Signing Key + description: A public SSH key used to sign Git commits + type: object + properties: + key: + type: string + id: + type: integer + title: + type: string + created_at: + type: string + format: date-time + required: + - key + - id + - title + - created_at starred-repository: title: Starred Repository description: Starred Repository @@ -84900,6 +85124,25 @@ components: forks: 1 open_issues: 1 watchers: 1 + ssh-signing-key-items: + value: + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + ssh-signing-key: + value: + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' starred-repository-items-alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps value: @@ -86681,6 +86924,13 @@ components: required: true schema: type: integer + ssh-signing-key-id: + name: ssh_signing_key_id + description: The unique identifier of the SSH signing key. + in: path + required: true + schema: + type: integer headers: link: example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 288522457..66729b635 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -563776,6 +563776,719 @@ } } }, + "/user/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for the authenticated user", + "description": "Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "post": { + "summary": "Create a SSH signing key for the authenticated user", + "description": "Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "operationId": "users/create-ssh-signing-key-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "properties": { + "title": { + "description": "A descriptive name for the new key.", + "type": "string", + "examples": [ + "Personal MacBook Air" + ] + }, + "key": { + "description": "The public SSH key to add to your GitHub account. For more information, see \"[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys).\"", + "type": "string", + "pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + } + }, + "required": [ + "key" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + } + } + } + } + }, + "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" + } + } + ] + } + } + } + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, + "/user/ssh_signing_keys/{ssh_signing_key_id}": { + "get": { + "summary": "Get an SSH signing key for the authenticated user", + "description": "Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/get-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "304": { + "description": "Not modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + }, + "delete": { + "summary": "Delete an SSH signing key for the authenticated user", + "description": "Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see \"[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\"", + "tags": [ + "users" + ], + "operationId": "users/delete-ssh-signing-key-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "ssh_signing_key_id", + "description": "The unique identifier of the SSH signing key.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "304": { + "description": "Not modified" + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, "/user/starred": { "get": { "summary": "List repositories starred by the authenticated user", @@ -604323,6 +605036,121 @@ } } }, + "/users/{username}/ssh_signing_keys": { + "get": { + "summary": "List SSH signing keys for a user", + "description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.", + "tags": [ + "users" + ], + "operationId": "users/list-ssh-signing-keys-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user" + }, + "parameters": [ + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "SSH Signing Key", + "description": "A public SSH key used to sign Git commits", + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "title": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "key", + "id", + "title", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234", + "id": 2, + "url": "https://api.github.com/user/keys/2", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAA", + "created_at": "2020-06-11T21:31:57Z" + }, + { + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234", + "id": 3, + "url": "https://api.github.com/user/keys/3", + "title": "ssh-rsa AAAAB3NzaC1yc2EAAB", + "created_at": "2020-07-11T21:31:57Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "<https://api.github.com/resource?page=2>; rel=\"next\", <https://api.github.com/resource?page=5>; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "users", + "subcategory": "ssh-signing-keys" + } + } + }, "/users/{username}/starred": { "get": { "summary": "List repositories starred by a user", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 4d0ea4fb5..a891fa286 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -53634,7 +53634,7 @@ paths: parameters: - *203 - *204 - - &475 + - &478 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -77905,7 +77905,7 @@ paths: - subkeys - revoked examples: - default: &476 + default: &479 value: - id: 3 name: Octocat's GPG Key @@ -79983,7 +79983,7 @@ paths: type: array items: *159 examples: - default: &477 + default: &480 value: - id: 197 name: hello_docker @@ -80070,7 +80070,7 @@ paths: application/json: schema: *159 examples: - default: &478 + default: &481 value: id: 40201 name: octo-name @@ -80620,7 +80620,7 @@ paths: type: array items: *45 examples: - default: &474 + default: &477 summary: Default response value: - id: 1296269 @@ -81024,6 +81024,193 @@ paths: enabledForGitHubApps: false category: collaborators subcategory: invitations + "/user/ssh_signing_keys": + get: + summary: List SSH signing keys for the authenticated user + description: Lists the SSH signing keys for the authenticated user's GitHub + account. You must authenticate with Basic Authentication, or you must authenticate + with OAuth with at least `read:ssh_signing_key` scope. For more information, + see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + tags: + - users + operationId: users/list-ssh-signing-keys-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user + parameters: + - *12 + - *30 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: &474 + title: SSH Signing Key + description: A public SSH key used to sign Git commits + type: object + properties: + key: + type: string + id: + type: integer + title: + type: string + created_at: + type: string + format: date-time + required: + - key + - id + - title + - created_at + examples: + default: &482 + value: + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 + id: 3 + url: https://api.github.com/user/keys/3 + title: ssh-rsa AAAAB3NzaC1yc2EAAB + created_at: '2020-07-11T21:31:57Z' + headers: + Link: *26 + '304': *25 + '404': *15 + '403': *22 + '401': *21 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + previews: [] + category: users + subcategory: ssh-signing-keys + post: + summary: Create a SSH signing key for the authenticated user + description: Creates an SSH signing key for the authenticated user's GitHub + account. You must authenticate with Basic Authentication, or you must authenticate + with OAuth with at least `write:ssh_signing_key` scope. For more information, + see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + operationId: users/create-ssh-signing-key-for-authenticated-user + tags: + - users + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user + parameters: [] + requestBody: + required: true + content: + application/json: + schema: + properties: + title: + description: A descriptive name for the new key. + type: string + examples: + - Personal MacBook Air + key: + description: The public SSH key to add to your GitHub account. For + more information, see "[Checking for existing SSH keys](https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." + type: string + pattern: "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) " + required: + - key + type: object + responses: + '201': + description: Response + content: + application/json: + schema: *474 + examples: + default: &475 + value: + key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 + id: 2 + url: https://api.github.com/user/keys/2 + title: ssh-rsa AAAAB3NzaC1yc2EAAA + created_at: '2020-06-11T21:31:57Z' + '422': *10 + '304': *25 + '404': *15 + '403': *22 + '401': *21 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + "/user/ssh_signing_keys/{ssh_signing_key_id}": + get: + summary: Get an SSH signing key for the authenticated user + description: Gets extended details for an SSH signing key. You must authenticate + with Basic Authentication, or you must authenticate with OAuth with at least + `read:ssh_signing_key` scope. For more information, see "[Understanding scopes + for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + tags: + - users + operationId: users/get-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user + parameters: + - &476 + name: ssh_signing_key_id + description: The unique identifier of the SSH signing key. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *474 + examples: + default: *475 + '404': *15 + '304': *25 + '403': *22 + '401': *21 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys + delete: + summary: Delete an SSH signing key for the authenticated user + description: Deletes an SSH signing key from the authenticated user's GitHub + account. You must authenticate with Basic Authentication, or you must authenticate + with OAuth with at least `admin:ssh_signing_key` scope. For more information, + see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + tags: + - users + operationId: users/delete-ssh-signing-key-for-authenticated-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user + parameters: + - *476 + responses: + '204': + description: Response + '304': *25 + '404': *15 + '403': *22 + '401': *21 + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: users + subcategory: ssh-signing-keys "/user/starred": get: summary: List repositories starred by the authenticated user @@ -81051,11 +81238,11 @@ paths: type: array items: *45 examples: - default-response: *474 + default-response: *477 application/vnd.github.v3.star+json: schema: type: array - items: &479 + items: &483 title: Starred Repository description: Starred Repository type: object @@ -81407,7 +81594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/reference/users#list-users parameters: - - *475 + - *478 - *12 responses: '200': @@ -81930,7 +82117,7 @@ paths: type: array items: *460 examples: - default: *476 + default: *479 headers: Link: *26 x-github: @@ -82166,7 +82353,7 @@ paths: type: array items: *159 examples: - default: *477 + default: *480 '403': *22 '401': *21 x-github: @@ -82199,7 +82386,7 @@ paths: application/json: schema: *159 examples: - default: *478 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -82859,6 +83046,38 @@ paths: enabledForGitHubApps: false category: billing subcategory: + "/users/{username}/ssh_signing_keys": + get: + summary: List SSH signing keys for a user + description: Lists the SSH signing keys for a user. This operation is accessible + by anyone. + tags: + - users + operationId: users/list-ssh-signing-keys-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user + parameters: + - *127 + - *12 + - *30 + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: *474 + examples: + default: *482 + headers: + Link: *26 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: users + subcategory: ssh-signing-keys "/users/{username}/starred": get: summary: List repositories starred by a user @@ -82886,11 +83105,11 @@ paths: schema: anyOf: - type: array - items: *479 + items: *483 - type: array items: *45 examples: - default-response: *474 + default-response: *477 headers: Link: *26 x-github: |