WIP: schema updates

Author: Octokit Bot

cache/api.github.com.json

@@ -70467,11 +70467,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -163975,6 +163982,15 @@
         "required": true,
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "since-user": {
         "name": "since",
         "description": "A user ID. Only return users with an ID greater than this ID.",

cache/ghec.json

@@ -72212,11 +72212,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -166743,6 +166750,15 @@
         "required": true,
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "since-user": {
         "name": "since",
         "description": "A user ID. Only return users with an ID greater than this ID.",

cache/ghes-3.10.json

@@ -68197,11 +68197,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -155099,6 +155106,15 @@
         "required": true,
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "invitation-id": {
         "name": "invitation_id",
         "description": "The unique identifier of the invitation.",

cache/ghes-3.11.json

@@ -69750,11 +69750,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -157176,6 +157183,15 @@
         "required": true,
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "invitation-id": {
         "name": "invitation_id",
         "description": "The unique identifier of the invitation.",

cache/ghes-3.12.json

@@ -70607,11 +70607,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -158391,6 +158398,15 @@
         "required": true,
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "invitation-id": {
         "name": "invitation_id",
         "description": "The unique identifier of the invitation.",

cache/ghes-3.8.json

@@ -65912,11 +65912,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -151507,6 +151514,15 @@
         "description": "The unique identifier of the branch policy.",
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "invitation-id": {
         "name": "invitation_id",
         "description": "The unique identifier of the invitation.",

cache/ghes-3.9.json

@@ -67264,11 +67264,18 @@
             "type": "object",
             "properties": {
               "permission": {
+                "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.",
                 "type": "object",
                 "properties": {
                   "to": { "type": "string", "enum": ["write", "admin", "read"] }
                 },
                 "required": ["to"]
+              },
+              "role_name": {
+                "description": "The role assigned to the collaborator.",
+                "type": "object",
+                "properties": { "to": { "type": "string" } },
+                "required": ["to"]
               }
             }
           },
@@ -153692,6 +153699,15 @@
         "description": "The unique identifier of the branch policy.",
         "schema": { "type": "integer" }
       },
+      "git-ref-only": {
+        "name": "ref",
+        "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.",
+        "in": "path",
+        "required": true,
+        "example": "heads/feature-a",
+        "schema": { "type": "string" },
+        "x-multi-segment": true
+      },
       "invitation-id": {
         "name": "invitation_id",
         "description": "The unique identifier of the invitation.",

packages/openapi-webhooks-types-ghec/types.d.ts

@@ -23683,10 +23683,20 @@ export interface components {
       /** @enum {string} */
       action: "added";
       changes?: {
+        /**
+         * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain`
+         * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role
+         * assigned to the collaborator, use the `role_name` field instead, which will provide the full
+         * role name, including custom roles.
+         */
         permission?: {
           /** @enum {string} */
           to: "write" | "admin" | "read";
         };
+        /** @description The role assigned to the collaborator. */
+        role_name?: {
+          to: string;
+        };
       };
       enterprise?: components["schemas"]["enterprise-webhooks"];
       installation?: components["schemas"]["simple-installation"];

packages/openapi-webhooks-types-ghes-3.10/types.d.ts

@@ -22913,10 +22913,20 @@ export interface components {
       /** @enum {string} */
       action: "added";
       changes?: {
+        /**
+         * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain`
+         * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role
+         * assigned to the collaborator, use the `role_name` field instead, which will provide the full
+         * role name, including custom roles.
+         */
         permission?: {
           /** @enum {string} */
           to: "write" | "admin" | "read";
         };
+        /** @description The role assigned to the collaborator. */
+        role_name?: {
+          to: string;
+        };
       };
       enterprise?: components["schemas"]["enterprise-webhooks"];
       installation?: components["schemas"]["simple-installation"];

packages/openapi-webhooks-types-ghes-3.11/types.d.ts

@@ -22989,10 +22989,20 @@ export interface components {
       /** @enum {string} */
       action: "added";
       changes?: {
+        /**
+         * @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain`
+         * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role
+         * assigned to the collaborator, use the `role_name` field instead, which will provide the full
+         * role name, including custom roles.
+         */
         permission?: {
           /** @enum {string} */
           to: "write" | "admin" | "read";
         };
+        /** @description The role assigned to the collaborator. */
+        role_name?: {
+          to: string;
+        };
       };
       enterprise?: components["schemas"]["enterprise-webhooks"];
       installation?: components["schemas"]["simple-installation"];