Skip to content

Commit 10fef4d

Browse files
github-openapi-botrachmari
github-openapi-bot
and
rachmari
authored
Update OpenAPI Descriptions (#18553)
Co-authored-by: Rachael Sewell <rachmari@github.com>
1 parent 8042691 commit 10fef4d

17 files changed

Lines changed: 2439 additions & 827 deletions

‎lib/rest/static/decorated/api.github.com.json‎

Lines changed: 185 additions & 92 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.18.json‎

Lines changed: 177 additions & 90 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.19.json‎

Lines changed: 177 additions & 90 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.20.json‎

Lines changed: 177 additions & 90 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.21.json‎

Lines changed: 177 additions & 90 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-2.22.json‎

Lines changed: 177 additions & 90 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/ghes-3.0.json‎

Lines changed: 177 additions & 90 deletions
Large diffs are not rendered by default.

‎lib/rest/static/decorated/github.ae.json‎

Lines changed: 169 additions & 82 deletions
Large diffs are not rendered by default.

‎lib/rest/static/dereferenced/api.github.com.deref.json‎

Lines changed: 131 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -684,6 +684,16 @@
684684
}
685685
}
686686
],
687+
"requestBody": {
688+
"content": {
689+
"application/json": {
690+
"schema": {
691+
"type": "object",
692+
"additionalProperties": false
693+
}
694+
}
695+
}
696+
},
687697
"responses": {
688698
"201": {
689699
"description": "Response",
@@ -67933,7 +67943,10 @@
6793367943
"exclude": {
6793467944
"type": "array",
6793567945
"items": {
67936-
"type": "string"
67946+
"type": "string",
67947+
"enum": [
67948+
"repositories"
67949+
]
6793767950
}
6793867951
}
6793967952
},
@@ -186769,7 +186782,11 @@
186769186782
"type": "string",
186770186783
"description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
186771186784
}
186772-
}
186785+
},
186786+
"required": [
186787+
"name",
186788+
"email"
186789+
]
186773186790
},
186774186791
"committer": {
186775186792
"type": "object",
@@ -188349,7 +188366,11 @@
188349188366
"type": "string",
188350188367
"description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
188351188368
}
188352-
}
188369+
},
188370+
"required": [
188371+
"name",
188372+
"email"
188373+
]
188353188374
}
188354188375
},
188355188376
"required": [
@@ -223899,18 +223920,65 @@
223899223920
"content": {
223900223921
"application/json": {
223901223922
"schema": {
223902-
"type": "object",
223903-
"properties": {
223904-
"labels": {
223923+
"oneOf": [
223924+
{
223925+
"type": "object",
223926+
"properties": {
223927+
"labels": {
223928+
"type": "array",
223929+
"minItems": 1,
223930+
"description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.",
223931+
"items": {
223932+
"type": "string"
223933+
}
223934+
}
223935+
}
223936+
},
223937+
{
223905223938
"type": "array",
223906-
"description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.",
223939+
"minItems": 1,
223907223940
"items": {
223908223941
"type": "string"
223909223942
}
223943+
},
223944+
{
223945+
"type": "object",
223946+
"properties": {
223947+
"labels": {
223948+
"type": "array",
223949+
"minItems": 1,
223950+
"items": {
223951+
"type": "object",
223952+
"properties": {
223953+
"name": {
223954+
"type": "string"
223955+
}
223956+
},
223957+
"required": [
223958+
"name"
223959+
]
223960+
}
223961+
}
223962+
}
223963+
},
223964+
{
223965+
"type": "array",
223966+
"minItems": 1,
223967+
"items": {
223968+
"type": "object",
223969+
"properties": {
223970+
"name": {
223971+
"type": "string"
223972+
}
223973+
},
223974+
"required": [
223975+
"name"
223976+
]
223977+
}
223978+
},
223979+
{
223980+
"type": "string"
223910223981
}
223911-
},
223912-
"required": [
223913-
"labels"
223914223982
]
223915223983
},
223916223984
"example": {
@@ -224148,16 +224216,62 @@
224148224216
"content": {
224149224217
"application/json": {
224150224218
"schema": {
224151-
"type": "object",
224152-
"properties": {
224153-
"labels": {
224219+
"anyOf": [
224220+
{
224221+
"type": "object",
224222+
"properties": {
224223+
"labels": {
224224+
"type": "array",
224225+
"description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.",
224226+
"items": {
224227+
"type": "string"
224228+
}
224229+
}
224230+
}
224231+
},
224232+
{
224154224233
"type": "array",
224155-
"description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.",
224156224234
"items": {
224157224235
"type": "string"
224158224236
}
224237+
},
224238+
{
224239+
"type": "object",
224240+
"properties": {
224241+
"labels": {
224242+
"type": "array",
224243+
"items": {
224244+
"type": "object",
224245+
"properties": {
224246+
"name": {
224247+
"type": "string"
224248+
}
224249+
},
224250+
"required": [
224251+
"name"
224252+
]
224253+
}
224254+
}
224255+
}
224256+
},
224257+
{
224258+
"type": "array",
224259+
"items": {
224260+
"type": "object",
224261+
"properties": {
224262+
"name": {
224263+
"type": "string"
224264+
}
224265+
},
224266+
"required": [
224267+
"name"
224268+
]
224269+
}
224270+
},
224271+
{
224272+
"type": "string"
224159224273
}
224160-
}
224274+
]
224161224275
},
224162224276
"example": {
224163224277
"labels": [
@@ -228857,6 +228971,7 @@
228857228971
},
228858228972
"due_on": {
228859228973
"type": "string",
228974+
"format": "date-time",
228860228975
"description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
228861228976
}
228862228977
},
@@ -229653,6 +229768,7 @@
229653229768
},
229654229769
"due_on": {
229655229770
"type": "string",
229771+
"format": "date-time",
229656229772
"description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`."
229657229773
}
229658229774
}

0 commit comments

Comments
 (0)