Skip to content

Commit 3c55ee7

Browse files
mattpagemattpage
authored
Merge pull request #1485 from github/openapi-update-f140221528cfc0a738508a3ac7e05c728567b46ee276d6530a4734cbc149e399
Update OpenAPI 3.0 Descriptions
2 parents 503effd + c455532 commit 3c55ee7

4 files changed

Lines changed: 1658 additions & 13 deletions

File tree

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

Lines changed: 358 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55919,6 +55919,246 @@
5591955919
}
5592055920
}
5592155921
},
55922+
"/user/ssh_signing_keys": {
55923+
"get": {
55924+
"summary": "List SSH signing keys for the authenticated user",
55925+
"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/).\"",
55926+
"tags": [
55927+
"users"
55928+
],
55929+
"operationId": "users/list-ssh-signing-keys-for-authenticated-user",
55930+
"externalDocs": {
55931+
"description": "API method documentation",
55932+
"url": "https://docs.github.com/rest/reference/users#list-public-ssh-signing-keys-for-the-authenticated-user"
55933+
},
55934+
"parameters": [
55935+
{
55936+
"$ref": "#/components/parameters/per-page"
55937+
},
55938+
{
55939+
"$ref": "#/components/parameters/page"
55940+
}
55941+
],
55942+
"responses": {
55943+
"200": {
55944+
"description": "Response",
55945+
"content": {
55946+
"application/json": {
55947+
"schema": {
55948+
"type": "array",
55949+
"items": {
55950+
"$ref": "#/components/schemas/ssh-signing-key"
55951+
}
55952+
},
55953+
"examples": {
55954+
"default": {
55955+
"$ref": "#/components/examples/ssh-signing-key-items"
55956+
}
55957+
}
55958+
}
55959+
},
55960+
"headers": {
55961+
"Link": {
55962+
"$ref": "#/components/headers/link"
55963+
}
55964+
}
55965+
},
55966+
"304": {
55967+
"$ref": "#/components/responses/not_modified"
55968+
},
55969+
"404": {
55970+
"$ref": "#/components/responses/not_found"
55971+
},
55972+
"403": {
55973+
"$ref": "#/components/responses/forbidden"
55974+
},
55975+
"401": {
55976+
"$ref": "#/components/responses/requires_authentication"
55977+
}
55978+
},
55979+
"x-github": {
55980+
"githubCloudOnly": false,
55981+
"enabledForGitHubApps": false,
55982+
"previews": [
55983+
55984+
],
55985+
"category": "users",
55986+
"subcategory": "ssh-signing-keys"
55987+
}
55988+
},
55989+
"post": {
55990+
"summary": "Create a SSH signing key for the authenticated user",
55991+
"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/).\"",
55992+
"operationId": "users/create-ssh-signing-key-for-authenticated-user",
55993+
"tags": [
55994+
"users"
55995+
],
55996+
"externalDocs": {
55997+
"description": "API method documentation",
55998+
"url": "https://docs.github.com/rest/reference/users#create-an-ssh-signing-key-for-the-authenticated-user"
55999+
},
56000+
"parameters": [
56001+
56002+
],
56003+
"requestBody": {
56004+
"required": true,
56005+
"content": {
56006+
"application/json": {
56007+
"schema": {
56008+
"properties": {
56009+
"title": {
56010+
"description": "A descriptive name for the new key.",
56011+
"type": "string",
56012+
"example": "Personal MacBook Air"
56013+
},
56014+
"key": {
56015+
"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).\"",
56016+
"type": "string",
56017+
"pattern": "^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) "
56018+
}
56019+
},
56020+
"required": [
56021+
"key"
56022+
],
56023+
"type": "object"
56024+
}
56025+
}
56026+
}
56027+
},
56028+
"responses": {
56029+
"201": {
56030+
"description": "Response",
56031+
"content": {
56032+
"application/json": {
56033+
"schema": {
56034+
"$ref": "#/components/schemas/ssh-signing-key"
56035+
},
56036+
"examples": {
56037+
"default": {
56038+
"$ref": "#/components/examples/ssh-signing-key"
56039+
}
56040+
}
56041+
}
56042+
}
56043+
},
56044+
"422": {
56045+
"$ref": "#/components/responses/validation_failed"
56046+
},
56047+
"304": {
56048+
"$ref": "#/components/responses/not_modified"
56049+
},
56050+
"404": {
56051+
"$ref": "#/components/responses/not_found"
56052+
},
56053+
"403": {
56054+
"$ref": "#/components/responses/forbidden"
56055+
},
56056+
"401": {
56057+
"$ref": "#/components/responses/requires_authentication"
56058+
}
56059+
},
56060+
"x-github": {
56061+
"githubCloudOnly": false,
56062+
"enabledForGitHubApps": false,
56063+
"category": "users",
56064+
"subcategory": "ssh-signing-keys"
56065+
}
56066+
}
56067+
},
56068+
"/user/ssh_signing_keys/{ssh_signing_key_id}": {
56069+
"get": {
56070+
"summary": "Get an SSH signing key for the authenticated user",
56071+
"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/).\"",
56072+
"tags": [
56073+
"users"
56074+
],
56075+
"operationId": "users/get-ssh-signing-key-for-authenticated-user",
56076+
"externalDocs": {
56077+
"description": "API method documentation",
56078+
"url": "https://docs.github.com/rest/reference/users#get-a-ssh-signing-key-for-the-authenticated-user"
56079+
},
56080+
"parameters": [
56081+
{
56082+
"$ref": "#/components/parameters/ssh-signing-key-id"
56083+
}
56084+
],
56085+
"responses": {
56086+
"200": {
56087+
"description": "Response",
56088+
"content": {
56089+
"application/json": {
56090+
"schema": {
56091+
"$ref": "#/components/schemas/ssh-signing-key"
56092+
},
56093+
"examples": {
56094+
"default": {
56095+
"$ref": "#/components/examples/ssh-signing-key"
56096+
}
56097+
}
56098+
}
56099+
}
56100+
},
56101+
"404": {
56102+
"$ref": "#/components/responses/not_found"
56103+
},
56104+
"304": {
56105+
"$ref": "#/components/responses/not_modified"
56106+
},
56107+
"403": {
56108+
"$ref": "#/components/responses/forbidden"
56109+
},
56110+
"401": {
56111+
"$ref": "#/components/responses/requires_authentication"
56112+
}
56113+
},
56114+
"x-github": {
56115+
"githubCloudOnly": false,
56116+
"enabledForGitHubApps": false,
56117+
"category": "users",
56118+
"subcategory": "ssh-signing-keys"
56119+
}
56120+
},
56121+
"delete": {
56122+
"summary": "Delete an SSH signing key for the authenticated user",
56123+
"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/).\"",
56124+
"tags": [
56125+
"users"
56126+
],
56127+
"operationId": "users/delete-ssh-signing-key-for-authenticated-user",
56128+
"externalDocs": {
56129+
"description": "API method documentation",
56130+
"url": "https://docs.github.com/rest/reference/users#delete-a-ssh-signing-key-for-the-authenticated-user"
56131+
},
56132+
"parameters": [
56133+
{
56134+
"$ref": "#/components/parameters/ssh-signing-key-id"
56135+
}
56136+
],
56137+
"responses": {
56138+
"204": {
56139+
"description": "Response"
56140+
},
56141+
"304": {
56142+
"$ref": "#/components/responses/not_modified"
56143+
},
56144+
"404": {
56145+
"$ref": "#/components/responses/not_found"
56146+
},
56147+
"403": {
56148+
"$ref": "#/components/responses/forbidden"
56149+
},
56150+
"401": {
56151+
"$ref": "#/components/responses/requires_authentication"
56152+
}
56153+
},
56154+
"x-github": {
56155+
"githubCloudOnly": false,
56156+
"enabledForGitHubApps": false,
56157+
"category": "users",
56158+
"subcategory": "ssh-signing-keys"
56159+
}
56160+
}
56161+
},
5592256162
"/user/starred": {
5592356163
"get": {
5592456164
"summary": "List repositories starred by the authenticated user",
@@ -57852,6 +58092,62 @@
5785258092
}
5785358093
}
5785458094
},
58095+
"/users/{username}/ssh_signing_keys": {
58096+
"get": {
58097+
"summary": "List SSH signing keys for a user",
58098+
"description": "Lists the SSH signing keys for a user. This operation is accessible by anyone.",
58099+
"tags": [
58100+
"users"
58101+
],
58102+
"operationId": "users/list-ssh-signing-keys-for-user",
58103+
"externalDocs": {
58104+
"description": "API method documentation",
58105+
"url": "https://docs.github.com/rest/reference/users#list-ssh-signing-keys-for-a-user"
58106+
},
58107+
"parameters": [
58108+
{
58109+
"$ref": "#/components/parameters/username"
58110+
},
58111+
{
58112+
"$ref": "#/components/parameters/per-page"
58113+
},
58114+
{
58115+
"$ref": "#/components/parameters/page"
58116+
}
58117+
],
58118+
"responses": {
58119+
"200": {
58120+
"description": "Response",
58121+
"content": {
58122+
"application/json": {
58123+
"schema": {
58124+
"type": "array",
58125+
"items": {
58126+
"$ref": "#/components/schemas/ssh-signing-key"
58127+
}
58128+
},
58129+
"examples": {
58130+
"default": {
58131+
"$ref": "#/components/examples/ssh-signing-key-items"
58132+
}
58133+
}
58134+
}
58135+
},
58136+
"headers": {
58137+
"Link": {
58138+
"$ref": "#/components/headers/link"
58139+
}
58140+
}
58141+
}
58142+
},
58143+
"x-github": {
58144+
"githubCloudOnly": false,
58145+
"enabledForGitHubApps": true,
58146+
"category": "users",
58147+
"subcategory": "ssh-signing-keys"
58148+
}
58149+
}
58150+
},
5785558151
"/users/{username}/starred": {
5785658152
"get": {
5785758153
"summary": "List repositories starred by a user",
@@ -85502,6 +85798,32 @@
8550285798
"plan"
8550385799
]
8550485800
},
85801+
"ssh-signing-key": {
85802+
"title": "SSH Signing Key",
85803+
"description": "A public SSH key used to sign Git commits",
85804+
"type": "object",
85805+
"properties": {
85806+
"key": {
85807+
"type": "string"
85808+
},
85809+
"id": {
85810+
"type": "integer"
85811+
},
85812+
"title": {
85813+
"type": "string"
85814+
},
85815+
"created_at": {
85816+
"type": "string",
85817+
"format": "date-time"
85818+
}
85819+
},
85820+
"required": [
85821+
"key",
85822+
"id",
85823+
"title",
85824+
"created_at"
85825+
]
85826+
},
8550585827
"starred-repository": {
8550685828
"title": "Starred Repository",
8550785829
"description": "Starred Repository",
@@ -109915,6 +110237,33 @@
109915110237
}
109916110238
]
109917110239
},
110240+
"ssh-signing-key-items": {
110241+
"value": [
110242+
{
110243+
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
110244+
"id": 2,
110245+
"url": "https://api.github.com/user/keys/2",
110246+
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
110247+
"created_at": "2020-06-11T21:31:57Z"
110248+
},
110249+
{
110250+
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234",
110251+
"id": 3,
110252+
"url": "https://api.github.com/user/keys/3",
110253+
"title": "ssh-rsa AAAAB3NzaC1yc2EAAB",
110254+
"created_at": "2020-07-11T21:31:57Z"
110255+
}
110256+
]
110257+
},
110258+
"ssh-signing-key": {
110259+
"value": {
110260+
"key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234",
110261+
"id": 2,
110262+
"url": "https://api.github.com/user/keys/2",
110263+
"title": "ssh-rsa AAAAB3NzaC1yc2EAAA",
110264+
"created_at": "2020-06-11T21:31:57Z"
110265+
}
110266+
},
109918110267
"starred-repository-items-alternative-response-with-star-creation-timestamps": {
109919110268
"summary": "Alternative response with star creation timestamps",
109920110269
"value": [
@@ -112148,6 +112497,15 @@
112148112497
"schema": {
112149112498
"type": "integer"
112150112499
}
112500+
},
112501+
"ssh-signing-key-id": {
112502+
"name": "ssh_signing_key_id",
112503+
"description": "The unique identifier of the SSH signing key.",
112504+
"in": "path",
112505+
"required": true,
112506+
"schema": {
112507+
"type": "integer"
112508+
}
112151112509
}
112152112510
},
112153112511
"headers": {

0 commit comments

Comments
 (0)