jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-02 03:04:13 -05:00
Code Issues Projects Releases Wiki Activity

Merge pull request #30090 from github/openapi-update-92a9624359520c163244edbf5ac1c44affe5242392847a0a4d037bb0bfa0528e

Browse Source 
Update OpenAPI  Descriptions
This commit is contained in:
Sarita Iyer
2022-08-19 11:00:50 -04:00
committed by GitHub
parent ddd838aa6f f31ba4b312
commit 7ecd6f5e5b
14 changed files with 5982 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1139
lib/rest/static/decorated/api.github.com.json
View File

File diff suppressed because it is too large Load Diff

43
lib/rest/static/decorated/ghes-3.2.json
View File

@@ -7285,7 +7285,7 @@
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "201",
"key": "default",
"request": {
"contentType": "application/json",
"description": "Example 1: Status Code 201",
@@ -7302,7 +7302,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response when creating a secret</p>"
"contentType": "application/json",
"description": "<p>Response when creating a secret</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
},
{
@@ -34575,7 +34584,16 @@
},
"response": {
"statusCode": "202",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -35397,6 +35415,13 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
},
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -36145,6 +36170,7 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -36153,7 +36179,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],

45
lib/rest/static/decorated/ghes-3.3.json
View File

@@ -7307,7 +7307,7 @@
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "201",
"key": "default",
"request": {
"contentType": "application/json",
"description": "Example 1: Status Code 201",
@@ -7324,7 +7324,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response when creating a secret</p>"
"contentType": "application/json",
"description": "<p>Response when creating a secret</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
},
{
@@ -34855,7 +34864,16 @@
},
"response": {
"statusCode": "202",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -35677,6 +35695,13 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
},
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -36425,6 +36450,7 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -36433,7 +36459,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -384304,7 +384339,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
@@ -409475,7 +409509,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,

45
lib/rest/static/decorated/ghes-3.4.json
View File

@@ -7307,7 +7307,7 @@
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "201",
"key": "default",
"request": {
"contentType": "application/json",
"description": "Example 1: Status Code 201",
@@ -7324,7 +7324,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response when creating a secret</p>"
"contentType": "application/json",
"description": "<p>Response when creating a secret</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
},
{
@@ -36952,7 +36961,16 @@
},
"response": {
"statusCode": "202",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -37774,6 +37792,13 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
},
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -38522,6 +38547,7 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -38530,7 +38556,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -404030,7 +404065,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
@@ -429351,7 +429385,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,

47
lib/rest/static/decorated/ghes-3.5.json
View File

@@ -8250,7 +8250,7 @@
"enabledForGitHubApps": true,
"codeExamples": [
{
"key": "201",
"key": "default",
"request": {
"contentType": "application/json",
"description": "Example 1: Status Code 201",
@@ -8267,7 +8267,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response when creating a secret</p>"
"contentType": "application/json",
"description": "<p>Response when creating a secret</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
},
{
@@ -28465,6 +28474,7 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -44881,7 +44891,16 @@
},
"response": {
"statusCode": "202",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -45703,6 +45722,13 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
},
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -46451,6 +46477,7 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -46459,7 +46486,16 @@
},
"response": {
"statusCode": "201",
"description": "<p>Response</p>"
"contentType": "application/json",
"description": "<p>Response</p>",
"example": null,
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {},
"additionalProperties": false
}
}
}
],
@@ -46517,6 +46553,7 @@
"contentType": "application/json",
"description": "Example",
"acceptHeader": "application/vnd.github.v3+json",
"bodyParameters": null,
"parameters": {
"owner": "OWNER",
"repo": "REPO",
@@ -413902,7 +413939,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
@@ -439415,7 +439451,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,

892
lib/rest/static/decorated/ghes-3.6.json
View File

File diff suppressed because it is too large Load Diff

820
lib/rest/static/decorated/github.ae.json
View File

File diff suppressed because it is too large Load Diff

1135
lib/rest/static/dereferenced/api.github.com.deref.json
View File

File diff suppressed because it is too large Load Diff

37
lib/rest/static/dereferenced/ghes-3.2.deref.json
View File

@@ -151323,10 +151323,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -152622,6 +152629,17 @@
"state",
"comment"
]
},
"examples": {
"default": {
"value": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
}
}
}
}
}
@@ -153379,6 +153397,11 @@
"object",
"null"
]
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -153389,10 +153412,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -153816,10 +153846,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}

39
lib/rest/static/dereferenced/ghes-3.3.deref.json
View File

@@ -136594,7 +136594,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
@@ -152744,10 +152743,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -154107,6 +154113,17 @@
"state",
"comment"
]
},
"examples": {
"default": {
"value": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
}
}
}
}
}
@@ -154864,6 +154881,11 @@
"object",
"null"
]
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -154874,10 +154896,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -155301,10 +155330,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -248113,7 +248149,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,

39
lib/rest/static/dereferenced/ghes-3.4.deref.json
View File

@@ -146804,7 +146804,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
@@ -163880,10 +163879,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -165243,6 +165249,17 @@
"state",
"comment"
]
},
"examples": {
"default": {
"value": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
}
}
}
}
}
@@ -166000,6 +166017,11 @@
"object",
"null"
]
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -166010,10 +166032,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -166437,10 +166466,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -264654,7 +264690,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,

49
lib/rest/static/dereferenced/ghes-3.5.deref.json
View File

@@ -149061,7 +149061,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,
@@ -151141,6 +151140,11 @@
"object",
"null"
]
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -173273,10 +173277,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -174636,6 +174647,17 @@
"state",
"comment"
]
},
"examples": {
"default": {
"value": {
"environment_ids": [
161171787
],
"state": "approved",
"comment": "Ship it!"
}
}
}
}
}
@@ -175393,6 +175415,11 @@
"object",
"null"
]
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -175403,10 +175430,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -175470,6 +175504,11 @@
"object",
"null"
]
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -175914,10 +175953,17 @@
"content": {
"application/json": {
"schema": {
"title": "Empty Object",
"description": "An object without any properties.",
"type": "object",
"properties": {
},
"additionalProperties": false
},
"examples": {
"default": {
"value": null
}
}
}
}
@@ -274775,7 +274821,6 @@
"node_id": "MDc6TGljZW5zZW1pdA==",
"html_url": "https://github.com/licenses/mit"
},
"language": null,
"forks_count": 9,
"forks": 9,
"stargazers_count": 80,

888
lib/rest/static/dereferenced/ghes-3.6.deref.json
View File

File diff suppressed because it is too large Load Diff

804
lib/rest/static/dereferenced/github.ae.deref.json
View File

File diff suppressed because it is too large Load Diff