Skip to content

Commit c633f51

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent 1a07184 commit c633f51

4 files changed

Lines changed: 1670 additions & 13 deletions

File tree

‎descriptions-next/api.github.com/api.github.com.json‎

Lines changed: 360 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56273,6 +56273,248 @@
5627356273
}
5627456274
}
5627556275
},
56276+
"/user/ssh_signing_keys": {
56277+
"get": {
56278+
"summary": "List SSH signing keys for the authenticated user",
56279+
"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/).\"",
56280+
"tags": [
56281+
"users"
56282+
],
56283+
"operationId": "users/list-ssh-signing-keys-for-authenticated-user",
56284+
"externalDocs": {
56285+
"description": "API method documentation",
56286+
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user"
56287+
},
56288+
"parameters": [
56289+
{
56290+
"$ref": "#/components/parameters/per-page"
56291+
},
56292+
{
56293+
"$ref": "#/components/parameters/page"
56294+
}
56295+
],
56296+
"responses": {
56297+
"200": {
56298+
"description": "Response",
56299+
"content": {
56300+
"application/json": {
56301+
"schema": {
56302+
"type": "array",
56303+
"items": {
56304+
"$ref": "#/components/schemas/ssh-signing-key"
56305+
}
56306+
},
56307+
"examples": {
56308+
"default": {
56309+
"$ref": "#/components/examples/ssh-signing-key-items"
56310+
}
56311+
}
56312+
}
56313+
},
56314+
"headers": {
56315+
"Link": {
56316+
"$ref": "#/components/headers/link"
56317+
}
56318+
}
56319+
},
56320+
"304": {
56321+
"$ref": "#/components/responses/not_modified"
56322+
},
56323+
"404": {
56324+
"$ref": "#/components/responses/not_found"
56325+
},
56326+
"403": {
56327+
"$ref": "#/components/responses/forbidden"
56328+
},
56329+
"401": {
56330+
"$ref": "#/components/responses/requires_authentication"
56331+
}
56332+
},
56333+
"x-github": {
56334+
"githubCloudOnly": false,
56335+
"enabledForGitHubApps": false,
56336+
"previews": [
56337+
56338+
],
56339+
"category": "users",
56340+
"subcategory": "ssh-signing-keys"
56341+
}
56342+
},
56343+
"post": {
56344+
"summary": "Create a SSH signing key for the authenticated user",
56345+
"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/).\"",
56346+
"operationId": "users/create-ssh-signing-key-for-authenticated-user",
56347+
"tags": [
56348+
"users"
56349+
],
56350+
"externalDocs": {
56351+
"description": "API method documentation",
56352+
"url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user"
56353+
},
56354+
"parameters": [
56355+
56356+
],
56357+
"requestBody": {
56358+
"required": true,
56359+
"content": {
56360+
"application/json": {
56361+
"schema": {
56362+
"properties": {
56363+
"title": {
56364+
"description": "A descriptive name for the new key.",
56365+
"type": "string",
56366+
"examples": [
56367+
"Personal MacBook Air"
56368+
]
56369+
},
56370+
"key": {
56371+
"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).\"",
56372+
"type": "string",
56373+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
56374+
}
56375+
},
56376+
"required": [
56377+
"key"
56378+
],
56379+
"type": "object"
56380+
}
56381+
}
56382+
}
56383+
},
56384+
"responses": {
56385+
"201": {
56386+
"description": "Response",
56387+
"content": {
56388+
"application/json": {
56389+
"schema": {
56390+
"$ref": "#/components/schemas/ssh-signing-key"
56391+
},
56392+
"examples": {
56393+
"default": {
56394+
"$ref": "#/components/examples/ssh-signing-key"
56395+
}
56396+
}
56397+
}
56398+
}
56399+
},
56400+
"422": {
56401+
"$ref": "#/components/responses/validation_failed"
56402+
},
56403+
"304": {
56404+
"$ref": "#/components/responses/not_modified"
56405+
},
56406+
"404": {
56407+
"$ref": "#/components/responses/not_found"
56408+
},
56409+
"403": {
56410+
"$ref": "#/components/responses/forbidden"
56411+
},
56412+
"401": {
56413+
"$ref": "#/components/responses/requires_authentication"
56414+
}
56415+
},
56416+
"x-github": {
56417+
"githubCloudOnly": false,
56418+
"enabledForGitHubApps": false,
56419+
"category": "users",
56420+
"subcategory": "ssh-signing-keys"
56421+
}
56422+
}
56423+
},
56424+
"/user/ssh_signing_keys/{ssh_signing_key_id}": {
56425+
"get": {
56426+
"summary": "Get an SSH signing key for the authenticated user",
56427+
"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/).\"",
56428+
"tags": [
56429+
"users"
56430+
],
56431+
"operationId": "users/get-ssh-signing-key-for-authenticated-user",
56432+
"externalDocs": {
56433+
"description": "API method documentation",
56434+
"url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user"
56435+
},
56436+
"parameters": [
56437+
{
56438+
"$ref": "#/components/parameters/ssh-signing-key-id"
56439+
}
56440+
],
56441+
"responses": {
56442+
"200": {
56443+
"description": "Response",
56444+
"content": {
56445+
"application/json": {
56446+
"schema": {
56447+
"$ref": "#/components/schemas/ssh-signing-key"
56448+
},
56449+
"examples": {
56450+
"default": {
56451+
"$ref": "#/components/examples/ssh-signing-key"
56452+
}
56453+
}
56454+
}
56455+
}
56456+
},
56457+
"404": {
56458+
"$ref": "#/components/responses/not_found"
56459+
},
56460+
"304": {
56461+
"$ref": "#/components/responses/not_modified"
56462+
},
56463+
"403": {
56464+
"$ref": "#/components/responses/forbidden"
56465+
},
56466+
"401": {
56467+
"$ref": "#/components/responses/requires_authentication"
56468+
}
56469+
},
56470+
"x-github": {
56471+
"githubCloudOnly": false,
56472+
"enabledForGitHubApps": false,
56473+
"category": "users",
56474+
"subcategory": "ssh-signing-keys"
56475+
}
56476+
},
56477+
"delete": {
56478+
"summary": "Delete an SSH signing key for the authenticated user",
56479+
"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/).\"",
56480+
"tags": [
56481+
"users"
56482+
],
56483+
"operationId": "users/delete-ssh-signing-key-for-authenticated-user",
56484+
"externalDocs": {
56485+
"description": "API method documentation",
56486+
"url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user"
56487+
},
56488+
"parameters": [
56489+
{
56490+
"$ref": "#/components/parameters/ssh-signing-key-id"
56491+
}
56492+
],
56493+
"responses": {
56494+
"204": {
56495+
"description": "Response"
56496+
},
56497+
"304": {
56498+
"$ref": "#/components/responses/not_modified"
56499+
},
56500+
"404": {
56501+
"$ref": "#/components/responses/not_found"
56502+
},
56503+
"403": {
56504+
"$ref": "#/components/responses/forbidden"
56505+
},
56506+
"401": {
56507+
"$ref": "#/components/responses/requires_authentication"
56508+
}
56509+
},
56510+
"x-github": {
56511+
"githubCloudOnly": false,
56512+
"enabledForGitHubApps": false,
56513+
"category": "users",
56514+
"subcategory": "ssh-signing-keys"
56515+
}
56516+
}
56517+
},
5627656518
"/user/starred": {
5627756519
"get": {
5627856520
"summary": "List repositories starred by the authenticated user",
@@ -58206,6 +58448,62 @@
5820658448
}
5820758449
}
5820858450
},
58451+
"/users/{username}/ssh_signing_keys": {
58452+
"get": {
58453+
"summary": "List SSH signing keys for a user",
58454+
"description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.",
58455+
"tags": [
58456+
"users"
58457+
],
58458+
"operationId": "users/list-ssh-signing-keys-for-user",
58459+
"externalDocs": {
58460+
"description": "API method documentation",
58461+
"url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user"
58462+
},
58463+
"parameters": [
58464+
{
58465+
"$ref": "#/components/parameters/username"
58466+
},
58467+
{
58468+
"$ref": "#/components/parameters/per-page"
58469+
},
58470+
{
58471+
"$ref": "#/components/parameters/page"
58472+
}
58473+
],
58474+
"responses": {
58475+
"200": {
58476+
"description": "Response",
58477+
"content": {
58478+
"application/json": {
58479+
"schema": {
58480+
"type": "array",
58481+
"items": {
58482+
"$ref": "#/components/schemas/ssh-signing-key"
58483+
}
58484+
},
58485+
"examples": {
58486+
"default": {
58487+
"$ref": "#/components/examples/ssh-signing-key-items"
58488+
}
58489+
}
58490+
}
58491+
},
58492+
"headers": {
58493+
"Link": {
58494+
"$ref": "#/components/headers/link"
58495+
}
58496+
}
58497+
}
58498+
},
58499+
"x-github": {
58500+
"githubCloudOnly": false,
58501+
"enabledForGitHubApps": true,
58502+
"category": "users",
58503+
"subcategory": "ssh-signing-keys"
58504+
}
58505+
}
58506+
},
5820958507
"/users/{username}/starred": {
5821058508
"get": {
5821158509
"summary": "List repositories starred by a user",
@@ -88387,6 +88685,32 @@
8838788685
"plan"
8838888686
]
8838988687
},
88688+
"ssh-signing-key": {
88689+
"title": "SSH Signing Key",
88690+
"description": "A public SSH key used to sign Git commits",
88691+
"type": "object",
88692+
"properties": {
88693+
"key": {
88694+
"type": "string"
88695+
},
88696+
"id": {
88697+
"type": "integer"
88698+
},
88699+
"title": {
88700+
"type": "string"
88701+
},
88702+
"created_at": {
88703+
"type": "string",
88704+
"format": "date-time"
88705+
}
88706+
},
88707+
"required": [
88708+
"key",
88709+
"id",
88710+
"title",
88711+
"created_at"
88712+
]
88713+
},
8839088714
"starred-repository": {
8839188715
"title": "Starred Repository",
8839288716
"description": "Starred Repository",
@@ -112804,6 +113128,33 @@
112804113128
}
112805113129
]
112806113130
},
113131+
"ssh-signing-key-items": {
113132+
"value": [
113133+
{
113134+
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
113135+
"id": 2,
113136+
"url": "https://api.github.com/user/keys/2",
113137+
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
113138+
"created_at": "2020-06-11T21:31:57Z"
113139+
},
113140+
{
113141+
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
113142+
"id": 3,
113143+
"url": "https://api.github.com/user/keys/3",
113144+
"title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
113145+
"created_at": "2020-07-11T21:31:57Z"
113146+
}
113147+
]
113148+
},
113149+
"ssh-signing-key": {
113150+
"value": {
113151+
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
113152+
"id": 2,
113153+
"url": "https://api.github.com/user/keys/2",
113154+
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
113155+
"created_at": "2020-06-11T21:31:57Z"
113156+
}
113157+
},
112807113158
"starred-repository-items-alternative-response-with-star-creation-timestamps": {
112808113159
"summary": "Alternative response with star creation timestamps",
112809113160
"value": [
@@ -115039,6 +115390,15 @@
115039115390
"schema": {
115040115391
"type": "integer"
115041115392
}
115393+
},
115394+
"ssh-signing-key-id": {
115395+
"name": "ssh_signing_key_id",
115396+
"description": "The unique identifier of the SSH signing key.",
115397+
"in": "path",
115398+
"required": true,
115399+
"schema": {
115400+
"type": "integer"
115401+
}
115042115402
}
115043115403
},
115044115404
"headers": {

0 commit comments

Comments
 (0)