diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 25df465a95..9d54a9074a 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -12097,96 +12097,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Budget successfully created." - }, - "budget": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded. For `user` and `multi_user_customer` scopes, this must be `true`." - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, - "budget_scope": { - "type": "string", - "description": "The scope of the budget", - "enum": [ - "organization", - "repository", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "default": "" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "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 budget" - } - } - } - } + "$ref": "#/components/schemas/create-budget" }, "examples": { "create-organization-budget": { - "value": { - "message": "Budget successfully created.", - "budget": { - "$ref": "#/components/responses/budget" - } - } + "$ref": "#/components/examples/create-budget" } } } @@ -12422,89 +12337,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Budget successfully updated." - }, - "budget": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded" - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, - "budget_scope": { - "type": "string", - "description": "The scope of the budget", - "enum": [ - "enterprise", - "organization", - "repository", - "cost_center", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "default": "" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "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 budget" - } - } - } - } + "$ref": "#/components/schemas/update-budget" }, "examples": { "update-budget": { @@ -122231,6 +122064,101 @@ "budgets" ] }, + "create-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the create operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center", + "multi_user_customer", + "user" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "message", + "budget" + ] + }, "get-budget": { "type": "object", "properties": { @@ -122326,6 +122254,99 @@ "budget_entity_name" ] }, + "update-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the update operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "budget", + "message" + ] + }, "delete-budget": { "type": "object", "properties": { @@ -131500,6 +131521,27 @@ "type" ] }, + "repository-rule-params-dismissal-restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-actor" + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "repository-rule-params-reviewer": { "title": "Reviewer", "description": "A required reviewing team", @@ -301600,6 +301642,24 @@ "total_count": 2 } }, + "create-budget": { + "value": { + "message": "Budget successfully created.", + "budget": { + "id": "f5236c62-157f-4d8f-a79e-ffb91058ee97", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_scope": "organization", + "budget_entity_name": "example-organization", + "budget_amount": 100, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + }, "get-budget": { "value": { "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", @@ -301627,7 +301687,7 @@ "budget_product_sku": "actions_linux", "budget_scope": "repository", "budget_entity_name": "org-name/example-repo-name", - "budget_amount": 0.0, + "budget_amount": 10, "prevent_further_usage": true, "budget_alerting": { "will_alert": true, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index fcb42b200c..f712d7aafa 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -8879,73 +8879,10 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string - example: Budget successfully created. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded. For `user` and `multi_user_customer` - scopes, this must be `true`. - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - organization - - repository - - multi_user_customer - - user - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - 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 budget + "$ref": "#/components/schemas/create-budget" examples: create-organization-budget: - value: - message: Budget successfully created. - budget: - "$ref": "#/components/responses/budget" + "$ref": "#/components/examples/create-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -9103,68 +9040,7 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string - example: Budget successfully updated. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - enterprise - - organization - - repository - - cost_center - - multi_user_customer - - user - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - 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 budget + "$ref": "#/components/schemas/update-budget" examples: update-budget: "$ref": "#/components/examples/update-budget" @@ -89439,6 +89315,76 @@ components: description: Total number of budgets matching the query required: - budgets + create-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the create operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + - multi_user_customer + - user + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + example: 100 + minimum: 0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - message + - budget get-budget: type: object properties: @@ -89511,6 +89457,74 @@ components: - budget_alerting - budget_scope - budget_entity_name + update-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the update operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + example: 100 + minimum: 0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - budget + - message delete-budget: type: object properties: @@ -96905,6 +96919,23 @@ components: required: - id - type + repository-rule-params-dismissal-restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed to dismiss pull request + reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps allowed to dismiss pull request + reviews. + items: + "$ref": "#/components/schemas/repository-rule-params-actor" + enabled: + type: boolean + description: Whether to restrict review dismissal to specific actors. + required: + - enabled repository-rule-params-reviewer: title: Reviewer description: A required reviewing team @@ -226203,6 +226234,20 @@ components: consumed_amount: 42.0 has_next_page: false total_count: 2 + create-budget: + value: + message: Budget successfully created. + budget: + id: f5236c62-157f-4d8f-a79e-ffb91058ee97 + budget_type: ProductPricing + budget_product_sku: actions + budget_scope: organization + budget_entity_name: example-organization + budget_amount: 100 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] get-budget: value: id: 2066deda-923f-43f9-88d2-62395a28c0cdd @@ -226226,7 +226271,7 @@ components: budget_product_sku: actions_linux budget_scope: repository budget_entity_name: org-name/example-repo-name - budget_amount: 0.0 + budget_amount: 10 prevent_further_usage: true budget_alerting: will_alert: true diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index 3bea80645a..5c802d8faa 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -12097,96 +12097,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Budget successfully created." - }, - "budget": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded. For `user` and `multi_user_customer` scopes, this must be `true`." - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, - "budget_scope": { - "type": "string", - "description": "The scope of the budget", - "enum": [ - "organization", - "repository", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "default": "" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "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 budget" - } - } - } - } + "$ref": "#/components/schemas/create-budget" }, "examples": { "create-organization-budget": { - "value": { - "message": "Budget successfully created.", - "budget": { - "$ref": "#/components/responses/budget" - } - } + "$ref": "#/components/examples/create-budget" } } } @@ -12422,89 +12337,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Budget successfully updated." - }, - "budget": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded" - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, - "budget_scope": { - "type": "string", - "description": "The scope of the budget", - "enum": [ - "enterprise", - "organization", - "repository", - "cost_center", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "default": "" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "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 budget" - } - } - } - } + "$ref": "#/components/schemas/update-budget" }, "examples": { "update-budget": { @@ -121740,6 +121573,101 @@ "budgets" ] }, + "create-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the create operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center", + "multi_user_customer", + "user" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "message", + "budget" + ] + }, "get-budget": { "type": "object", "properties": { @@ -121835,6 +121763,99 @@ "budget_entity_name" ] }, + "update-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the update operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "budget", + "message" + ] + }, "delete-budget": { "type": "object", "properties": { @@ -130966,6 +130987,27 @@ "type" ] }, + "repository-rule-params-dismissal-restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-actor" + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "repository-rule-params-reviewer": { "title": "Reviewer", "description": "A required reviewing team", @@ -300855,6 +300897,24 @@ "total_count": 2 } }, + "create-budget": { + "value": { + "message": "Budget successfully created.", + "budget": { + "id": "f5236c62-157f-4d8f-a79e-ffb91058ee97", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_scope": "organization", + "budget_entity_name": "example-organization", + "budget_amount": 100, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + }, "get-budget": { "value": { "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", @@ -300882,7 +300942,7 @@ "budget_product_sku": "actions_linux", "budget_scope": "repository", "budget_entity_name": "org-name/example-repo-name", - "budget_amount": 0.0, + "budget_amount": 10, "prevent_further_usage": true, "budget_alerting": { "will_alert": true, diff --git a/descriptions/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index 04d5e64bed..8b9fcec7cf 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -8879,73 +8879,10 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string - example: Budget successfully created. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded. For `user` and `multi_user_customer` - scopes, this must be `true`. - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - organization - - repository - - multi_user_customer - - user - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - 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 budget + "$ref": "#/components/schemas/create-budget" examples: create-organization-budget: - value: - message: Budget successfully created. - budget: - "$ref": "#/components/responses/budget" + "$ref": "#/components/examples/create-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -9103,68 +9040,7 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string - example: Budget successfully updated. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - enterprise - - organization - - repository - - cost_center - - multi_user_customer - - user - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - 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 budget + "$ref": "#/components/schemas/update-budget" examples: update-budget: "$ref": "#/components/examples/update-budget" @@ -89052,6 +88928,76 @@ components: description: Total number of budgets matching the query required: - budgets + create-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the create operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + - multi_user_customer + - user + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + example: 100 + minimum: 0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - message + - budget get-budget: type: object properties: @@ -89124,6 +89070,74 @@ components: - budget_alerting - budget_scope - budget_entity_name + update-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the update operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + example: 100 + minimum: 0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - budget + - message delete-budget: type: object properties: @@ -96481,6 +96495,23 @@ components: required: - id - type + repository-rule-params-dismissal-restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed to dismiss pull request + reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps allowed to dismiss pull request + reviews. + items: + "$ref": "#/components/schemas/repository-rule-params-actor" + enabled: + type: boolean + description: Whether to restrict review dismissal to specific actors. + required: + - enabled repository-rule-params-reviewer: title: Reviewer description: A required reviewing team @@ -225531,6 +225562,20 @@ components: consumed_amount: 42.0 has_next_page: false total_count: 2 + create-budget: + value: + message: Budget successfully created. + budget: + id: f5236c62-157f-4d8f-a79e-ffb91058ee97 + budget_type: ProductPricing + budget_product_sku: actions + budget_scope: organization + budget_entity_name: example-organization + budget_amount: 100 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] get-budget: value: id: 2066deda-923f-43f9-88d2-62395a28c0cdd @@ -225554,7 +225599,7 @@ components: budget_product_sku: actions_linux budget_scope: repository budget_entity_name: org-name/example-repo-name - budget_amount: 0.0 + budget_amount: 10 prevent_further_usage: true budget_alerting: will_alert: true diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 3d56ab80f9..6184f465af 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -12111,96 +12111,11 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Budget successfully created." - }, - "budget": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded. For `user` and `multi_user_customer` scopes, this must be `true`." - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, - "budget_scope": { - "type": "string", - "description": "The scope of the budget", - "enum": [ - "organization", - "repository", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "default": "" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "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 budget" - } - } - } - } + "$ref": "#/components/schemas/create-budget" }, "examples": { "create-organization-budget": { - "value": { - "message": "Budget successfully created.", - "budget": { - "$ref": "#/components/responses/budget" - } - } + "$ref": "#/components/examples/create-budget" } } } @@ -12436,89 +12351,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "message": { - "type": "string", - "example": "Budget successfully updated." - }, - "budget": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded" - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, - "budget_scope": { - "type": "string", - "description": "The scope of the budget", - "enum": [ - "enterprise", - "organization", - "repository", - "cost_center", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "default": "" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "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 budget" - } - } - } - } + "$ref": "#/components/schemas/update-budget" }, "examples": { "update-budget": { @@ -122971,6 +122804,101 @@ "budgets" ] }, + "create-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the create operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center", + "multi_user_customer", + "user" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "message", + "budget" + ] + }, "get-budget": { "type": "object", "properties": { @@ -123066,6 +122994,99 @@ "budget_entity_name" ] }, + "update-budget": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the result of the update operation" + }, + "budget": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the budget." + }, + "budget_scope": { + "type": "string", + "description": "The type of scope for the budget", + "example": "enterprise", + "enum": [ + "enterprise", + "organization", + "repository", + "cost_center" + ] + }, + "budget_entity_name": { + "type": "string", + "description": "The name of the entity to apply the budget to", + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" + }, + "budget_type": { + "description": "The type of pricing for the budget", + "example": "ProductPricing", + "oneOf": [ + { + "type": "string", + "enum": [ + "ProductPricing" + ] + }, + { + "type": "string", + "enum": [ + "SkuPricing" + ] + } + ] + }, + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } + } + } + } + }, + "required": [ + "budget", + "message" + ] + }, "delete-budget": { "type": "object", "properties": { @@ -132488,6 +132509,27 @@ "type" ] }, + "repository-rule-params-dismissal-restriction": { + "title": "DismissalRestriction", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "type": "object", + "properties": { + "allowed_actors": { + "type": "array", + "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-actor" + } + }, + "enabled": { + "type": "boolean", + "description": "Whether to restrict review dismissal to specific actors." + } + }, + "required": [ + "enabled" + ] + }, "repository-rule-params-reviewer": { "title": "Reviewer", "description": "A required reviewing team", @@ -303723,6 +303765,24 @@ "total_count": 2 } }, + "create-budget": { + "value": { + "message": "Budget successfully created.", + "budget": { + "id": "f5236c62-157f-4d8f-a79e-ffb91058ee97", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_scope": "organization", + "budget_entity_name": "example-organization", + "budget_amount": 100, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] + } + } + } + }, "get-budget": { "value": { "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", @@ -303750,7 +303810,7 @@ "budget_product_sku": "actions_linux", "budget_scope": "repository", "budget_entity_name": "org-name/example-repo-name", - "budget_amount": 0.0, + "budget_amount": 10, "prevent_further_usage": true, "budget_alerting": { "will_alert": true, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 953fe93b93..93e011a860 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -8887,73 +8887,10 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string - example: Budget successfully created. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded. For `user` and `multi_user_customer` - scopes, this must be `true`. - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - organization - - repository - - multi_user_customer - - user - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - 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 budget + "$ref": "#/components/schemas/create-budget" examples: create-organization-budget: - value: - message: Budget successfully created. - budget: - "$ref": "#/components/responses/budget" + "$ref": "#/components/examples/create-budget" '400': "$ref": "#/components/responses/bad_request" '401': @@ -9111,68 +9048,7 @@ paths: content: application/json: schema: - type: object - properties: - message: - type: string - example: Budget successfully updated. - budget: - type: object - properties: - id: - type: string - description: ID of the budget. - budget_amount: - type: number - format: float - description: The budget amount in whole dollars. For license-based - products, this represents the number of licenses. - prevent_further_usage: - type: boolean - description: Whether to prevent additional spending once the - budget is exceeded - budget_alerting: - type: object - required: - - will_alert - - alert_recipients - properties: - will_alert: - type: boolean - description: Whether alerts are enabled for this budget - alert_recipients: - type: array - items: - type: string - description: Array of user login names who will receive - alerts - budget_scope: - type: string - description: The scope of the budget - enum: - - enterprise - - organization - - repository - - cost_center - - multi_user_customer - - user - budget_entity_name: - type: string - description: The name of the entity to apply the budget to - default: '' - budget_type: - description: The type of pricing for the budget - 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 budget + "$ref": "#/components/schemas/update-budget" examples: update-budget: "$ref": "#/components/examples/update-budget" @@ -89923,6 +89799,76 @@ components: description: Total number of budgets matching the query required: - budgets + create-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the create operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + - multi_user_customer + - user + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + example: 100 + minimum: 0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - message + - budget get-budget: type: object properties: @@ -89995,6 +89941,74 @@ components: - budget_alerting - budget_scope - budget_entity_name + update-budget: + type: object + properties: + message: + type: string + description: A message indicating the result of the update operation + budget: + type: object + properties: + id: + type: string + description: ID of the budget. + budget_scope: + type: string + description: The type of scope for the budget + example: enterprise + enum: + - enterprise + - organization + - repository + - cost_center + budget_entity_name: + type: string + description: The name of the entity to apply the budget to + example: example-repository-name + budget_amount: + type: integer + description: The budget amount in whole dollars. For license-based products, + this represents the number of licenses. + example: 100 + minimum: 0 + prevent_further_usage: + type: boolean + description: Whether to prevent additional spending once the budget + is exceeded + example: true + budget_product_sku: + type: string + description: A single product or sku to apply the budget to. + example: actions_linux + budget_type: + description: The type of pricing for the budget + example: ProductPricing + oneOf: + - type: string + enum: + - ProductPricing + - type: string + enum: + - SkuPricing + budget_alerting: + type: object + properties: + will_alert: + type: boolean + description: Whether alerts are enabled for this budget + example: true + alert_recipients: + type: array + items: + type: string + description: Array of user login names who will receive alerts + example: + - mona + - lisa + required: + - budget + - message delete-budget: type: object properties: @@ -97585,6 +97599,23 @@ components: required: - id - type + repository-rule-params-dismissal-restriction: + title: DismissalRestriction + description: Specify people, teams, or apps allowed to dismiss pull request + reviews. + type: object + properties: + allowed_actors: + type: array + description: Specify people, teams, or apps allowed to dismiss pull request + reviews. + items: + "$ref": "#/components/schemas/repository-rule-params-actor" + enabled: + type: boolean + description: Whether to restrict review dismissal to specific actors. + required: + - enabled repository-rule-params-reviewer: title: Reviewer description: A required reviewing team @@ -227599,6 +227630,20 @@ components: consumed_amount: 42.0 has_next_page: false total_count: 2 + create-budget: + value: + message: Budget successfully created. + budget: + id: f5236c62-157f-4d8f-a79e-ffb91058ee97 + budget_type: ProductPricing + budget_product_sku: actions + budget_scope: organization + budget_entity_name: example-organization + budget_amount: 100 + prevent_further_usage: true + budget_alerting: + will_alert: false + alert_recipients: [] get-budget: value: id: 2066deda-923f-43f9-88d2-62395a28c0cdd @@ -227622,7 +227667,7 @@ components: budget_product_sku: actions_linux budget_scope: repository budget_entity_name: org-name/example-repo-name - budget_amount: 0.0 + budget_amount: 10 prevent_further_usage: true budget_alerting: will_alert: true diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index e0306baa0d..e3a00fe1b4 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -76099,7 +76099,7 @@ "properties": { "message": { "type": "string", - "example": "Budget successfully created." + "description": "A message indicating the result of the create operation" }, "budget": { "type": "object", @@ -76108,41 +76108,15 @@ "type": "string", "description": "ID of the budget." }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded. For `user` and `multi_user_customer` scopes, this must be `true`." - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, "budget_scope": { "type": "string", - "description": "The scope of the budget", + "description": "The type of scope for the budget", + "example": "enterprise", "enum": [ + "enterprise", "organization", "repository", + "cost_center", "multi_user_customer", "user" ] @@ -76150,10 +76124,27 @@ "budget_entity_name": { "type": "string", "description": "The name of the entity to apply the budget to", - "default": "" + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "minimum": 0 + }, + "prevent_further_usage": { + "type": "boolean", + "description": "Whether to prevent additional spending once the budget is exceeded", + "example": true + }, + "budget_product_sku": { + "type": "string", + "description": "A single product or sku to apply the budget to.", + "example": "actions_linux" }, "budget_type": { "description": "The type of pricing for the budget", + "example": "ProductPricing", "oneOf": [ { "type": "string", @@ -76169,138 +76160,50 @@ } ] }, - "budget_product_sku": { - "type": "string", - "description": "A single product or SKU that will be covered in the budget" + "budget_alerting": { + "type": "object", + "properties": { + "will_alert": { + "type": "boolean", + "description": "Whether alerts are enabled for this budget", + "example": true + }, + "alert_recipients": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array of user login names who will receive alerts", + "example": [ + "mona", + "lisa" + ] + } + } } } } - } + }, + "required": [ + "message", + "budget" + ] }, "examples": { "create-organization-budget": { "value": { "message": "Budget successfully created.", "budget": { - "description": "Response when updating a budget", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the budget." - }, - "budget_scope": { - "type": "string", - "description": "The type of scope for the budget", - "example": "enterprise", - "enum": [ - "enterprise", - "organization", - "repository", - "cost_center", - "multi_user_customer", - "user" - ] - }, - "budget_entity_name": { - "type": "string", - "description": "The name of the entity to apply the budget to", - "example": "octocat/hello-world" - }, - "user": { - "type": "string", - "description": "The user login when the budget is scoped to a single user (`user` scope).", - "example": "octocat" - }, - "budget_amount": { - "type": "integer", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded", - "example": true - }, - "budget_product_sku": { - "type": "string", - "description": "A single product or sku to apply the budget to.", - "example": "actions_linux" - }, - "budget_type": { - "description": "The type of pricing for the budget", - "example": "ProductPricing", - "oneOf": [ - { - "type": "string", - "enum": [ - "ProductPricing" - ] - }, - { - "type": "string", - "enum": [ - "SkuPricing" - ] - } - ] - }, - "budget_alerting": { - "type": "object", - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget", - "example": true - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts", - "example": [ - "mona", - "lisa" - ] - } - } - } - }, - "required": [ - "id", - "budget_amount", - "prevent_further_usage", - "budget_product_sku", - "budget_type", - "budget_alerting", - "budget_scope", - "budget_entity_name" - ] - }, - "examples": { - "default": { - "value": { - "id": "2066deda-923f-43f9-88d2-62395a28c0cdd", - "budget_type": "ProductPricing", - "budget_product_sku": "actions_linux", - "budget_scope": "repository", - "budget_entity_name": "example-repo-name", - "budget_amount": 0.0, - "prevent_further_usage": true, - "budget_alerting": { - "will_alert": true, - "alert_recipients": [ - "mona", - "lisa" - ] - } - } - } - } - } + "id": "f5236c62-157f-4d8f-a79e-ffb91058ee97", + "budget_type": "ProductPricing", + "budget_product_sku": "actions", + "budget_scope": "organization", + "budget_entity_name": "example-organization", + "budget_amount": 100, + "prevent_further_usage": true, + "budget_alerting": { + "will_alert": false, + "alert_recipients": [] } } } @@ -77024,7 +76927,7 @@ "properties": { "message": { "type": "string", - "example": "Budget successfully updated." + "description": "A message indicating the result of the update operation" }, "budget": { "type": "object", @@ -77033,54 +76936,41 @@ "type": "string", "description": "ID of the budget." }, - "budget_amount": { - "type": "number", - "format": "float", - "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses." - }, - "prevent_further_usage": { - "type": "boolean", - "description": "Whether to prevent additional spending once the budget is exceeded" - }, - "budget_alerting": { - "type": "object", - "required": [ - "will_alert", - "alert_recipients" - ], - "properties": { - "will_alert": { - "type": "boolean", - "description": "Whether alerts are enabled for this budget" - }, - "alert_recipients": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Array of user login names who will receive alerts" - } - } - }, "budget_scope": { "type": "string", - "description": "The scope of the budget", + "description": "The type of scope for the budget", + "example": "enterprise", "enum": [ "enterprise", "organization", "repository", - "cost_center", - "multi_user_customer", - "user" + "cost_center" ] }, "budget_entity_name": { "type": "string", "description": "The name of the entity to apply the budget to", - "default": "" + "example": "example-repository-name" + }, + "budget_amount": { + "type": "integer", + "description": "The budget amount in whole dollars. For license-based products, this represents the number of licenses.", + "example": 100, + "mi{"code":"deadline_exceeded","msg":"operation timed out"}