Skip to content

Commit 1f6b671

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #6091 from github/openapi-update-555c0d1eac59959834adf06cc8230e1941bf5510bd2aef4860b2e15aca88047a
Update OpenAPI 3.1 Descriptions
2 parents 3b1c03d + 72b38f6 commit 1f6b671

16 files changed

+864
-400
lines changed

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

Lines changed: 55 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8168,11 +8168,20 @@
81688168
"description": "The name of the entity to apply the budget to"
81698169
},
81708170
"budget_type": {
8171-
"type": "string",
81728171
"description": "The type of pricing for the budget",
8173-
"enum": [
8174-
"ProductPricing",
8175-
"SkuPricing"
8172+
"oneOf": [
8173+
{
8174+
"type": "string",
8175+
"enum": [
8176+
"ProductPricing"
8177+
]
8178+
},
8179+
{
8180+
"type": "string",
8181+
"enum": [
8182+
"SkuPricing"
8183+
]
8184+
}
81768185
]
81778186
},
81788187
"budget_product_sku": {
@@ -8263,11 +8272,20 @@
82638272
"default": ""
82648273
},
82658274
"budget_type": {
8266-
"type": "string",
82678275
"description": "The type of pricing for the budget",
8268-
"enum": [
8269-
"ProductPricing",
8270-
"SkuPricing"
8276+
"oneOf": [
8277+
{
8278+
"type": "string",
8279+
"enum": [
8280+
"ProductPricing"
8281+
]
8282+
},
8283+
{
8284+
"type": "string",
8285+
"enum": [
8286+
"SkuPricing"
8287+
]
8288+
}
82718289
]
82728290
},
82738291
"budget_product_sku": {
@@ -13907,7 +13925,6 @@
1390713925
"version": {
1390813926
"type": "string",
1390913927
"description": "The artifact version. Note that if multiple deployments have identical 'digest' parameter values,\nthe version parameter must also be identical across all entries.\n",
13910-
"minLength": 1,
1391113928
"maxLength": 100,
1391213929
"x-multi-segment": true,
1391313930
"examples": [
@@ -13917,6 +13934,7 @@
1391713934
"status": {
1391813935
"type": "string",
1391913936
"description": "The deployment status of the artifact.",
13937+
"default": "deployed",
1392013938
"enum": [
1392113939
"deployed",
1392213940
"decommissioned"
@@ -13931,7 +13949,6 @@
1393113949
"github_repository": {
1393213950
"type": "string",
1393313951
"description": "The name of the GitHub repository associated with the artifact. This should be used\nwhen there are no provenance attestations available for the artifact. The repository\nmust belong to the organization specified in the path parameter.\n\nIf a provenance attestation is available for the artifact, the API will use\nthe repository information from the attestation instead of this parameter.",
13934-
"minLength": 1,
1393513952
"maxLength": 100,
1393613953
"pattern": "^[A-Za-z0-9.\\-_]+$",
1393713954
"examples": [
@@ -17166,7 +17183,7 @@
1716617183
"properties": {
1716717184
"selected_usernames": {
1716817185
"type": "array",
17169-
"description": "The usernames of the organization members whose codespaces be billed to the organization.",
17186+
"description": "The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization.",
1717017187
"items": {
1717117188
"type": "string"
1717217189
},
@@ -17243,7 +17260,7 @@
1724317260
"properties": {
1724417261
"selected_usernames": {
1724517262
"type": "array",
17246-
"description": "The usernames of the organization members whose codespaces should not be billed to the organization.",
17263+
"description": "The usernames of the organization members and outside collaborators whose codespaces should not be billed to the organization.",
1724717264
"items": {
1724817265
"type": "string"
1724917266
},
@@ -110673,11 +110690,20 @@
110673110690
]
110674110691
},
110675110692
"budget_type": {
110676-
"type": "string",
110677110693
"description": "The type of pricing for the budget",
110678-
"enum": [
110679-
"SkuPricing",
110680-
"ProductPricing"
110694+
"oneOf": [
110695+
{
110696+
"type": "string",
110697+
"enum": [
110698+
"SkuPricing"
110699+
]
110700+
},
110701+
{
110702+
"type": "string",
110703+
"enum": [
110704+
"ProductPricing"
110705+
]
110706+
}
110681110707
],
110682110708
"examples": [
110683110709
"SkuPricing"
@@ -110819,11 +110845,20 @@
110819110845
]
110820110846
},
110821110847
"budget_type": {
110822-
"type": "string",
110823110848
"description": "The type of pricing for the budget",
110824-
"enum": [
110825-
"ProductPricing",
110826-
"SkuPricing"
110849+
"oneOf": [
110850+
{
110851+
"type": "string",
110852+
"enum": [
110853+
"ProductPricing"
110854+
]
110855+
},
110856+
{
110857+
"type": "string",
110858+
"enum": [
110859+
"SkuPricing"
110860+
]
110861+
}
110827110862
],
110828110863
"examples": [
110829110864
"ProductPricing"

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

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5760,11 +5760,14 @@ paths:
57605760
type: string
57615761
description: The name of the entity to apply the budget to
57625762
budget_type:
5763-
type: string
57645763
description: The type of pricing for the budget
5765-
enum:
5766-
- ProductPricing
5767-
- SkuPricing
5764+
oneOf:
5765+
- type: string
5766+
enum:
5767+
- ProductPricing
5768+
- type: string
5769+
enum:
5770+
- SkuPricing
57685771
budget_product_sku:
57695772
type: string
57705773
description: A single product or SKU that will be covered in the
@@ -5833,11 +5836,14 @@ paths:
58335836
description: The name of the entity to apply the budget to
58345837
default: ''
58355838
budget_type:
5836-
type: string
58375839
description: The type of pricing for the budget
5838-
enum:
5839-
- ProductPricing
5840-
- SkuPricing
5840+
oneOf:
5841+
- type: string
5842+
enum:
5843+
- ProductPricing
5844+
- type: string
5845+
enum:
5846+
- SkuPricing
58415847
budget_product_sku:
58425848
type: string
58435849
description: A single product or SKU that will be covered
@@ -10055,14 +10061,14 @@ paths:
1005510061
description: |
1005610062
The artifact version. Note that if multiple deployments have identical 'digest' parameter values,
1005710063
the version parameter must also be identical across all entries.
10058-
minLength: 1
1005910064
maxLength: 100
1006010065
x-multi-segment: true
1006110066
examples:
1006210067
- 1.2.3
1006310068
status:
1006410069
type: string
1006510070
description: The deployment status of the artifact.
10071+
default: deployed
1006610072
enum:
1006710073
- deployed
1006810074
- decommissioned
@@ -10084,7 +10090,6 @@ paths:
1008410090

1008510091
If a provenance attestation is available for the artifact, the API will use
1008610092
the repository information from the attestation instead of this parameter.
10087-
minLength: 1
1008810093
maxLength: 100
1008910094
pattern: "^[A-Za-z0-9.\\-_]+$"
1009010095
examples:
@@ -12466,8 +12471,8 @@ paths:
1246612471
properties:
1246712472
selected_usernames:
1246812473
type: array
12469-
description: The usernames of the organization members whose codespaces
12470-
be billed to the organization.
12474+
description: The usernames of the organization members and outside
12475+
collaborators whose codespaces should be billed to the organization.
1247112476
items:
1247212477
type: string
1247312478
maxItems: 100
@@ -12524,8 +12529,8 @@ paths:
1252412529
properties:
1252512530
selected_usernames:
1252612531
type: array
12527-
description: The usernames of the organization members whose codespaces
12528-
should not be billed to the organization.
12532+
description: The usernames of the organization members and outside
12533+
collaborators whose codespaces should not be billed to the organization.
1252912534
items:
1253012535
type: string
1253112536
maxItems: 100
@@ -79967,11 +79972,14 @@ components:
7996779972
examples:
7996879973
- 2066deda-923f-43f9-88d2-62395a28c0cdd
7996979974
budget_type:
79970-
type: string
7997179975
description: The type of pricing for the budget
79972-
enum:
79973-
- SkuPricing
79974-
- ProductPricing
79976+
oneOf:
79977+
- type: string
79978+
enum:
79979+
- SkuPricing
79980+
- type: string
79981+
enum:
79982+
- ProductPricing
7997579983
examples:
7997679984
- SkuPricing
7997779985
budget_amount:
@@ -80078,11 +80086,14 @@ components:
8007880086
examples:
8007980087
- actions_linux
8008080088
budget_type:
80081-
type: string
8008280089
description: The type of pricing for the budget
80083-
enum:
80084-
- ProductPricing
80085-
- SkuPricing
80090+
oneOf:
80091+
- type: string
80092+
enum:
80093+
- ProductPricing
80094+
- type: string
80095+
enum:
80096+
- SkuPricing
8008680097
examples:
8008780098
- ProductPricing
8008880099
budget_alerting:

0 commit comments

Comments
 (0)