Skip to content

Commit 6b8387a

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent ee16ba1 commit 6b8387a

16 files changed

Lines changed: 864 additions & 400 deletions

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

Lines changed: 55 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8118,11 +8118,20 @@
81188118
"description": "The name of the entity to apply the budget to"
81198119
},
81208120
"budget_type": {
8121-
"type": "string",
81228121
"description": "The type of pricing for the budget",
8123-
"enum": [
8124-
"ProductPricing",
8125-
"SkuPricing"
8122+
"oneOf": [
8123+
{
8124+
"type": "string",
8125+
"enum": [
8126+
"ProductPricing"
8127+
]
8128+
},
8129+
{
8130+
"type": "string",
8131+
"enum": [
8132+
"SkuPricing"
8133+
]
8134+
}
81268135
]
81278136
},
81288137
"budget_product_sku": {
@@ -8211,11 +8220,20 @@
82118220
"default": ""
82128221
},
82138222
"budget_type": {
8214-
"type": "string",
82158223
"description": "The type of pricing for the budget",
8216-
"enum": [
8217-
"ProductPricing",
8218-
"SkuPricing"
8224+
"oneOf": [
8225+
{
8226+
"type": "string",
8227+
"enum": [
8228+
"ProductPricing"
8229+
]
8230+
},
8231+
{
8232+
"type": "string",
8233+
"enum": [
8234+
"SkuPricing"
8235+
]
8236+
}
82198237
]
82208238
},
82218239
"budget_product_sku": {
@@ -13837,14 +13855,14 @@
1383713855
"version": {
1383813856
"type": "string",
1383913857
"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",
13840-
"minLength": 1,
1384113858
"maxLength": 100,
1384213859
"x-multi-segment": true,
1384313860
"example": "1.2.3"
1384413861
},
1384513862
"status": {
1384613863
"type": "string",
1384713864
"description": "The deployment status of the artifact.",
13865+
"default": "deployed",
1384813866
"enum": [
1384913867
"deployed",
1385013868
"decommissioned"
@@ -13859,7 +13877,6 @@
1385913877
"github_repository": {
1386013878
"type": "string",
1386113879
"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.",
13862-
"minLength": 1,
1386313880
"maxLength": 100,
1386413881
"pattern": "^[A-Za-z0-9.\\-_]+$",
1386513882
"example": "my-github-repo"
@@ -17054,7 +17071,7 @@
1705417071
"properties": {
1705517072
"selected_usernames": {
1705617073
"type": "array",
17057-
"description": "The usernames of the organization members whose codespaces be billed to the organization.",
17074+
"description": "The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization.",
1705817075
"items": {
1705917076
"type": "string"
1706017077
},
@@ -17131,7 +17148,7 @@
1713117148
"properties": {
1713217149
"selected_usernames": {
1713317150
"type": "array",
17134-
"description": "The usernames of the organization members whose codespaces should not be billed to the organization.",
17151+
"description": "The usernames of the organization members and outside collaborators whose codespaces should not be billed to the organization.",
1713517152
"items": {
1713617153
"type": "string"
1713717154
},
@@ -109474,12 +109491,21 @@
109474109491
"example": "2066deda-923f-43f9-88d2-62395a28c0cdd"
109475109492
},
109476109493
"budget_type": {
109477-
"type": "string",
109478109494
"description": "The type of pricing for the budget",
109479109495
"example": "SkuPricing",
109480-
"enum": [
109481-
"SkuPricing",
109482-
"ProductPricing"
109496+
"oneOf": [
109497+
{
109498+
"type": "string",
109499+
"enum": [
109500+
"SkuPricing"
109501+
]
109502+
},
109503+
{
109504+
"type": "string",
109505+
"enum": [
109506+
"ProductPricing"
109507+
]
109508+
}
109483109509
]
109484109510
},
109485109511
"budget_amount": {
@@ -109602,12 +109628,21 @@
109602109628
"example": "actions_linux"
109603109629
},
109604109630
"budget_type": {
109605-
"type": "string",
109606109631
"description": "The type of pricing for the budget",
109607109632
"example": "ProductPricing",
109608-
"enum": [
109609-
"ProductPricing",
109610-
"SkuPricing"
109633+
"oneOf": [
109634+
{
109635+
"type": "string",
109636+
"enum": [
109637+
"ProductPricing"
109638+
]
109639+
},
109640+
{
109641+
"type": "string",
109642+
"enum": [
109643+
"SkuPricing"
109644+
]
109645+
}
109611109646
]
109612109647
},
109613109648
"budget_alerting": {

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

Lines changed: 33 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5737,11 +5737,14 @@ paths:
57375737
type: string
57385738
description: The name of the entity to apply the budget to
57395739
budget_type:
5740-
type: string
57415740
description: The type of pricing for the budget
5742-
enum:
5743-
- ProductPricing
5744-
- SkuPricing
5741+
oneOf:
5742+
- type: string
5743+
enum:
5744+
- ProductPricing
5745+
- type: string
5746+
enum:
5747+
- SkuPricing
57455748
budget_product_sku:
57465749
type: string
57475750
description: A single product or SKU that will be covered in the
@@ -5809,11 +5812,14 @@ paths:
58095812
description: The name of the entity to apply the budget to
58105813
default: ''
58115814
budget_type:
5812-
type: string
58135815
description: The type of pricing for the budget
5814-
enum:
5815-
- ProductPricing
5816-
- SkuPricing
5816+
oneOf:
5817+
- type: string
5818+
enum:
5819+
- ProductPricing
5820+
- type: string
5821+
enum:
5822+
- SkuPricing
58175823
budget_product_sku:
58185824
type: string
58195825
description: A single product or SKU that will be covered
@@ -10022,13 +10028,13 @@ paths:
1002210028
description: |
1002310029
The artifact version. Note that if multiple deployments have identical 'digest' parameter values,
1002410030
the version parameter must also be identical across all entries.
10025-
minLength: 1
1002610031
maxLength: 100
1002710032
x-multi-segment: true
1002810033
example: 1.2.3
1002910034
status:
1003010035
type: string
1003110036
description: The deployment status of the artifact.
10037+
default: deployed
1003210038
enum:
1003310039
- deployed
1003410040
- decommissioned
@@ -10050,7 +10056,6 @@ paths:
1005010056

1005110057
If a provenance attestation is available for the artifact, the API will use
1005210058
the repository information from the attestation instead of this parameter.
10053-
minLength: 1
1005410059
maxLength: 100
1005510060
pattern: "^[A-Za-z0-9.\\-_]+$"
1005610061
example: my-github-repo
@@ -12412,8 +12417,8 @@ paths:
1241212417
properties:
1241312418
selected_usernames:
1241412419
type: array
12415-
description: The usernames of the organization members whose codespaces
12416-
be billed to the organization.
12420+
description: The usernames of the organization members and outside
12421+
collaborators whose codespaces should be billed to the organization.
1241712422
items:
1241812423
type: string
1241912424
maxItems: 100
@@ -12470,8 +12475,8 @@ paths:
1247012475
properties:
1247112476
selected_usernames:
1247212477
type: array
12473-
description: The usernames of the organization members whose codespaces
12474-
should not be billed to the organization.
12478+
description: The usernames of the organization members and outside
12479+
collaborators whose codespaces should not be billed to the organization.
1247512480
items:
1247612481
type: string
1247712482
maxItems: 100
@@ -79624,12 +79629,15 @@ components:
7962479629
description: The unique identifier for the budget
7962579630
example: 2066deda-923f-43f9-88d2-62395a28c0cdd
7962679631
budget_type:
79627-
type: string
7962879632
description: The type of pricing for the budget
7962979633
example: SkuPricing
79630-
enum:
79631-
- SkuPricing
79632-
- ProductPricing
79634+
oneOf:
79635+
- type: string
79636+
enum:
79637+
- SkuPricing
79638+
- type: string
79639+
enum:
79640+
- ProductPricing
7963379641
budget_amount:
7963479642
type: integer
7963579643
description: The budget amount limit in whole dollars. For license-based
@@ -79726,12 +79734,15 @@ components:
7972679734
description: A single product or sku to apply the budget to.
7972779735
example: actions_linux
7972879736
budget_type:
79729-
type: string
7973079737
description: The type of pricing for the budget
7973179738
example: ProductPricing
79732-
enum:
79733-
- ProductPricing
79734-
- SkuPricing
79739+
oneOf:
79740+
- type: string
79741+
enum:
79742+
- ProductPricing
79743+
- type: string
79744+
enum:
79745+
- SkuPricing
7973579746
budget_alerting:
7973679747
type: object
7973779748
properties:

0 commit comments

Comments
 (0)