Skip to content

Commit 5050ffc

Browse files
docs-botsubatoi
docs-bot
and
subatoi
authored
Update OpenAPI Description (#60719)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent 3bdccc3 commit 5050ffc

14 files changed

Lines changed: 1125 additions & 25 deletions

File tree

‎src/github-apps/lib/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "36e6d2087a74bda6b56e450420eee3427798bc75"
63+
"sha": "3ba1e7273bb94c613cf608640e4a7a860310669b"
6464
}

‎src/rest/data/fpt-2022-11-28/commits.json‎

Lines changed: 102 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4545,7 +4545,7 @@
45454545
"codeExamples": [
45464546
{
45474547
"request": {
4548-
"description": "Example",
4548+
"description": "Example 1: Status Code 200",
45494549
"acceptHeader": "application/vnd.github.v3+json",
45504550
"parameters": {
45514551
"owner": "OWNER",
@@ -5172,6 +5172,66 @@
51725172
]
51735173
}
51745174
}
5175+
},
5176+
{
5177+
"request": {
5178+
"description": "Example 2: Status Code 200",
5179+
"acceptHeader": "application/vnd.github.v3+json",
5180+
"parameters": {
5181+
"owner": "OWNER",
5182+
"repo": "REPO",
5183+
"ref": "REF"
5184+
}
5185+
},
5186+
"response": {
5187+
"statusCode": "200",
5188+
"contentType": "application/vnd.github.diff",
5189+
"description": "<p>Response</p>",
5190+
"example": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
5191+
"schema": {
5192+
"type": "string"
5193+
}
5194+
}
5195+
},
5196+
{
5197+
"request": {
5198+
"description": "Example 3: Status Code 200",
5199+
"acceptHeader": "application/vnd.github.v3+json",
5200+
"parameters": {
5201+
"owner": "OWNER",
5202+
"repo": "REPO",
5203+
"ref": "REF"
5204+
}
5205+
},
5206+
"response": {
5207+
"statusCode": "200",
5208+
"contentType": "application/vnd.github.patch",
5209+
"description": "<p>Response</p>",
5210+
"example": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
5211+
"schema": {
5212+
"type": "string"
5213+
}
5214+
}
5215+
},
5216+
{
5217+
"request": {
5218+
"description": "Example 4: Status Code 200",
5219+
"acceptHeader": "application/vnd.github.v3+json",
5220+
"parameters": {
5221+
"owner": "OWNER",
5222+
"repo": "REPO",
5223+
"ref": "REF"
5224+
}
5225+
},
5226+
"response": {
5227+
"statusCode": "200",
5228+
"contentType": "application/vnd.github.sha",
5229+
"description": "<p>Response</p>",
5230+
"example": "ac3282a2725be3b1d4979169a7a311c89066af1c",
5231+
"schema": {
5232+
"type": "string"
5233+
}
5234+
}
51755235
}
51765236
],
51775237
"statusCodes": [
@@ -5272,7 +5332,7 @@
52725332
"codeExamples": [
52735333
{
52745334
"request": {
5275-
"description": "Example",
5335+
"description": "Example 1: Status Code 200",
52765336
"acceptHeader": "application/vnd.github.v3+json",
52775337
"parameters": {
52785338
"owner": "OWNER",
@@ -7234,6 +7294,46 @@
72347294
]
72357295
}
72367296
}
7297+
},
7298+
{
7299+
"request": {
7300+
"description": "Example 2: Status Code 200",
7301+
"acceptHeader": "application/vnd.github.v3+json",
7302+
"parameters": {
7303+
"owner": "OWNER",
7304+
"repo": "REPO",
7305+
"basehead": "BASEHEAD"
7306+
}
7307+
},
7308+
"response": {
7309+
"statusCode": "200",
7310+
"contentType": "application/vnd.github.diff",
7311+
"description": "<p>Response</p>",
7312+
"example": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
7313+
"schema": {
7314+
"type": "string"
7315+
}
7316+
}
7317+
},
7318+
{
7319+
"request": {
7320+
"description": "Example 3: Status Code 200",
7321+
"acceptHeader": "application/vnd.github.v3+json",
7322+
"parameters": {
7323+
"owner": "OWNER",
7324+
"repo": "REPO",
7325+
"basehead": "BASEHEAD"
7326+
}
7327+
},
7328+
"response": {
7329+
"statusCode": "200",
7330+
"contentType": "application/vnd.github.patch",
7331+
"description": "<p>Response</p>",
7332+
"example": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
7333+
"schema": {
7334+
"type": "string"
7335+
}
7336+
}
72377337
}
72387338
],
72397339
"statusCodes": [

‎src/rest/data/fpt-2026-03-10/commits.json‎

Lines changed: 102 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4387,7 +4387,7 @@
43874387
"codeExamples": [
43884388
{
43894389
"request": {
4390-
"description": "Example",
4390+
"description": "Example 1: Status Code 200",
43914391
"acceptHeader": "application/vnd.github.v3+json",
43924392
"parameters": {
43934393
"owner": "OWNER",
@@ -5014,6 +5014,66 @@
50145014
]
50155015
}
50165016
}
5017+
},
5018+
{
5019+
"request": {
5020+
"description": "Example 2: Status Code 200",
5021+
"acceptHeader": "application/vnd.github.v3+json",
5022+
"parameters": {
5023+
"owner": "OWNER",
5024+
"repo": "REPO",
5025+
"ref": "REF"
5026+
}
5027+
},
5028+
"response": {
5029+
"statusCode": "200",
5030+
"contentType": "application/vnd.github.diff",
5031+
"description": "<p>Response</p>",
5032+
"example": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
5033+
"schema": {
5034+
"type": "string"
5035+
}
5036+
}
5037+
},
5038+
{
5039+
"request": {
5040+
"description": "Example 3: Status Code 200",
5041+
"acceptHeader": "application/vnd.github.v3+json",
5042+
"parameters": {
5043+
"owner": "OWNER",
5044+
"repo": "REPO",
5045+
"ref": "REF"
5046+
}
5047+
},
5048+
"response": {
5049+
"statusCode": "200",
5050+
"contentType": "application/vnd.github.patch",
5051+
"description": "<p>Response</p>",
5052+
"example": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
5053+
"schema": {
5054+
"type": "string"
5055+
}
5056+
}
5057+
},
5058+
{
5059+
"request": {
5060+
"description": "Example 4: Status Code 200",
5061+
"acceptHeader": "application/vnd.github.v3+json",
5062+
"parameters": {
5063+
"owner": "OWNER",
5064+
"repo": "REPO",
5065+
"ref": "REF"
5066+
}
5067+
},
5068+
"response": {
5069+
"statusCode": "200",
5070+
"contentType": "application/vnd.github.sha",
5071+
"description": "<p>Response</p>",
5072+
"example": "ac3282a2725be3b1d4979169a7a311c89066af1c",
5073+
"schema": {
5074+
"type": "string"
5075+
}
5076+
}
50175077
}
50185078
],
50195079
"statusCodes": [
@@ -5114,7 +5174,7 @@
51145174
"codeExamples": [
51155175
{
51165176
"request": {
5117-
"description": "Example",
5177+
"description": "Example 1: Status Code 200",
51185178
"acceptHeader": "application/vnd.github.v3+json",
51195179
"parameters": {
51205180
"owner": "OWNER",
@@ -7076,6 +7136,46 @@
70767136
]
70777137
}
70787138
}
7139+
},
7140+
{
7141+
"request": {
7142+
"description": "Example 2: Status Code 200",
7143+
"acceptHeader": "application/vnd.github.v3+json",
7144+
"parameters": {
7145+
"owner": "OWNER",
7146+
"repo": "REPO",
7147+
"basehead": "BASEHEAD"
7148+
}
7149+
},
7150+
"response": {
7151+
"statusCode": "200",
7152+
"contentType": "application/vnd.github.diff",
7153+
"description": "<p>Response</p>",
7154+
"example": "diff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
7155+
"schema": {
7156+
"type": "string"
7157+
}
7158+
}
7159+
},
7160+
{
7161+
"request": {
7162+
"description": "Example 3: Status Code 200",
7163+
"acceptHeader": "application/vnd.github.v3+json",
7164+
"parameters": {
7165+
"owner": "OWNER",
7166+
"repo": "REPO",
7167+
"basehead": "BASEHEAD"
7168+
}
7169+
},
7170+
"response": {
7171+
"statusCode": "200",
7172+
"contentType": "application/vnd.github.patch",
7173+
"description": "<p>Response</p>",
7174+
"example": "From ac3282a2725be3b1d4979169a7a311c89066af1c Mon Sep 17 00:00:00 2001\nFrom: Mona Lisa <87831417+monalisa@users.noreply.github.com>\nDate: Fri, 6 Mar 2026 11:18:45 +0000\nSubject: [PATCH] Change 'test' to 'test change' in testfile\n\n---\ntestfile | 2 +-\n1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/testfile b/testfile\nindex 9bdeaeb..912c7ef 100644\n--- a/testfile\n+++ b/testfile\n@@ -1 +1 @@\n-test\n+test change\n",
7175+
"schema": {
7176+
"type": "string"
7177+
}
7178+
}
70797179
}
70807180
],
70817181
"statusCodes": [

0 commit comments

Comments
 (0)