Skip to content

Commit 29b8ca3

Browse files
beccobecco
authored
Merge pull request #4530 from github/openapi-update-d725ae3dca795489747f86f7805bb55a4d4f85213d2f834f33b5a8c004296952
Update OpenAPI 3.1 Descriptions
2 parents 0fbb23b + f889dae commit 29b8ca3

16 files changed

+156
-188
lines changed

‎descriptions-next/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104808,8 +104808,8 @@
104808104808
"key"
104809104809
]
104810104810
},
104811-
"copilot-seat-breakdown": {
104812-
"title": "Copilot Business Seat Breakdown",
104811+
"copilot-organization-seat-breakdown": {
104812+
"title": "Copilot Seat Breakdown",
104813104813
"description": "The breakdown of Copilot Business seats for the organization.",
104814104814
"type": "object",
104815104815
"properties": {
@@ -104827,7 +104827,7 @@
104827104827
},
104828104828
"pending_invitation": {
104829104829
"type": "integer",
104830-
"description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
104830+
"description": "The number of users who have been invited to receive a Copilot seat through this organization."
104831104831
},
104832104832
"active_this_cycle": {
104833104833
"type": "integer",
@@ -104845,21 +104845,20 @@
104845104845
"type": "object",
104846104846
"properties": {
104847104847
"seat_breakdown": {
104848-
"$ref": "#/components/schemas/copilot-seat-breakdown"
104848+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
104849104849
},
104850104850
"public_code_suggestions": {
104851104851
"type": "string",
104852-
"description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
104852+
"description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
104853104853
"enum": [
104854104854
"allow",
104855104855
"block",
104856-
"unconfigured",
104857-
"unknown"
104856+
"unconfigured"
104858104857
]
104859104858
},
104860104859
"ide_chat": {
104861104860
"type": "string",
104862-
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
104861+
"description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
104863104862
"enum": [
104864104863
"enabled",
104865104864
"disabled",
@@ -104868,7 +104867,7 @@
104868104867
},
104869104868
"platform_chat": {
104870104869
"type": "string",
104871-
"description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
104870+
"description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
104872104871
"enum": [
104873104872
"enabled",
104874104873
"disabled",
@@ -104877,7 +104876,7 @@
104877104876
},
104878104877
"cli": {
104879104878
"type": "string",
104880-
"description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
104879+
"description": "The organization policy for allowing or disallowing Copilot in the CLI.",
104881104880
"enum": [
104882104881
"enabled",
104883104882
"disabled",
@@ -104899,8 +104898,7 @@
104899104898
"description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
104900104899
"enum": [
104901104900
"business",
104902-
"enterprise",
104903-
"unknown"
104901+
"enterprise"
104904104902
]
104905104903
}
104906104904
},

‎descriptions-next/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75948,8 +75948,8 @@ components:
7594875948
required:
7594975949
- key_id
7595075950
- key
75951-
copilot-seat-breakdown:
75952-
title: Copilot Business Seat Breakdown
75951+
copilot-organization-seat-breakdown:
75952+
title: Copilot Seat Breakdown
7595375953
description: The breakdown of Copilot Business seats for the organization.
7595475954
type: object
7595575955
properties:
@@ -75966,8 +75966,8 @@ components:
7596675966
of the current billing cycle.
7596775967
pending_invitation:
7596875968
type: integer
75969-
description: The number of seats that have been assigned to users that have
75970-
not yet accepted an invitation to this organization.
75969+
description: The number of users who have been invited to receive a Copilot
75970+
seat through this organization.
7597175971
active_this_cycle:
7597275972
type: integer
7597375973
description: The number of seats that have used Copilot during the current
@@ -75983,36 +75983,35 @@ components:
7598375983
type: object
7598475984
properties:
7598575985
seat_breakdown:
75986-
"$ref": "#/components/schemas/copilot-seat-breakdown"
75986+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
7598775987
public_code_suggestions:
7598875988
type: string
75989-
description: The organization policy for allowing or disallowing Copilot
75990-
to make suggestions that match public code.
75989+
description: The organization policy for allowing or blocking suggestions
75990+
matching public code (duplication detection filter).
7599175991
enum:
7599275992
- allow
7599375993
- block
7599475994
- unconfigured
75995-
- unknown
7599675995
ide_chat:
7599775996
type: string
75998-
description: The organization policy for allowing or disallowing organization
75999-
members to use Copilot Chat within their editor.
75997+
description: The organization policy for allowing or disallowing Copilot
75998+
Chat in the IDE.
7600075999
enum:
7600176000
- enabled
7600276001
- disabled
7600376002
- unconfigured
7600476003
platform_chat:
7600576004
type: string
76006-
description: The organization policy for allowing or disallowing organization
76007-
members to use Copilot features within github.com.
76005+
description: The organization policy for allowing or disallowing Copilot
76006+
features on GitHub.com.
7600876007
enum:
7600976008
- enabled
7601076009
- disabled
7601176010
- unconfigured
7601276011
cli:
7601376012
type: string
76014-
description: The organization policy for allowing or disallowing organization
76015-
members to use Copilot within their CLI.
76013+
description: The organization policy for allowing or disallowing Copilot
76014+
in the CLI.
7601676015
enum:
7601776016
- enabled
7601876017
- disabled
@@ -76032,7 +76031,6 @@ components:
7603276031
enum:
7603376032
- business
7603476033
- enterprise
76035-
- unknown
7603676034
required:
7603776035
- seat_breakdown
7603876036
- public_code_suggestions

‎descriptions-next/api.github.com/api.github.com.json‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104808,8 +104808,8 @@
104808104808
"key"
104809104809
]
104810104810
},
104811-
"copilot-seat-breakdown": {
104812-
"title": "Copilot Business Seat Breakdown",
104811+
"copilot-organization-seat-breakdown": {
104812+
"title": "Copilot Seat Breakdown",
104813104813
"description": "The breakdown of Copilot Business seats for the organization.",
104814104814
"type": "object",
104815104815
"properties": {
@@ -104827,7 +104827,7 @@
104827104827
},
104828104828
"pending_invitation": {
104829104829
"type": "integer",
104830-
"description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
104830+
"description": "The number of users who have been invited to receive a Copilot seat through this organization."
104831104831
},
104832104832
"active_this_cycle": {
104833104833
"type": "integer",
@@ -104845,21 +104845,20 @@
104845104845
"type": "object",
104846104846
"properties": {
104847104847
"seat_breakdown": {
104848-
"$ref": "#/components/schemas/copilot-seat-breakdown"
104848+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
104849104849
},
104850104850
"public_code_suggestions": {
104851104851
"type": "string",
104852-
"description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
104852+
"description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
104853104853
"enum": [
104854104854
"allow",
104855104855
"block",
104856-
"unconfigured",
104857-
"unknown"
104856+
"unconfigured"
104858104857
]
104859104858
},
104860104859
"ide_chat": {
104861104860
"type": "string",
104862-
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
104861+
"description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
104863104862
"enum": [
104864104863
"enabled",
104865104864
"disabled",
@@ -104868,7 +104867,7 @@
104868104867
},
104869104868
"platform_chat": {
104870104869
"type": "string",
104871-
"description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
104870+
"description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
104872104871
"enum": [
104873104872
"enabled",
104874104873
"disabled",
@@ -104877,7 +104876,7 @@
104877104876
},
104878104877
"cli": {
104879104878
"type": "string",
104880-
"description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
104879+
"description": "The organization policy for allowing or disallowing Copilot in the CLI.",
104881104880
"enum": [
104882104881
"enabled",
104883104882
"disabled",
@@ -104899,8 +104898,7 @@
104899104898
"description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
104900104899
"enum": [
104901104900
"business",
104902-
"enterprise",
104903-
"unknown"
104901+
"enterprise"
104904104902
]
104905104903
}
104906104904
},

‎descriptions-next/api.github.com/api.github.com.yaml‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75948,8 +75948,8 @@ components:
7594875948
required:
7594975949
- key_id
7595075950
- key
75951-
copilot-seat-breakdown:
75952-
title: Copilot Business Seat Breakdown
75951+
copilot-organization-seat-breakdown:
75952+
title: Copilot Seat Breakdown
7595375953
description: The breakdown of Copilot Business seats for the organization.
7595475954
type: object
7595575955
properties:
@@ -75966,8 +75966,8 @@ components:
7596675966
of the current billing cycle.
7596775967
pending_invitation:
7596875968
type: integer
75969-
description: The number of seats that have been assigned to users that have
75970-
not yet accepted an invitation to this organization.
75969+
description: The number of users who have been invited to receive a Copilot
75970+
seat through this organization.
7597175971
active_this_cycle:
7597275972
type: integer
7597375973
description: The number of seats that have used Copilot during the current
@@ -75983,36 +75983,35 @@ components:
7598375983
type: object
7598475984
properties:
7598575985
seat_breakdown:
75986-
"$ref": "#/components/schemas/copilot-seat-breakdown"
75986+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
7598775987
public_code_suggestions:
7598875988
type: string
75989-
description: The organization policy for allowing or disallowing Copilot
75990-
to make suggestions that match public code.
75989+
description: The organization policy for allowing or blocking suggestions
75990+
matching public code (duplication detection filter).
7599175991
enum:
7599275992
- allow
7599375993
- block
7599475994
- unconfigured
75995-
- unknown
7599675995
ide_chat:
7599775996
type: string
75998-
description: The organization policy for allowing or disallowing organization
75999-
members to use Copilot Chat within their editor.
75997+
description: The organization policy for allowing or disallowing Copilot
75998+
Chat in the IDE.
7600075999
enum:
7600176000
- enabled
7600276001
- disabled
7600376002
- unconfigured
7600476003
platform_chat:
7600576004
type: string
76006-
description: The organization policy for allowing or disallowing organization
76007-
members to use Copilot features within github.com.
76005+
description: The organization policy for allowing or disallowing Copilot
76006+
features on GitHub.com.
7600876007
enum:
7600976008
- enabled
7601076009
- disabled
7601176010
- unconfigured
7601276011
cli:
7601376012
type: string
76014-
description: The organization policy for allowing or disallowing organization
76015-
members to use Copilot within their CLI.
76013+
description: The organization policy for allowing or disallowing Copilot
76014+
in the CLI.
7601676015
enum:
7601776016
- enabled
7601876017
- disabled
@@ -76032,7 +76031,6 @@ components:
7603276031
enum:
7603376032
- business
7603476033
- enterprise
76035-
- unknown
7603676034
required:
7603776035
- seat_breakdown
7603876036
- public_code_suggestions

‎descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -85185,7 +85185,7 @@
8518585185
"type": "object",
8518685186
"properties": {
8518785187
"seat_breakdown": {
85188-
"title": "Copilot Business Seat Breakdown",
85188+
"title": "Copilot Seat Breakdown",
8518985189
"description": "The breakdown of Copilot Business seats for the organization.",
8519085190
"type": "object",
8519185191
"properties": {
@@ -85203,7 +85203,7 @@
8520385203
},
8520485204
"pending_invitation": {
8520585205
"type": "integer",
85206-
"description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
85206+
"description": "The number of users who have been invited to receive a Copilot seat through this organization."
8520785207
},
8520885208
"active_this_cycle": {
8520985209
"type": "integer",
@@ -85217,17 +85217,16 @@
8521785217
},
8521885218
"public_code_suggestions": {
8521985219
"type": "string",
85220-
"description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
85220+
"description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
8522185221
"enum": [
8522285222
"allow",
8522385223
"block",
85224-
"unconfigured",
85225-
"unknown"
85224+
"unconfigured"
8522685225
]
8522785226
},
8522885227
"ide_chat": {
8522985228
"type": "string",
85230-
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
85229+
"description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
8523185230
"enum": [
8523285231
"enabled",
8523385232
"disabled",
@@ -85236,7 +85235,7 @@
8523685235
},
8523785236
"platform_chat": {
8523885237
"type": "string",
85239-
"description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
85238+
"description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
8524085239
"enum": [
8524185240
"enabled",
8524285241
"disabled",
@@ -85245,7 +85244,7 @@
8524585244
},
8524685245
"cli": {
8524785246
"type": "string",
85248-
"description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
85247+
"description": "The organization policy for allowing or disallowing Copilot in the CLI.",
8524985248
"enum": [
8525085249
"enabled",
8525185250
"disabled",
@@ -85267,8 +85266,7 @@
8526785266
"description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
8526885267
"enum": [
8526985268
"business",
85270-
"enterprise",
85271-
"unknown"
85269+
"enterprise"
8527285270
]
8527385271
}
8527485272
},

0 commit comments

Comments
 (0)