diff options
Diffstat (limited to 'descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml')
| -rw-r--r-- | descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml | 245 |
1 files changed, 232 insertions, 13 deletions
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: |