@octokit/openapi 18.1.0 → 18.2.0

package/generated/ghes-3.14.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "18.1.0",
+    "version": "18.2.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": {
@@ -18639,6 +18639,15 @@
           {
             "$ref": "#/components/parameters/labels"
           },
+          {
+            "name": "type",
+            "description": "Can be the name of an issue type.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "sort",
             "description": "What to sort results by.",
@@ -20976,6 +20985,9 @@
           },
           {
             "$ref": "#/components/parameters/personal-access-token-after"
+          },
+          {
+            "$ref": "#/components/parameters/personal-access-token-token-id"
           }
         ],
         "responses": {
@@ -21323,6 +21335,9 @@
           },
           {
             "$ref": "#/components/parameters/personal-access-token-after"
+          },
+          {
+            "$ref": "#/components/parameters/personal-access-token-token-id"
           }
         ],
         "responses": {
@@ -22055,7 +22070,7 @@
       },
       "patch": {
         "summary": "Create or update custom properties for an organization",
-        "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nTo use this endpoint, the authenticated user must be one of:\n  - An administrator for the organization.\n  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
+        "description": "Creates new or updates existing custom properties defined for an organization in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be one of:\n  - An administrator for the organization.\n  - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization.",
         "tags": [
           "orgs"
         ],
@@ -42127,7 +42142,7 @@
       },
       "post": {
         "summary": "Create a custom deployment protection rule on an environment",
-        "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
+        "description": "Enable a custom deployment protection rule for an environment.\n\nThe authenticated user must have admin or owner permissions to the repository to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-server@3.14/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/enterprise-server@3.14/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
         "tags": [
           "repos"
         ],
@@ -45375,6 +45390,15 @@
               "type": "string"
             }
           },
+          {
+            "name": "type",
+            "description": "Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "creator",
             "description": "The user that created the issue.",
@@ -45560,6 +45584,12 @@
                     "items": {
                       "type": "string"
                     }
+                  },
+                  "type": {
+                    "type": "string",
+                    "description": "The name of the issue type to associate with this issue.",
+                    "nullable": true,
+                    "example": "Epic"
                   }
                 },
                 "required": [
@@ -46415,6 +46445,12 @@
                     "items": {
                       "type": "string"
                     }
+                  },
+                  "type": {
+                    "type": "string",
+                    "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.",
+                    "nullable": true,
+                    "example": "Epic"
                   }
                 }
               },
@@ -94699,7 +94735,7 @@
           },
           "dependabot_secrets": {
             "type": "string",
-            "description": "The leve of permission to grant the access token to manage Dependabot secrets.",
+            "description": "The level of permission to grant the access token to manage Dependabot secrets.",
             "enum": [
               "read",
               "write"
@@ -96020,6 +96056,7 @@
           "id": {
             "description": "Unique identifier of the webhook delivery.",
             "type": "integer",
+            "format": "int64",
             "example": 42
           },
           "guid": {
@@ -96067,12 +96104,14 @@
           "installation_id": {
             "description": "The id of the GitHub App installation associated with this event.",
             "type": "integer",
+            "format": "int64",
             "example": 123,
             "nullable": true
           },
           "repository_id": {
             "description": "The id of the repository associated with this event.",
             "type": "integer",
+            "format": "int64",
             "example": 123,
             "nullable": true
           },
@@ -97847,12 +97886,12 @@
         "type": "object",
         "properties": {
           "id": {
-            "description": "The id of the runner.",
+            "description": "The ID of the runner.",
             "type": "integer",
             "example": 5
           },
           "runner_group_id": {
-            "description": "The id of the runner group.",
+            "description": "The ID of the runner group.",
             "type": "integer",
             "example": 1
           },
@@ -99516,6 +99555,66 @@
         ],
         "nullable": true
       },
+      "issue-type": {
+        "title": "Issue Type",
+        "description": "The type of issue.",
+        "type": "object",
+        "nullable": true,
+        "properties": {
+          "id": {
+            "type": "integer",
+            "description": "The unique identifier of the issue type."
+          },
+          "node_id": {
+            "type": "string",
+            "description": "The node identifier of the issue type."
+          },
+          "name": {
+            "type": "string",
+            "description": "The name of the issue type."
+          },
+          "description": {
+            "type": "string",
+            "description": "The description of the issue type.",
+            "nullable": true
+          },
+          "color": {
+            "type": "string",
+            "description": "The color of the issue type.",
+            "enum": [
+              "gray",
+              "blue",
+              "green",
+              "yellow",
+              "orange",
+              "red",
+              "pink",
+              "purple"
+            ],
+            "nullable": true
+          },
+          "created_at": {
+            "type": "string",
+            "description": "The time the issue type created.",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "description": "The time the issue type last updated.",
+            "format": "date-time"
+          },
+          "is_enabled": {
+            "type": "boolean",
+            "description": "The enabled state of the issue type."
+          }
+        },
+        "required": [
+          "id",
+          "node_id",
+          "name",
+          "description"
+        ]
+      },
       "nullable-integration": {
         "title": "GitHub app",
         "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.",
@@ -99938,6 +100037,9 @@
             "type": "string",
             "format": "uri"
           },
+          "type": {
+            "$ref": "#/components/schemas/issue-type"
+          },
           "repository": {
             "$ref": "#/components/schemas/repository"
           },
@@ -105668,6 +105770,16 @@
             "maxItems": 200,
             "nullable": true,
             "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values."
+          },
+          "values_editable_by": {
+            "type": "string",
+            "nullable": true,
+            "enum": [
+              "org_actors",
+              "org_and_repo_actors"
+            ],
+            "example": "org_actors",
+            "description": "Who can edit the values of the property"
           }
         },
         "required": [
@@ -117186,6 +117298,9 @@
             "type": "string",
             "format": "uri"
           },
+          "type": {
+            "$ref": "#/components/schemas/issue-type"
+          },
           "repository": {
             "$ref": "#/components/schemas/repository"
           },
@@ -122856,6 +122971,9 @@
             "type": "string",
             "format": "uri"
           },
+          "type": {
+            "$ref": "#/components/schemas/issue-type"
+          },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
           },
@@ -126103,6 +126221,33 @@
           }
         }
       },
+      "dismissal-request-code-scanning": {
+        "title": "Code scanning alert dismissal request data",
+        "description": "Code scanning alerts that have dismissal requests.",
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "The type of request",
+            "enum": [
+              "code_scanning_alert_dismissal"
+            ]
+          },
+          "data": {
+            "type": "array",
+            "description": "The data related to the code scanning alerts that have dismissal requests.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "alert_number": {
+                  "type": "string",
+                  "description": "The number of the alert to be dismissed"
+                }
+              }
+            }
+          }
+        }
+      },
       "exemption-request-secret-scanning-metadata": {
         "title": "Secret Scanning Push Protection Exemption Request Metadata",
         "description": "Metadata for a secret scanning push protection exemption request.",
@@ -126144,6 +126289,26 @@
           }
         }
       },
+      "dismissal-request-code-scanning-metadata": {
+        "title": "Code scanning alert dismissal request metadata",
+        "description": "Metadata for a code scanning alert dismissal request.",
+        "type": "object",
+        "properties": {
+          "alert_title": {
+            "type": "string",
+            "description": "The title of the code scanning alert"
+          },
+          "reason": {
+            "type": "string",
+            "description": "The reason for the dismissal request",
+            "enum": [
+              "false positive",
+              "won't fix",
+              "used in tests"
+            ]
+          }
+        }
+      },
       "exemption-response": {
         "title": "Exemption response",
         "description": "A response to an exemption request by a delegated bypasser.",
@@ -126214,7 +126379,8 @@
             "enum": [
               "push_ruleset_bypass",
               "secret_scanning",
-              "secret_scanning_closure"
+              "secret_scanning_closure",
+              "code_scanning_alert_dismissal"
             ]
           },
           "exemption_request_data": {
@@ -126227,6 +126393,9 @@
               },
               {
                 "$ref": "#/components/schemas/dismissal-request-secret-scanning"
+              },
+              {
+                "$ref": "#/components/schemas/dismissal-request-code-scanning"
               }
             ]
           },
@@ -126254,12 +126423,15 @@
             "type": "object",
             "description": "Metadata about the exemption request.",
             "nullable": true,
-            "oneOf": [
+            "anyOf": [
               {
                 "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata"
               },
               {
                 "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata"
+              },
+              {
+                "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata"
               }
             ]
           },
@@ -129206,6 +129378,9 @@
             "description": "Title of the issue",
             "type": "string"
           },
+          "type": {
+            "$ref": "#/components/schemas/issue-type"
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -130597,6 +130772,9 @@
             "description": "Title of the issue",
             "type": "string"
           },
+          "type": {
+            "$ref": "#/components/schemas/issue-type"
+          },
           "updated_at": {
             "type": "string",
             "format": "date-time"
@@ -154390,6 +154568,9 @@
                     "description": "Title of the issue",
                     "type": "string"
                   },
+                  "type": {
+                    "$ref": "#/components/schemas/issue-type"
+                  },
                   "updated_at": {
                     "type": "string",
                     "format": "date-time"
@@ -155972,6 +156153,9 @@
                     "description": "Title of the issue",
                     "type": "string"
                   },
+                  "type": {
+                    "$ref": "#/components/schemas/issue-type"
+                  },
                   "updated_at": {
                     "type": "string",
                     "format": "date-time"
@@ -157563,6 +157747,9 @@
                     "description": "Title of the issue",
                     "type": "string"
                   },
+                  "type": {
+                    "$ref": "#/components/schemas/issue-type"
+                  },
                   "updated_at": {
                     "type": "string",
                     "format": "date-time"
@@ -159188,6 +159375,9 @@
                     "description": "Title of the issue",
                     "type": "string"
                   },
+                  "type": {
+                    "$ref": "#/components/schemas/issue-type"
+                  },
                   "updated_at": {
                     "type": "string",
                     "format": "date-time"
@@ -160629,6 +160819,9 @@
                 "description": "Title of the issue",
                 "type": "string"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "updated_at": {
                 "type": "string",
                 "format": "date-time"
@@ -161891,6 +162084,9 @@
                 "description": "Title of the issue",
                 "type": "string"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "updated_at": {
                 "type": "string",
                 "format": "date-time"
@@ -163142,6 +163338,9 @@
                 "type": "string",
                 "format": "uri"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "title": {
                 "description": "Title of the issue",
                 "type": "string"
@@ -164390,6 +164589,9 @@
                 "type": "string",
                 "format": "uri"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "title": {
                 "description": "Title of the issue",
                 "type": "string"
@@ -165664,6 +165866,9 @@
                 "type": "string",
                 "format": "uri"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "title": {
                 "description": "Title of the issue",
                 "type": "string"
@@ -166906,6 +167111,9 @@
                 "description": "Title of the issue",
                 "type": "string"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "updated_at": {
                 "type": "string",
                 "format": "date-time"
@@ -169954,6 +170162,9 @@
                 "description": "Title of the issue",
                 "type": "string"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "updated_at": {
                 "type": "string",
                 "format": "date-time"
@@ -171360,6 +171571,9 @@
                     "type": "string"
                   }
                 }
+              },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
               }
             }
           },
@@ -172470,6 +172684,9 @@
                     "description": "Title of the issue",
                     "type": "string"
                   },
+                  "type": {
+                    "$ref": "#/components/schemas/issue-type"
+                  },
                   "updated_at": {
                     "type": "string",
                     "format": "date-time"
@@ -174440,6 +174657,9 @@
                 "description": "Title of the issue",
                 "type": "string"
               },
+              "type": {
+                "$ref": "#/components/schemas/issue-type"
+              },
               "updated_at": {
                 "type": "string",
                 "format": "date-time"
@@ -285340,6 +285560,20 @@
           "format": "date-time"
         }
       },
+      "personal-access-token-token-id": {
+        "name": "token_id",
+        "description": "The ID of the token",
+        "in": "query",
+        "required": false,
+        "schema": {
+          "type": "array",
+          "maxItems": 50,
+          "items": {
+            "type": "string"
+          },
+          "example": "token_id[]=1,token_id[]=2"
+        }
+      },
       "fine-grained-personal-access-token-id": {
         "name": "pat_id",
         "description": "The unique identifier of the fine-grained personal access token.",