зеркало из https://github.com/github/docs.git
Update OpenAPI Descriptions (#30397)
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
This commit is contained in:
github-openapi-bot
GitHub
Родитель
bd0ecf83a3
Коммит
807f605f54
|
|
@ -19,5 +19,6 @@ children:
|
|||
- /followers
|
||||
- /gpg-keys
|
||||
- /keys
|
||||
- /ssh-signing-keys
|
||||
---
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
title: SSH signing keys
|
||||
intro: ''
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '>=3.7'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- API
|
||||
miniTocMaxHeadingLevel: 3
|
||||
allowTitleToDifferFromFilename: true
|
||||
---
|
||||
|
||||
|
|
@ -919,6 +919,11 @@
|
|||
"/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user": "/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user",
|
||||
"/rest/collaborators/invitations#accept-a-repository-invitation": "/rest/collaborators/invitations#accept-a-repository-invitation",
|
||||
"/rest/collaborators/invitations#decline-a-repository-invitation": "/rest/collaborators/invitations#decline-a-repository-invitation",
|
||||
"/rest/users#list-public-ssh-signing-keys-for-the-authenticated-user": "/rest/users/ssh-signing-keys#list-public-ssh-signing-keys-for-the-authenticated-user",
|
||||
"/rest/users#ssh-signing-keys": "/rest/users/ssh-signing-keys",
|
||||
"/rest/users#create-an-ssh-signing-key-for-the-authenticated-user": "/rest/users/ssh-signing-keys#create-an-ssh-signing-key-for-the-authenticated-user",
|
||||
"/rest/users#get-a-ssh-signing-key-for-the-authenticated-user": "/rest/users/ssh-signing-keys#get-a-ssh-signing-key-for-the-authenticated-user",
|
||||
"/rest/users#delete-a-ssh-signing-key-for-the-authenticated-user": "/rest/users/ssh-signing-keys#delete-a-ssh-signing-key-for-the-authenticated-user",
|
||||
"/rest/activity#list-repositories-starred-by-the-authenticated-user": "/rest/activity/starring#list-repositories-starred-by-the-authenticated-user",
|
||||
"/rest/activity#check-if-a-repository-is-starred-by-the-authenticated-user": "/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user",
|
||||
"/rest/activity#star-a-repository-for-the-authenticated-user": "/rest/activity/starring#star-a-repository-for-the-authenticated-user",
|
||||
|
|
@ -943,6 +948,7 @@
|
|||
"/rest/activity#list-events-received-by-the-authenticated-user": "/rest/activity/events#list-events-received-by-the-authenticated-user",
|
||||
"/rest/activity#list-public-events-received-by-a-user": "/rest/activity/events#list-public-events-received-by-a-user",
|
||||
"/rest/repos#list-repositories-for-a-user": "/rest/repos/repos#list-repositories-for-a-user",
|
||||
"/rest/users#list-ssh-signing-keys-for-a-user": "/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user",
|
||||
"/rest/activity#list-repositories-starred-by-a-user": "/rest/activity/starring#list-repositories-starred-by-a-user",
|
||||
"/rest/activity#list-repositories-watched-by-a-user": "/rest/activity/watching#list-repositories-watched-by-a-user",
|
||||
"/rest/enterprise-admin#list-global-webhooks": "/rest/enterprise-admin/global-webhooks#list-global-webhooks",
|
||||
|
|
|
|||
|
|
@ -3798,6 +3798,12 @@
|
|||
"subcategory": "keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/users/{username}/keys"
|
||||
},
|
||||
{
|
||||
"slug": "list-ssh-signing-keys-for-a-user",
|
||||
"subcategory": "ssh-signing-keys",
|
||||
"verb": "get",
|
||||
"requestPath": "/users/{username}/ssh_signing_keys"
|
||||
}
|
||||
],
|
||||
"webhooks": [
|
||||
|
|
|
|||
|
|
@ -580356,6 +580356,487 @@
|
|||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"ssh-signing-keys": [
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/user/ssh_signing_keys",
|
||||
"title": "List SSH signing keys for the authenticated user",
|
||||
"category": "users",
|
||||
"subcategory": "ssh-signing-keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "<p>The number of results per page (max 100).</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "<p>Page number of the results to fetch.</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": false,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json"
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Response</p>",
|
||||
"example": [
|
||||
{
|
||||
"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"
|
||||
}
|
||||
],
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>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 <code>read:ssh_signing_key</code> scope. For more information, see \"<a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">Understanding scopes for OAuth apps</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"description": "<p>Not modified</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "401",
|
||||
"description": "<p>Requires authentication</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "post",
|
||||
"requestPath": "/user/ssh_signing_keys",
|
||||
"title": "Create a SSH signing key for the authenticated user",
|
||||
"category": "users",
|
||||
"subcategory": "ssh-signing-keys",
|
||||
"parameters": [],
|
||||
"bodyParameters": [
|
||||
{
|
||||
"type": "string",
|
||||
"name": "title",
|
||||
"in": "body",
|
||||
"description": "<p>A descriptive name for the new key.</p>"
|
||||
},
|
||||
{
|
||||
"type": "string",
|
||||
"name": "key",
|
||||
"in": "body",
|
||||
"description": "<p>The public SSH key to add to your GitHub account. For more information, see \"<a href=\"https://docs.github.com/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys\">Checking for existing SSH keys</a>.\"</p>",
|
||||
"isRequired": true
|
||||
}
|
||||
],
|
||||
"enabledForGitHubApps": false,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"contentType": "application/json",
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json"
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "201",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Response</p>",
|
||||
"example": {
|
||||
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
|
||||
"id": 2,
|
||||
"url": "https://api.github.com/user/keys/2",
|
||||
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
|
||||
"created_at": "2020-06-11T21:31:57Z"
|
||||
},
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>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 <code>write:ssh_signing_key</code> scope. For more information, see \"<a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">Understanding scopes for OAuth apps</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "201",
|
||||
"description": "<p>Created</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"description": "<p>Not modified</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "401",
|
||||
"description": "<p>Requires authentication</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "422",
|
||||
"description": "<p>Validation failed</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}",
|
||||
"title": "Get an SSH signing key for the authenticated user",
|
||||
"category": "users",
|
||||
"subcategory": "ssh-signing-keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "ssh_signing_key_id",
|
||||
"description": "<p>The unique identifier of the SSH signing key.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": false,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"ssh_signing_key_id": "SSH_SIGNING_KEY_ID"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Response</p>",
|
||||
"example": {
|
||||
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
|
||||
"id": 2,
|
||||
"url": "https://api.github.com/user/keys/2",
|
||||
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
|
||||
"created_at": "2020-06-11T21:31:57Z"
|
||||
},
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least <code>read:ssh_signing_key</code> scope. For more information, see \"<a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">Understanding scopes for OAuth apps</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"description": "<p>Not modified</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "401",
|
||||
"description": "<p>Requires authentication</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "delete",
|
||||
"requestPath": "/user/ssh_signing_keys/{ssh_signing_key_id}",
|
||||
"title": "Delete an SSH signing key for the authenticated user",
|
||||
"category": "users",
|
||||
"subcategory": "ssh-signing-keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "ssh_signing_key_id",
|
||||
"description": "<p>The unique identifier of the SSH signing key.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": false,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "204",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"ssh_signing_key_id": "SSH_SIGNING_KEY_ID"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "204",
|
||||
"description": "<p>Response</p>"
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>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 <code>admin:ssh_signing_key</code> scope. For more information, see \"<a href=\"https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/\">Understanding scopes for OAuth apps</a>.\"</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "204",
|
||||
"description": "<p>No Content</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "304",
|
||||
"description": "<p>Not modified</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "401",
|
||||
"description": "<p>Requires authentication</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
"description": "<p>Forbidden</p>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "404",
|
||||
"description": "<p>Resource not found</p>"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"serverUrl": "https://api.github.com",
|
||||
"verb": "get",
|
||||
"requestPath": "/users/{username}/ssh_signing_keys",
|
||||
"title": "List SSH signing keys for a user",
|
||||
"category": "users",
|
||||
"subcategory": "ssh-signing-keys",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "username",
|
||||
"description": "<p>The handle for the GitHub user account.</p>",
|
||||
"in": "path",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "per_page",
|
||||
"description": "<p>The number of results per page (max 100).</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 30
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "page",
|
||||
"description": "<p>Page number of the results to fetch.</p>",
|
||||
"in": "query",
|
||||
"schema": {
|
||||
"type": "integer",
|
||||
"default": 1
|
||||
}
|
||||
}
|
||||
],
|
||||
"bodyParameters": [],
|
||||
"enabledForGitHubApps": true,
|
||||
"codeExamples": [
|
||||
{
|
||||
"key": "default",
|
||||
"request": {
|
||||
"description": "Example",
|
||||
"acceptHeader": "application/vnd.github.v3+json",
|
||||
"parameters": {
|
||||
"username": "USERNAME"
|
||||
}
|
||||
},
|
||||
"response": {
|
||||
"statusCode": "200",
|
||||
"contentType": "application/json",
|
||||
"description": "<p>Response</p>",
|
||||
"example": [
|
||||
{
|
||||
"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"
|
||||
}
|
||||
],
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
"previews": [],
|
||||
"descriptionHTML": "<p>Lists the SSH signing keys for a user. This operation is accessible by anyone.</p>",
|
||||
"statusCodes": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"description": "<p>OK</p>"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"webhooks": {
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче