Update OpenAPI Descriptions (github#18553)

Co-authored-by: Rachael Sewell <[email protected]>
dmvol81 · Apr 2, 2021 · 10fef4d · 10fef4d
1 parent 8042691
commit 10fef4d
Show file tree

Hide file tree

Showing 17 changed files with 2,439 additions and 827 deletions.
diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json
diff --git a/lib/rest/static/decorated/ghes-2.18.json b/lib/rest/static/decorated/ghes-2.18.json
diff --git a/lib/rest/static/decorated/ghes-2.19.json b/lib/rest/static/decorated/ghes-2.19.json
diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json
diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json
diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json
diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json
diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json
diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json
@@ -684,6 +684,16 @@
             }
           }
         ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "additionalProperties": false
+              }
+            }
+          }
+        },
         "responses": {
           "201": {
             "description": "Response",
@@ -67933,7 +67943,10 @@
                   "exclude": {
                     "type": "array",
                     "items": {
-                      "type": "string"
+                      "type": "string",
+                      "enum": [
+                        "repositories"
+                      ]
                     }
                   }
                 },
@@ -186769,7 +186782,11 @@
                         "type": "string",
                         "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`."
                       }
-                    }
+                    },
+                    "required": [
+                      "name",
+                      "email"
+                    ]
                   },
                   "committer": {
                     "type": "object",
@@ -188349,7 +188366,11 @@
                         "type": "string",
                         "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`."
                       }
-                    }
+                    },
+                    "required": [
+                      "name",
+                      "email"
+                    ]
                   }
                 },
                 "required": [
@@ -223899,18 +223920,65 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "object",
-                "properties": {
-                  "labels": {
+                "oneOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "labels": {
+                        "type": "array",
+                        "minItems": 1,
+                        "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.",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  },
+                  {
                     "type": "array",
-                    "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.",
+                    "minItems": 1,
                     "items": {
                       "type": "string"
                     }
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "labels": {
+                        "type": "array",
+                        "minItems": 1,
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "name": {
+                              "type": "string"
+                            }
+                          },
+                          "required": [
+                            "name"
+                          ]
+                        }
+                      }
+                    }
+                  },
+                  {
+                    "type": "array",
+                    "minItems": 1,
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ]
+                    }
+                  },
+                  {
+                    "type": "string"
                   }
-                },
-                "required": [
-                  "labels"
                 ]
               },
               "example": {
@@ -224148,16 +224216,62 @@
           "content": {
             "application/json": {
               "schema": {
-                "type": "object",
-                "properties": {
-                  "labels": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "labels": {
+                        "type": "array",
+                        "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.",
+                        "items": {
+                          "type": "string"
+                        }
+                      }
+                    }
+                  },
+                  {
                     "type": "array",
-                    "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.",
                     "items": {
                       "type": "string"
                     }
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "labels": {
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "name": {
+                              "type": "string"
+                            }
+                          },
+                          "required": [
+                            "name"
+                          ]
+                        }
+                      }
+                    }
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "type": "string"
+                        }
+                      },
+                      "required": [
+                        "name"
+                      ]
+                    }
+                  },
+                  {
+                    "type": "string"
                   }
-                }
+                ]
               },
               "example": {
                 "labels": [
@@ -228857,6 +228971,7 @@
                   },
                   "due_on": {
                     "type": "string",
+                    "format": "date-time",
                     "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`."
                   }
                 },
@@ -229653,6 +229768,7 @@
                   },
                   "due_on": {
                     "type": "string",
+                    "format": "date-time",
                     "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`."
                   }
                 }