Merge pull request #4529 from github/openapi-update-a0e238483d75d8669…

…7819278ffc2715c10bb35507831ad868774772d7620199e Update OpenAPI 3.0 Descriptions
github · Feb 13, 2025 · 0fbb23b · 0fbb23b
2 parents a06f88d + 33dcf02
commit 0fbb23b
Show file tree

Hide file tree

Showing 16 changed files with 156 additions and 188 deletions.
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json
@@ -103036,8 +103036,8 @@
           "key"
         ]
       },
-      "copilot-seat-breakdown": {
-        "title": "Copilot Business Seat Breakdown",
+      "copilot-organization-seat-breakdown": {
+        "title": "Copilot Seat Breakdown",
         "description": "The breakdown of Copilot Business seats for the organization.",
         "type": "object",
         "properties": {
@@ -103055,7 +103055,7 @@
           },
           "pending_invitation": {
             "type": "integer",
-            "description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
+            "description": "The number of users who have been invited to receive a Copilot seat through this organization."
           },
           "active_this_cycle": {
             "type": "integer",
@@ -103073,21 +103073,20 @@
         "type": "object",
         "properties": {
           "seat_breakdown": {
-            "$ref": "#/components/schemas/copilot-seat-breakdown"
+            "$ref": "#/components/schemas/copilot-organization-seat-breakdown"
           },
           "public_code_suggestions": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
+            "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
             "enum": [
               "allow",
               "block",
-              "unconfigured",
-              "unknown"
+              "unconfigured"
             ]
           },
           "ide_chat": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
+            "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
             "enum": [
               "enabled",
               "disabled",
@@ -103096,7 +103095,7 @@
           },
           "platform_chat": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
+            "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
             "enum": [
               "enabled",
               "disabled",
@@ -103105,7 +103104,7 @@
           },
           "cli": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
+            "description": "The organization policy for allowing or disallowing Copilot in the CLI.",
             "enum": [
               "enabled",
               "disabled",
@@ -103127,8 +103126,7 @@
             "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
             "enum": [
               "business",
-              "enterprise",
-              "unknown"
+              "enterprise"
             ]
           }
         },

diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -75189,8 +75189,8 @@ components:
       required:
       - key_id
       - key
-    copilot-seat-breakdown:
-      title: Copilot Business Seat Breakdown
+    copilot-organization-seat-breakdown:
+      title: Copilot Seat Breakdown
       description: The breakdown of Copilot Business seats for the organization.
       type: object
       properties:
@@ -75207,8 +75207,8 @@ components:
             of the current billing cycle.
         pending_invitation:
           type: integer
-          description: The number of seats that have been assigned to users that have
-            not yet accepted an invitation to this organization.
+          description: The number of users who have been invited to receive a Copilot
+            seat through this organization.
         active_this_cycle:
           type: integer
           description: The number of seats that have used Copilot during the current
@@ -75224,36 +75224,35 @@ components:
       type: object
       properties:
         seat_breakdown:
-          "$ref": "#/components/schemas/copilot-seat-breakdown"
+          "$ref": "#/components/schemas/copilot-organization-seat-breakdown"
         public_code_suggestions:
           type: string
-          description: The organization policy for allowing or disallowing Copilot
-            to make suggestions that match public code.
+          description: The organization policy for allowing or blocking suggestions
+            matching public code (duplication detection filter).
           enum:
           - allow
           - block
           - unconfigured
-          - unknown
         ide_chat:
           type: string
-          description: The organization policy for allowing or disallowing organization
-            members to use Copilot Chat within their editor.
+          description: The organization policy for allowing or disallowing Copilot
+            Chat in the IDE.
           enum:
           - enabled
           - disabled
           - unconfigured
         platform_chat:
           type: string
-          description: The organization policy for allowing or disallowing organization
-            members to use Copilot features within github.com.
+          description: The organization policy for allowing or disallowing Copilot
+            features on GitHub.com.
           enum:
           - enabled
           - disabled
           - unconfigured
         cli:
           type: string
-          description: The organization policy for allowing or disallowing organization
-            members to use Copilot within their CLI.
+          description: The organization policy for allowing or disallowing Copilot
+            in the CLI.
           enum:
           - enabled
           - disabled
@@ -75273,7 +75272,6 @@ components:
           enum:
           - business
           - enterprise
-          - unknown
       required:
       - seat_breakdown
       - public_code_suggestions

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -103036,8 +103036,8 @@
           "key"
         ]
       },
-      "copilot-seat-breakdown": {
-        "title": "Copilot Business Seat Breakdown",
+      "copilot-organization-seat-breakdown": {
+        "title": "Copilot Seat Breakdown",
         "description": "The breakdown of Copilot Business seats for the organization.",
         "type": "object",
         "properties": {
@@ -103055,7 +103055,7 @@
           },
           "pending_invitation": {
             "type": "integer",
-            "description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
+            "description": "The number of users who have been invited to receive a Copilot seat through this organization."
           },
           "active_this_cycle": {
             "type": "integer",
@@ -103073,21 +103073,20 @@
         "type": "object",
         "properties": {
           "seat_breakdown": {
-            "$ref": "#/components/schemas/copilot-seat-breakdown"
+            "$ref": "#/components/schemas/copilot-organization-seat-breakdown"
           },
           "public_code_suggestions": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
+            "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
             "enum": [
               "allow",
               "block",
-              "unconfigured",
-              "unknown"
+              "unconfigured"
             ]
           },
           "ide_chat": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
+            "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
             "enum": [
               "enabled",
               "disabled",
@@ -103096,7 +103095,7 @@
           },
           "platform_chat": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
+            "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
             "enum": [
               "enabled",
               "disabled",
@@ -103105,7 +103104,7 @@
           },
           "cli": {
             "type": "string",
-            "description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
+            "description": "The organization policy for allowing or disallowing Copilot in the CLI.",
             "enum": [
               "enabled",
               "disabled",
@@ -103127,8 +103126,7 @@
             "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
             "enum": [
               "business",
-              "enterprise",
-              "unknown"
+              "enterprise"
             ]
           }
         },

diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
@@ -75189,8 +75189,8 @@ components:
       required:
       - key_id
       - key
-    copilot-seat-breakdown:
-      title: Copilot Business Seat Breakdown
+    copilot-organization-seat-breakdown:
+      title: Copilot Seat Breakdown
       description: The breakdown of Copilot Business seats for the organization.
       type: object
       properties:
@@ -75207,8 +75207,8 @@ components:
             of the current billing cycle.
         pending_invitation:
           type: integer
-          description: The number of seats that have been assigned to users that have
-            not yet accepted an invitation to this organization.
+          description: The number of users who have been invited to receive a Copilot
+            seat through this organization.
         active_this_cycle:
           type: integer
           description: The number of seats that have used Copilot during the current
@@ -75224,36 +75224,35 @@ components:
       type: object
       properties:
         seat_breakdown:
-          "$ref": "#/components/schemas/copilot-seat-breakdown"
+          "$ref": "#/components/schemas/copilot-organization-seat-breakdown"
         public_code_suggestions:
           type: string
-          description: The organization policy for allowing or disallowing Copilot
-            to make suggestions that match public code.
+          description: The organization policy for allowing or blocking suggestions
+            matching public code (duplication detection filter).
           enum:
           - allow
           - block
           - unconfigured
-          - unknown
         ide_chat:
           type: string
-          description: The organization policy for allowing or disallowing organization
-            members to use Copilot Chat within their editor.
+          description: The organization policy for allowing or disallowing Copilot
+            Chat in the IDE.
           enum:
           - enabled
           - disabled
           - unconfigured
         platform_chat:
           type: string
-          description: The organization policy for allowing or disallowing organization
-            members to use Copilot features within github.com.
+          description: The organization policy for allowing or disallowing Copilot
+            features on GitHub.com.
           enum:
           - enabled
           - disabled
           - unconfigured
         cli:
           type: string
-          description: The organization policy for allowing or disallowing organization
-            members to use Copilot within their CLI.
+          description: The organization policy for allowing or disallowing Copilot
+            in the CLI.
           enum:
           - enabled
           - disabled
@@ -75273,7 +75272,6 @@ components:
           enum:
           - business
           - enterprise
-          - unknown
       required:
       - seat_breakdown
       - public_code_suggestions

diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json
@@ -74279,7 +74279,7 @@
                   "type": "object",
                   "properties": {
                     "seat_breakdown": {
-                      "title": "Copilot Business Seat Breakdown",
+                      "title": "Copilot Seat Breakdown",
                       "description": "The breakdown of Copilot Business seats for the organization.",
                       "type": "object",
                       "properties": {
@@ -74297,7 +74297,7 @@
                         },
                         "pending_invitation": {
                           "type": "integer",
-                          "description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
+                          "description": "The number of users who have been invited to receive a Copilot seat through this organization."
                         },
                         "active_this_cycle": {
                           "type": "integer",
@@ -74311,17 +74311,16 @@
                     },
                     "public_code_suggestions": {
                       "type": "string",
-                      "description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
+                      "description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
                       "enum": [
                         "allow",
                         "block",
-                        "unconfigured",
-                        "unknown"
+                        "unconfigured"
                       ]
                     },
                     "ide_chat": {
                       "type": "string",
-                      "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
+                      "description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
                       "enum": [
                         "enabled",
                         "disabled",
@@ -74330,7 +74329,7 @@
                     },
                     "platform_chat": {
                       "type": "string",
-                      "description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
+                      "description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
                       "enum": [
                         "enabled",
                         "disabled",
@@ -74339,7 +74338,7 @@
                     },
                     "cli": {
                       "type": "string",
-                      "description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
+                      "description": "The organization policy for allowing or disallowing Copilot in the CLI.",
                       "enum": [
                         "enabled",
                         "disabled",
@@ -74361,8 +74360,7 @@
                       "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
                       "enum": [
                         "business",
-                        "enterprise",
-                        "unknown"
+                        "enterprise"
                       ]
                     }
                   },