Skip to content

Commit 33dcf02

Browse files
Update OpenAPI 3.0 Descriptions
1 parent a06f88d commit 33dcf02

16 files changed

+156
-188
lines changed

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

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -103036,8 +103036,8 @@
103036103036
"key"
103037103037
]
103038103038
},
103039-
"copilot-seat-breakdown": {
103040-
"title": "Copilot Business Seat Breakdown",
103039+
"copilot-organization-seat-breakdown": {
103040+
"title": "Copilot Seat Breakdown",
103041103041
"description": "The breakdown of Copilot Business seats for the organization.",
103042103042
"type": "object",
103043103043
"properties": {
@@ -103055,7 +103055,7 @@
103055103055
},
103056103056
"pending_invitation": {
103057103057
"type": "integer",
103058-
"description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
103058+
"description": "The number of users who have been invited to receive a Copilot seat through this organization."
103059103059
},
103060103060
"active_this_cycle": {
103061103061
"type": "integer",
@@ -103073,21 +103073,20 @@
103073103073
"type": "object",
103074103074
"properties": {
103075103075
"seat_breakdown": {
103076-
"$ref": "#/components/schemas/copilot-seat-breakdown"
103076+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
103077103077
},
103078103078
"public_code_suggestions": {
103079103079
"type": "string",
103080-
"description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
103080+
"description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
103081103081
"enum": [
103082103082
"allow",
103083103083
"block",
103084-
"unconfigured",
103085-
"unknown"
103084+
"unconfigured"
103086103085
]
103087103086
},
103088103087
"ide_chat": {
103089103088
"type": "string",
103090-
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
103089+
"description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
103091103090
"enum": [
103092103091
"enabled",
103093103092
"disabled",
@@ -103096,7 +103095,7 @@
103096103095
},
103097103096
"platform_chat": {
103098103097
"type": "string",
103099-
"description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
103098+
"description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
103100103099
"enum": [
103101103100
"enabled",
103102103101
"disabled",
@@ -103105,7 +103104,7 @@
103105103104
},
103106103105
"cli": {
103107103106
"type": "string",
103108-
"description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
103107+
"description": "The organization policy for allowing or disallowing Copilot in the CLI.",
103109103108
"enum": [
103110103109
"enabled",
103111103110
"disabled",
@@ -103127,8 +103126,7 @@
103127103126
"description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
103128103127
"enum": [
103129103128
"business",
103130-
"enterprise",
103131-
"unknown"
103129+
"enterprise"
103132103130
]
103133103131
}
103134103132
},

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

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75189,8 +75189,8 @@ components:
7518975189
required:
7519075190
- key_id
7519175191
- key
75192-
copilot-seat-breakdown:
75193-
title: Copilot Business Seat Breakdown
75192+
copilot-organization-seat-breakdown:
75193+
title: Copilot Seat Breakdown
7519475194
description: The breakdown of Copilot Business seats for the organization.
7519575195
type: object
7519675196
properties:
@@ -75207,8 +75207,8 @@ components:
7520775207
of the current billing cycle.
7520875208
pending_invitation:
7520975209
type: integer
75210-
description: The number of seats that have been assigned to users that have
75211-
not yet accepted an invitation to this organization.
75210+
description: The number of users who have been invited to receive a Copilot
75211+
seat through this organization.
7521275212
active_this_cycle:
7521375213
type: integer
7521475214
description: The number of seats that have used Copilot during the current
@@ -75224,36 +75224,35 @@ components:
7522475224
type: object
7522575225
properties:
7522675226
seat_breakdown:
75227-
"$ref": "#/components/schemas/copilot-seat-breakdown"
75227+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
7522875228
public_code_suggestions:
7522975229
type: string
75230-
description: The organization policy for allowing or disallowing Copilot
75231-
to make suggestions that match public code.
75230+
description: The organization policy for allowing or blocking suggestions
75231+
matching public code (duplication detection filter).
7523275232
enum:
7523375233
- allow
7523475234
- block
7523575235
- unconfigured
75236-
- unknown
7523775236
ide_chat:
7523875237
type: string
75239-
description: The organization policy for allowing or disallowing organization
75240-
members to use Copilot Chat within their editor.
75238+
description: The organization policy for allowing or disallowing Copilot
75239+
Chat in the IDE.
7524175240
enum:
7524275241
- enabled
7524375242
- disabled
7524475243
- unconfigured
7524575244
platform_chat:
7524675245
type: string
75247-
description: The organization policy for allowing or disallowing organization
75248-
members to use Copilot features within github.com.
75246+
description: The organization policy for allowing or disallowing Copilot
75247+
features on GitHub.com.
7524975248
enum:
7525075249
- enabled
7525175250
- disabled
7525275251
- unconfigured
7525375252
cli:
7525475253
type: string
75255-
description: The organization policy for allowing or disallowing organization
75256-
members to use Copilot within their CLI.
75254+
description: The organization policy for allowing or disallowing Copilot
75255+
in the CLI.
7525775256
enum:
7525875257
- enabled
7525975258
- disabled
@@ -75273,7 +75272,6 @@ components:
7527375272
enum:
7527475273
- business
7527575274
- enterprise
75276-
- unknown
7527775275
required:
7527875276
- seat_breakdown
7527975277
- public_code_suggestions

descriptions/api.github.com/api.github.com.json

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -103036,8 +103036,8 @@
103036103036
"key"
103037103037
]
103038103038
},
103039-
"copilot-seat-breakdown": {
103040-
"title": "Copilot Business Seat Breakdown",
103039+
"copilot-organization-seat-breakdown": {
103040+
"title": "Copilot Seat Breakdown",
103041103041
"description": "The breakdown of Copilot Business seats for the organization.",
103042103042
"type": "object",
103043103043
"properties": {
@@ -103055,7 +103055,7 @@
103055103055
},
103056103056
"pending_invitation": {
103057103057
"type": "integer",
103058-
"description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
103058+
"description": "The number of users who have been invited to receive a Copilot seat through this organization."
103059103059
},
103060103060
"active_this_cycle": {
103061103061
"type": "integer",
@@ -103073,21 +103073,20 @@
103073103073
"type": "object",
103074103074
"properties": {
103075103075
"seat_breakdown": {
103076-
"$ref": "#/components/schemas/copilot-seat-breakdown"
103076+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
103077103077
},
103078103078
"public_code_suggestions": {
103079103079
"type": "string",
103080-
"description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
103080+
"description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
103081103081
"enum": [
103082103082
"allow",
103083103083
"block",
103084-
"unconfigured",
103085-
"unknown"
103084+
"unconfigured"
103086103085
]
103087103086
},
103088103087
"ide_chat": {
103089103088
"type": "string",
103090-
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
103089+
"description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
103091103090
"enum": [
103092103091
"enabled",
103093103092
"disabled",
@@ -103096,7 +103095,7 @@
103096103095
},
103097103096
"platform_chat": {
103098103097
"type": "string",
103099-
"description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
103098+
"description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
103100103099
"enum": [
103101103100
"enabled",
103102103101
"disabled",
@@ -103105,7 +103104,7 @@
103105103104
},
103106103105
"cli": {
103107103106
"type": "string",
103108-
"description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
103107+
"description": "The organization policy for allowing or disallowing Copilot in the CLI.",
103109103108
"enum": [
103110103109
"enabled",
103111103110
"disabled",
@@ -103127,8 +103126,7 @@
103127103126
"description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
103128103127
"enum": [
103129103128
"business",
103130-
"enterprise",
103131-
"unknown"
103129+
"enterprise"
103132103130
]
103133103131
}
103134103132
},

descriptions/api.github.com/api.github.com.yaml

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -75189,8 +75189,8 @@ components:
7518975189
required:
7519075190
- key_id
7519175191
- key
75192-
copilot-seat-breakdown:
75193-
title: Copilot Business Seat Breakdown
75192+
copilot-organization-seat-breakdown:
75193+
title: Copilot Seat Breakdown
7519475194
description: The breakdown of Copilot Business seats for the organization.
7519575195
type: object
7519675196
properties:
@@ -75207,8 +75207,8 @@ components:
7520775207
of the current billing cycle.
7520875208
pending_invitation:
7520975209
type: integer
75210-
description: The number of seats that have been assigned to users that have
75211-
not yet accepted an invitation to this organization.
75210+
description: The number of users who have been invited to receive a Copilot
75211+
seat through this organization.
7521275212
active_this_cycle:
7521375213
type: integer
7521475214
description: The number of seats that have used Copilot during the current
@@ -75224,36 +75224,35 @@ components:
7522475224
type: object
7522575225
properties:
7522675226
seat_breakdown:
75227-
"$ref": "#/components/schemas/copilot-seat-breakdown"
75227+
"$ref": "#/components/schemas/copilot-organization-seat-breakdown"
7522875228
public_code_suggestions:
7522975229
type: string
75230-
description: The organization policy for allowing or disallowing Copilot
75231-
to make suggestions that match public code.
75230+
description: The organization policy for allowing or blocking suggestions
75231+
matching public code (duplication detection filter).
7523275232
enum:
7523375233
- allow
7523475234
- block
7523575235
- unconfigured
75236-
- unknown
7523775236
ide_chat:
7523875237
type: string
75239-
description: The organization policy for allowing or disallowing organization
75240-
members to use Copilot Chat within their editor.
75238+
description: The organization policy for allowing or disallowing Copilot
75239+
Chat in the IDE.
7524175240
enum:
7524275241
- enabled
7524375242
- disabled
7524475243
- unconfigured
7524575244
platform_chat:
7524675245
type: string
75247-
description: The organization policy for allowing or disallowing organization
75248-
members to use Copilot features within github.com.
75246+
description: The organization policy for allowing or disallowing Copilot
75247+
features on GitHub.com.
7524975248
enum:
7525075249
- enabled
7525175250
- disabled
7525275251
- unconfigured
7525375252
cli:
7525475253
type: string
75255-
description: The organization policy for allowing or disallowing organization
75256-
members to use Copilot within their CLI.
75254+
description: The organization policy for allowing or disallowing Copilot
75255+
in the CLI.
7525775256
enum:
7525875257
- enabled
7525975258
- disabled
@@ -75273,7 +75272,6 @@ components:
7527375272
enum:
7527475273
- business
7527575274
- enterprise
75276-
- unknown
7527775275
required:
7527875276
- seat_breakdown
7527975277
- public_code_suggestions

descriptions/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
@@ -74279,7 +74279,7 @@
7427974279
"type": "object",
7428074280
"properties": {
7428174281
"seat_breakdown": {
74282-
"title": "Copilot Business Seat Breakdown",
74282+
"title": "Copilot Seat Breakdown",
7428374283
"description": "The breakdown of Copilot Business seats for the organization.",
7428474284
"type": "object",
7428574285
"properties": {
@@ -74297,7 +74297,7 @@
7429774297
},
7429874298
"pending_invitation": {
7429974299
"type": "integer",
74300-
"description": "The number of seats that have been assigned to users that have not yet accepted an invitation to this organization."
74300+
"description": "The number of users who have been invited to receive a Copilot seat through this organization."
7430174301
},
7430274302
"active_this_cycle": {
7430374303
"type": "integer",
@@ -74311,17 +74311,16 @@
7431174311
},
7431274312
"public_code_suggestions": {
7431374313
"type": "string",
74314-
"description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
74314+
"description": "The organization policy for allowing or blocking suggestions matching public code (duplication detection filter).",
7431574315
"enum": [
7431674316
"allow",
7431774317
"block",
74318-
"unconfigured",
74319-
"unknown"
74318+
"unconfigured"
7432074319
]
7432174320
},
7432274321
"ide_chat": {
7432374322
"type": "string",
74324-
"description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
74323+
"description": "The organization policy for allowing or disallowing Copilot Chat in the IDE.",
7432574324
"enum": [
7432674325
"enabled",
7432774326
"disabled",
@@ -74330,7 +74329,7 @@
7433074329
},
7433174330
"platform_chat": {
7433274331
"type": "string",
74333-
"description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.",
74332+
"description": "The organization policy for allowing or disallowing Copilot features on GitHub.com.",
7433474333
"enum": [
7433574334
"enabled",
7433674335
"disabled",
@@ -74339,7 +74338,7 @@
7433974338
},
7434074339
"cli": {
7434174340
"type": "string",
74342-
"description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.",
74341+
"description": "The organization policy for allowing or disallowing Copilot in the CLI.",
7434374342
"enum": [
7434474343
"enabled",
7434574344
"disabled",
@@ -74361,8 +74360,7 @@
7436174360
"description": "The Copilot plan of the organization, or the parent enterprise, when applicable.",
7436274361
"enum": [
7436374362
"business",
74364-
"enterprise",
74365-
"unknown"
74363+
"enterprise"
7436674364
]
7436774365
}
7436874366
},

0 commit comments

Comments
 (0)