@octokit/openapi 6.2.1 → 6.4.0

package/generated/github.ae.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.4.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -6635,7 +6635,7 @@
                   "selected_repository_ids": {
                     "type": "array",
                     "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "items": { "type": "integer" }
                   }
                 },
                 "required": ["visibility"]
@@ -6646,7 +6646,7 @@
                     "encrypted_value": "c2VjcmV0",
                     "key_id": "012345678912345678",
                     "visibility": "selected",
-                    "selected_repository_ids": ["1296269", "1296280"]
+                    "selected_repository_ids": [1296269, 1296280]
                   }
                 }
               }
@@ -6671,7 +6671,9 @@
           "category": "actions",
           "subcategory": "secrets"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
       },
       "delete": {
         "summary": "Delete an organization secret",
@@ -13728,7 +13730,9 @@
           "category": "repos",
           "subcategory": "autolinks"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
       },
       "post": {
         "summary": "Create an autolink reference for a repository",
@@ -13756,7 +13760,7 @@
                   },
                   "url_template": {
                     "type": "string",
-                    "description": "The URL must contain <num> for the reference number."
+                    "description": "The URL must contain `<num>` for the reference number."
                   }
                 },
                 "required": ["key_prefix", "url_template"]
@@ -13798,7 +13802,9 @@
           "category": "repos",
           "subcategory": "autolinks"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
       }
     },
     "/repos/{owner}/{repo}/autolinks/{autolink_id}": {
@@ -13836,7 +13842,9 @@
           "category": "repos",
           "subcategory": "autolinks"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": { "api.github.com.json": { "type": "changed" } }
+        }
       },
       "delete": {
         "summary": "Delete an autolink reference from a repository",
@@ -17161,7 +17169,6 @@
           "200": {
             "description": "Response",
             "content": {
-              "application/json+sarif": { "schema": { "type": "string" } },
               "application/json": {
                 "schema": {
                   "$ref": "#/components/schemas/code-scanning-analysis"
@@ -17171,6 +17178,14 @@
                     "$ref": "#/components/examples/code-scanning-analysis-default"
                   }
                 }
+              },
+              "application/json+sarif": {
+                "schema": { "type": "object", "additionalProperties": true },
+                "examples": {
+                  "response": {
+                    "$ref": "#/components/examples/code-scanning-analysis-sarif"
+                  }
+                }
               }
             }
           },
@@ -17290,6 +17305,15 @@
                   }
                 },
                 "required": ["commit_sha", "ref", "sarif"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
+                    "ref": "refs/heads/master",
+                    "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
+                  }
+                }
               }
             }
           }
@@ -19705,7 +19729,7 @@
                     }
                   },
                   "deployment_branch_policy": {
-                    "$ref": "#/components/schemas/deployment_branch_policy"
+                    "$ref": "#/components/schemas/deployment-branch-policy"
                   }
                 },
                 "additionalProperties": false
@@ -22470,7 +22494,7 @@
         "operationId": "issues/remove-assignees",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/github-ae@latest/rest/reference/issues#remove-assignees-from-an-issue"
+          "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
         },
         "parameters": [
           { "$ref": "#/components/parameters/owner" },
@@ -22478,6 +22502,7 @@
           { "$ref": "#/components/parameters/issue-number" }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -22488,7 +22513,8 @@
                     "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
                     "items": { "type": "string" }
                   }
-                }
+                },
+                "required": ["assignees"]
               },
               "examples": {
                 "default": { "value": { "assignees": ["hubot", "other_user"] } }
@@ -34124,52 +34150,6 @@
         "x-octokit": {}
       }
     },
-    "/repos/{owner}/{repo}/community/code_of_conduct": {
-      "get": {
-        "summary": "Get the code of conduct for a repository",
-        "description": "Returns the contents of the repository's code of conduct file, if one is detected.\n\nA code of conduct is detected if there is a file named `CODE_OF_CONDUCT` in the root directory of the repository. GitHub detects which code of conduct it is using fuzzy matching.",
-        "tags": ["codes-of-conduct"],
-        "operationId": "codes-of-conduct/get-for-repo",
-        "externalDocs": {
-          "description": "API method documentation",
-          "url": "https://docs.github.com/rest/reference/codes-of-conduct#get-the-code-of-conduct-for-a-repository"
-        },
-        "parameters": [
-          { "$ref": "#/components/parameters/owner" },
-          { "$ref": "#/components/parameters/repo" }
-        ],
-        "responses": {
-          "200": {
-            "description": "Response",
-            "content": {
-              "application/json": {
-                "schema": { "$ref": "#/components/schemas/code-of-conduct" },
-                "examples": {
-                  "default": { "$ref": "#/components/examples/code-of-conduct" }
-                }
-              }
-            }
-          }
-        },
-        "x-github": {
-          "githubCloudOnly": false,
-          "enabledForGitHubApps": true,
-          "previews": [
-            {
-              "required": true,
-              "name": "scarlet-witch",
-              "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```"
-            }
-          ],
-          "category": "codes-of-conduct",
-          "subcategory": null,
-          "removalDate": "2021-09-29",
-          "deprecationDate": "2021-09-29"
-        },
-        "deprecated": true,
-        "x-octokit": {}
-      }
-    },
     "/applications/grants": {
       "get": {
         "summary": "List your grants",
@@ -34706,20 +34686,6 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
-    "/orgs/{org_id}/codespaces": {
-      "get": {
-        "summary": "List codespaces for the organization",
-        "description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
-        "tags": ["codespaces"],
-        "operationId": "codespaces/list-in-organization",
-        "externalDocs": {
-          "description": "API method documentation",
-          "url": "https://docs.github.com/rest/reference/codespaces#list-in-organization"
-        },
-        "x-octokit": { "api.github.com.json": "removed" },
-        "responses": { "501": { "description": "Not Implemented" } }
-      }
-    },
     "/orgs/{org}/actions/cache/usage": {
       "get": {
         "summary": "Get GitHub Actions cache usage for an organization",
@@ -35008,6 +34974,20 @@
         "responses": { "501": { "description": "Not Implemented" } }
       }
     },
+    "/orgs/{org}/codespaces": {
+      "get": {
+        "summary": "List codespaces for the organization",
+        "description": "This endpoint does not exist github.ae.json. It was added in api.github.com.json",
+        "tags": ["codespaces"],
+        "operationId": "codespaces/list-in-organization",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/codespaces#list-in-organization"
+        },
+        "x-octokit": { "api.github.com.json": "removed" },
+        "responses": { "501": { "description": "Not Implemented" } }
+      }
+    },
     "/orgs/{org}/credential-authorizations": {
       "get": {
         "summary": "List SAML SSO authorizations for an organization",
@@ -40357,7 +40337,7 @@
           "truncated": { "type": "boolean" }
         }
       },
-      "author_association": {
+      "author-association": {
         "title": "author_association",
         "type": "string",
         "example": "OWNER",
@@ -40406,7 +40386,7 @@
             "example": "2011-04-18T23:23:56Z"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -40814,7 +40794,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -44442,7 +44422,7 @@
         },
         "required": ["enabled"]
       },
-      "referenced_workflow": {
+      "referenced-workflow": {
         "title": "Referenced workflow",
         "description": "A workflow referenced/reused by the initial caller workflow",
         "type": "object",
@@ -44590,7 +44570,7 @@
           "referenced_workflows": {
             "type": "array",
             "nullable": true,
-            "items": { "$ref": "#/components/schemas/referenced_workflow" }
+            "items": { "$ref": "#/components/schemas/referenced-workflow" }
           },
           "event": { "type": "string", "example": "push" },
           "status": {
@@ -46824,7 +46804,7 @@
           "created_at": { "type": "string", "format": "date-time" },
           "updated_at": { "type": "string", "format": "date-time" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -46869,7 +46849,7 @@
         "properties": { "href": { "type": "string" } },
         "required": ["href"]
       },
-      "auto_merge": {
+      "auto-merge": {
         "title": "Auto merge",
         "description": "The status of auto merging a pull request.",
         "type": "object",
@@ -47085,9 +47065,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -47886,7 +47866,7 @@
         "enum": ["User", "Team"],
         "example": "User"
       },
-      "deployment_branch_policy": {
+      "deployment-branch-policy": {
         "type": "object",
         "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
         "properties": {
@@ -48007,7 +47987,7 @@
             }
           },
           "deployment_branch_policy": {
-            "$ref": "#/components/schemas/deployment_branch_policy"
+            "$ref": "#/components/schemas/deployment-branch-policy"
           }
         },
         "required": [
@@ -48072,7 +48052,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -48652,7 +48632,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -48782,7 +48762,7 @@
           },
           "rename": { "$ref": "#/components/schemas/issue-event-rename" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "lock_reason": { "type": "string", "nullable": true },
           "performed_via_github_app": {
@@ -49485,7 +49465,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -49700,7 +49680,7 @@
           "body_html": { "type": "string" },
           "body_text": { "type": "string" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -49807,7 +49787,7 @@
             "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "_links": {
             "type": "object",
@@ -51250,9 +51230,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -51407,7 +51387,7 @@
           "body_html": { "type": "string" },
           "body_text": { "type": "string" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -51482,7 +51462,7 @@
             "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "_links": {
             "type": "object",
@@ -52174,7 +52154,7 @@
           "body": { "type": "string" },
           "score": { "type": "number" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "draft": { "type": "boolean" },
           "repository": { "$ref": "#/components/schemas/repository" },
@@ -62684,7 +62664,7 @@
         ]
       },
       "code-scanning-analysis-default": {
-        "summary": "Default response",
+        "summary": "application/json response",
         "value": {
           "ref": "refs/heads/main",
           "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -62703,6 +62683,49 @@
           "warning": ""
         }
       },
+      "code-scanning-analysis-sarif": {
+        "summary": "application/json+sarif response",
+        "value": {
+          "runs": [
+            {
+              "tool": {
+                "driver": {
+                  "name": "CodeQL",
+                  "organization": "GitHub",
+                  "semanticVersion": "1.0.0",
+                  "rules": [
+                    {
+                      "id": "js/unused-local-variable",
+                      "name": "js/unused-local-variable"
+                    }
+                  ]
+                }
+              },
+              "results": [
+                {
+                  "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
+                  "message": { "text": "Unused variable foo." },
+                  "locations": [
+                    {
+                      "physicalLocation": {
+                        "artifactLocation": { "uri": "file1.js" },
+                        "region": { "startLine": 1 }
+                      }
+                    }
+                  ],
+                  "ruleId": "js/unused-local-variable",
+                  "properties": [
+                    { "github/alertNumber": 2 },
+                    {
+                      "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      },
       "code-scanning-analysis-deletion": {
         "summary": "Default response",
         "value": {

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.2.1",
+  "version": "6.4.0",
   "description": "GitHub's official OpenAPI spec with Octokit extensions",
   "main": "index.js",
   "files": [