Skip to content

Update OpenAPI 3.1 Descriptions #6091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dinonuggies1 merged 1 commit into from
Mar 10, 2026
Merged

Update OpenAPI 3.1 Descriptions #6091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 55 additions & 20 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8168,11 +8168,20 @@
"description": "The name of the entity to apply the budget to"
},
"budget_type": {
"type": "string",
"description": "The type of pricing for the budget",
"enum": [
"ProductPricing",
"SkuPricing"
"oneOf": [
{
"type": "string",
"enum": [
"ProductPricing"
]
},
{
"type": "string",
"enum": [
"SkuPricing"
]
}
]
},
"budget_product_sku": {
Expand Down Expand Up @@ -8263,11 +8272,20 @@
"default": ""
},
"budget_type": {
"type": "string",
"description": "The type of pricing for the budget",
"enum": [
"ProductPricing",
"SkuPricing"
"oneOf": [
{
"type": "string",
"enum": [
"ProductPricing"
]
},
{
"type": "string",
"enum": [
"SkuPricing"
]
}
]
},
"budget_product_sku": {
Expand Down Expand Up @@ -13907,7 +13925,6 @@
"version": {
"type": "string",
"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",
"minLength": 1,
"maxLength": 100,
"x-multi-segment": true,
"examples": [
Expand All @@ -13917,6 +13934,7 @@
"status": {
"type": "string",
"description": "The deployment status of the artifact.",
"default": "deployed",
"enum": [
"deployed",
"decommissioned"
Expand All @@ -13931,7 +13949,6 @@
"github_repository": {
"type": "string",
"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.",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9.\\-_]+$",
"examples": [
Expand Down Expand Up @@ -17166,7 +17183,7 @@
"properties": {
"selected_usernames": {
"type": "array",
"description": "The usernames of the organization members whose codespaces be billed to the organization.",
"description": "The usernames of the organization members and outside collaborators whose codespaces should be billed to the organization.",
"items": {
"type": "string"
},
Expand Down Expand Up @@ -17243,7 +17260,7 @@
"properties": {
"selected_usernames": {
"type": "array",
"description": "The usernames of the organization members whose codespaces should not be billed to the organization.",
"description": "The usernames of the organization members and outside collaborators whose codespaces should not be billed to the organization.",
"items": {
"type": "string"
},
Expand Down Expand Up @@ -110673,11 +110690,20 @@
]
},
"budget_type": {
"type": "string",
"description": "The type of pricing for the budget",
"enum": [
"SkuPricing",
"ProductPricing"
"oneOf": [
{
"type": "string",
"enum": [
"SkuPricing"
]
},
{
"type": "string",
"enum": [
"ProductPricing"
]
}
],
"examples": [
"SkuPricing"
Expand Down Expand Up @@ -110819,11 +110845,20 @@
]
},
"budget_type": {
"type": "string",
"description": "The type of pricing for the budget",
"enum": [
"ProductPricing",
"SkuPricing"
"oneOf": [
{
"type": "string",
"enum": [
"ProductPricing"
]
},
{
"type": "string",
"enum": [
"SkuPricing"
]
}
],
"examples": [
"ProductPricing"
Expand Down
55 changes: 33 additions & 22 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5760,11 +5760,14 @@ paths:
type: string
description: The name of the entity to apply the budget to
budget_type:
type: string
description: The type of pricing for the budget
enum:
- ProductPricing
- SkuPricing
oneOf:
- type: string
enum:
- ProductPricing
- type: string
enum:
- SkuPricing
budget_product_sku:
type: string
description: A single product or SKU that will be covered in the
Expand Down Expand Up @@ -5833,11 +5836,14 @@ paths:
description: The name of the entity to apply the budget to
default: ''
budget_type:
type: string
description: The type of pricing for the budget
enum:
- ProductPricing
- SkuPricing
oneOf:
- type: string
enum:
- ProductPricing
- type: string
enum:
- SkuPricing
budget_product_sku:
type: string
description: A single product or SKU that will be covered
Expand Down Expand Up @@ -10055,14 +10061,14 @@ paths:
description: |
The artifact version. Note that if multiple deployments have identical 'digest' parameter values,
the version parameter must also be identical across all entries.
minLength: 1
maxLength: 100
x-multi-segment: true
examples:
- 1.2.3
status:
type: string
description: The deployment status of the artifact.
default: deployed
enum:
- deployed
- decommissioned
Expand All @@ -10084,7 +10090,6 @@ paths:

If a provenance attestation is available for the artifact, the API will use
the repository information from the attestation instead of this parameter.
minLength: 1
maxLength: 100
pattern: "^[A-Za-z0-9.\\-_]+$"
examples:
Expand Down Expand Up @@ -12466,8 +12471,8 @@ paths:
properties:
selected_usernames:
type: array
description: The usernames of the organization members whose codespaces
be billed to the organization.
description: The usernames of the organization members and outside
collaborators whose codespaces should be billed to the organization.
items:
type: string
maxItems: 100
Expand Down Expand Up @@ -12524,8 +12529,8 @@ paths:
properties:
selected_usernames:
type: array
description: The usernames of the organization members whose codespaces
should not be billed to the organization.
description: The usernames of the organization members and outside
collaborators whose codespaces should not be billed to the organization.
items:
type: string
maxItems: 100
Expand Down Expand Up @@ -79967,11 +79972,14 @@ components:
examples:
- 2066deda-923f-43f9-88d2-62395a28c0cdd
budget_type:
type: string
description: The type of pricing for the budget
enum:
- SkuPricing
- ProductPricing
oneOf:
- type: string
enum:
- SkuPricing
- type: string
enum:
- ProductPricing
examples:
- SkuPricing
budget_amount:
Expand Down Expand Up @@ -80078,11 +80086,14 @@ components:
examples:
- actions_linux
budget_type:
type: string
description: The type of pricing for the budget
enum:
- ProductPricing
- SkuPricing
oneOf:
- type: string
enum:
- ProductPricing
- type: string
enum:
- SkuPricing
examples:
- ProductPricing
budget_alerting:
Expand Down
Loading