diff options
author | github-openapi-bot <security+github-openapi-bot@github.com> | 2025-04-30 19:35:25 -0700 |
---|---|---|
committer | github-openapi-bot <security+github-openapi-bot@github.com> | 2025-04-30 19:35:25 -0700 |
commit | ef35491c4a8d216c60cd2f733433163afca3b446 (patch) | |
tree | 39b809d28fb405c1e8dc8ef5d45082a9aa946474 /descriptions/api.github.com/api.github.com.2022-11-28.yaml | |
parent | 7291aebf74227b541192db318cb6d5ec7d9388e9 (diff) | |
download | rest-api-description-ef35491c4a8d216c60cd2f733433163afca3b446.tar.gz rest-api-description-ef35491c4a8d216c60cd2f733433163afca3b446.zip |
Update OpenAPI 3.0 Descriptions
Diffstat (limited to 'descriptions/api.github.com/api.github.com.2022-11-28.yaml')
-rw-r--r-- | descriptions/api.github.com/api.github.com.2022-11-28.yaml | 109 |
1 files changed, 107 insertions, 2 deletions
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 bed6e2c51..294158206 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 @@ -51357,6 +51357,41 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/users/{username}/settings/billing/usage": + get: + summary: Get billing usage report for a user + description: |- + Gets a report of the total usage for a user. + + **Note:** This endpoint is only available to users with access to the enhanced billing platform. + tags: + - billing + operationId: billing/get-github-billing-usage-report-user + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user + parameters: + - "$ref": "#/components/parameters/username" + - "$ref": "#/components/parameters/billing-usage-report-year" + - "$ref": "#/components/parameters/billing-usage-report-month" + - "$ref": "#/components/parameters/billing-usage-report-day" + - "$ref": "#/components/parameters/billing-usage-report-hour" + responses: + '200': + "$ref": "#/components/responses/billing_usage_report_user" + '400': + "$ref": "#/components/responses/bad_request" + '403': + "$ref": "#/components/responses/forbidden" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: billing + subcategory: enhanced-billing "/users/{username}/social_accounts": get: summary: List social accounts for a user @@ -92088,8 +92123,8 @@ components: encoded nullable: true secret-scanning-alert-resolution-comment: - description: An optional comment when closing an alert. Cannot be updated or - deleted. Must be `null` when changing `state` to `open`. + description: An optional comment when closing or reopening an alert. Cannot + be updated or deleted. type: string nullable: true secret-scanning-location-commit: @@ -94748,6 +94783,54 @@ components: required: - key - id + billing-usage-report-user: + type: object + properties: + usageItems: + type: array + items: + type: object + properties: + date: + type: string + description: Date of the usage line item. + product: + type: string + description: Product name. + sku: + type: string + description: SKU name. + quantity: + type: integer + description: Quantity of the usage line item. + unitType: + type: string + description: Unit type of the usage line item. + pricePerUnit: + type: number + description: Price per unit of the usage line item. + grossAmount: + type: number + description: Gross amount of the usage line item. + discountAmount: + type: number + description: Discount amount of the usage line item. + netAmount: + type: number + description: Net amount of the usage line item. + repositoryName: + type: string + description: Name of the repository. + required: + - date + - product + - sku + - quantity + - unitType + - pricePerUnit + - grossAmount + - discountAmount + - netAmount enterprise-webhooks: title: Enterprise description: |- @@ -225772,6 +225855,19 @@ components: gravatar_id: '' url: https://api.github.com/orgs/github avatar_url: https://avatars.githubusercontent.com/u/9919? + billing-usage-report-user: + value: + usageItems: + - date: '2023-08-01' + product: Actions + sku: Actions Linux + quantity: 100 + unitType: minutes + pricePerUnit: 0.008 + grossAmount: 0.8 + discountAmount: 0 + netAmount: 0.8 + repositoryName: user/example check-run-completed: value: action: completed @@ -229022,6 +229118,15 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + billing_usage_report_user: + description: Response when getting a billing usage report + content: + application/json: + schema: + "$ref": "#/components/schemas/billing-usage-report-user" + examples: + default: + "$ref": "#/components/examples/billing-usage-report-user" headers: link: example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; |