Skip to content

Commit 467f6a9

Browse files
beccobecco
authored
Merge pull request #4795 from github/openapi-update-79668c74668ddcec7597e70322af06818b47e04c409146b729de0fc684f50287
Update OpenAPI 3.1 Descriptions
2 parents 30250cd + ea09049 commit 467f6a9

24 files changed

Lines changed: 5048 additions & 2432 deletions

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

Lines changed: 152 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71069,6 +71069,60 @@
7106971069
}
7107071070
}
7107171071
},
71072+
"/users/{username}/settings/billing/usage": {
71073+
"get": {
71074+
"summary": "Get billing usage report for a user",
71075+
"description": "Gets a report of the total usage for a user.\n\n**Note:** This endpoint is only available to users with access to the enhanced billing platform.",
71076+
"tags": [
71077+
"billing"
71078+
],
71079+
"operationId": "billing/get-github-billing-usage-report-user",
71080+
"externalDocs": {
71081+
"description": "API method documentation",
71082+
"url": "https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user"
71083+
},
71084+
"parameters": [
71085+
{
71086+
"$ref": "#/components/parameters/username"
71087+
},
71088+
{
71089+
"$ref": "#/components/parameters/billing-usage-report-year"
71090+
},
71091+
{
71092+
"$ref": "#/components/parameters/billing-usage-report-month"
71093+
},
71094+
{
71095+
"$ref": "#/components/parameters/billing-usage-report-day"
71096+
},
71097+
{
71098+
"$ref": "#/components/parameters/billing-usage-report-hour"
71099+
}
71100+
],
71101+
"responses": {
71102+
"200": {
71103+
"$ref": "#/components/responses/billing_usage_report_user"
71104+
},
71105+
"400": {
71106+
"$ref": "#/components/responses/bad_request"
71107+
},
71108+
"403": {
71109+
"$ref": "#/components/responses/forbidden"
71110+
},
71111+
"500": {
71112+
"$ref": "#/components/responses/internal_error"
71113+
},
71114+
"503": {
71115+
"$ref": "#/components/responses/service_unavailable"
71116+
}
71117+
},
71118+
"x-github": {
71119+
"githubCloudOnly": false,
71120+
"enabledForGitHubApps": true,
71121+
"category": "billing",
71122+
"subcategory": "enhanced-billing"
71123+
}
71124+
}
71125+
},
7107271126
"/users/{username}/social_accounts": {
7107371127
"get": {
7107471128
"summary": "List social accounts for a user",
@@ -128367,7 +128421,7 @@
128367128421
}
128368128422
},
128369128423
"secret-scanning-alert-resolution-comment": {
128370-
"description": "An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.",
128424+
"description": "An optional comment when closing or reopening an alert. Cannot be updated or deleted.",
128371128425
"type": [
128372128426
"string",
128373128427
"null"
@@ -132408,6 +132462,70 @@
132408132462
"id"
132409132463
]
132410132464
},
132465+
"billing-usage-report-user": {
132466+
"type": "object",
132467+
"properties": {
132468+
"usageItems": {
132469+
"type": "array",
132470+
"items": {
132471+
"type": "object",
132472+
"properties": {
132473+
"date": {
132474+
"type": "string",
132475+
"description": "Date of the usage line item."
132476+
},
132477+
"product": {
132478+
"type": "string",
132479+
"description": "Product name."
132480+
},
132481+
"sku": {
132482+
"type": "string",
132483+
"description": "SKU name."
132484+
},
132485+
"quantity": {
132486+
"type": "integer",
132487+
"description": "Quantity of the usage line item."
132488+
},
132489+
"unitType": {
132490+
"type": "string",
132491+
"description": "Unit type of the usage line item."
132492+
},
132493+
"pricePerUnit": {
132494+
"type": "number",
132495+
"description": "Price per unit of the usage line item."
132496+
},
132497+
"grossAmount": {
132498+
"type": "number",
132499+
"description": "Gross amount of the usage line item."
132500+
},
132501+
"discountAmount": {
132502+
"type": "number",
132503+
"description": "Discount amount of the usage line item."
132504+
},
132505+
"netAmount": {
132506+
"type": "number",
132507+
"description": "Net amount of the usage line item."
132508+
},
132509+
"repositoryName": {
132510+
"type": "string",
132511+
"description": "Name of the repository."
132512+
}
132513+
},
132514+
"required": [
132515+
"date",
132516+
"product",
132517+
"sku",
132518+
"quantity",
132519+
"unitType",
132520+
"pricePerUnit",
132521+
"grossAmount",
132522+
"discountAmount",
132523+
"netAmount"
132524+
]
132525+
}
132526+
}
132527+
}
132528+
},
132411132529
"enterprise-webhooks": {
132412132530
"title": "Enterprise",
132413132531
"description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"",
@@ -306592,6 +306710,24 @@
306592306710
}
306593306711
]
306594306712
},
306713+
"billing-usage-report-user": {
306714+
"value": {
306715+
"usageItems": [
306716+
{
306717+
"date": "2023-08-01",
306718+
"product": "Actions",
306719+
"sku": "Actions Linux",
306720+
"quantity": 100,
306721+
"unitType": "minutes",
306722+
"pricePerUnit": 0.008,
306723+
"grossAmount": 0.8,
306724+
"discountAmount": 0,
306725+
"netAmount": 0.8,
306726+
"repositoryName": "user/example"
306727+
}
306728+
]
306729+
}
306730+
},
306595306731
"check-run-completed": {
306596306732
"value": {
306597306733
"action": "completed",
@@ -310389,6 +310525,21 @@
310389310525
}
310390310526
}
310391310527
}
310528+
},
310529+
"billing_usage_report_user": {
310530+
"description": "Response when getting a billing usage report",
310531+
"content": {
310532+
"application/json": {
310533+
"schema": {
310534+
"$ref": "#/components/schemas/billing-usage-report-user"
310535+
},
310536+
"examples": {
310537+
"default": {
310538+
"$ref": "#/components/examples/billing-usage-report-user"
310539+
}
310540+
}
310541+
}
310542+
}
310392310543
}
310393310544
},
310394310545
"headers": {

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

Lines changed: 107 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51536,6 +51536,41 @@ paths:
5153651536
enabledForGitHubApps: false
5153751537
category: billing
5153851538
subcategory: billing
51539+
"/users/{username}/settings/billing/usage":
51540+
get:
51541+
summary: Get billing usage report for a user
51542+
description: |-
51543+
Gets a report of the total usage for a user.
51544+
51545+
**Note:** This endpoint is only available to users with access to the enhanced billing platform.
51546+
tags:
51547+
- billing
51548+
operationId: billing/get-github-billing-usage-report-user
51549+
externalDocs:
51550+
description: API method documentation
51551+
url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-a-user
51552+
parameters:
51553+
- "$ref": "#/components/parameters/username"
51554+
- "$ref": "#/components/parameters/billing-usage-report-year"
51555+
- "$ref": "#/components/parameters/billing-usage-report-month"
51556+
- "$ref": "#/components/parameters/billing-usage-report-day"
51557+
- "$ref": "#/components/parameters/billing-usage-report-hour"
51558+
responses:
51559+
'200':
51560+
"$ref": "#/components/responses/billing_usage_report_user"
51561+
'400':
51562+
"$ref": "#/components/responses/bad_request"
51563+
'403':
51564+
"$ref": "#/components/responses/forbidden"
51565+
'500':
51566+
"$ref": "#/components/responses/internal_error"
51567+
'503':
51568+
"$ref": "#/components/responses/service_unavailable"
51569+
x-github:
51570+
githubCloudOnly: false
51571+
enabledForGitHubApps: true
51572+
category: billing
51573+
subcategory: enhanced-billing
5153951574
"/users/{username}/social_accounts":
5154051575
get:
5154151576
summary: List social accounts for a user
@@ -93022,8 +93057,8 @@ components:
9302293057
description: A boolean value representing whether or not alert is base64
9302393058
encoded
9302493059
secret-scanning-alert-resolution-comment:
93025-
description: An optional comment when closing an alert. Cannot be updated or
93026-
deleted. Must be `null` when changing `state` to `open`.
93060+
description: An optional comment when closing or reopening an alert. Cannot
93061+
be updated or deleted.
9302793062
type:
9302893063
- string
9302993064
- 'null'
@@ -95949,6 +95984,54 @@ components:
9594995984
required:
9595095985
- key
9595195986
- id
95987+
billing-usage-report-user:
95988+
type: object
95989+
properties:
95990+
usageItems:
95991+
type: array
95992+
items:
95993+
type: object
95994+
properties:
95995+
date:
95996+
type: string
95997+
description: Date of the usage line item.
95998+
product:
95999+
type: string
96000+
description: Product name.
96001+
sku:
96002+
type: string
96003+
description: SKU name.
96004+
quantity:
96005+
type: integer
96006+
description: Quantity of the usage line item.
96007+
unitType:
96008+
type: string
96009+
description: Unit type of the usage line item.
96010+
pricePerUnit:
96011+
type: number
96012+
description: Price per unit of the usage line item.
96013+
grossAmount:
96014+
type: number
96015+
description: Gross amount of the usage line item.
96016+
discountAmount:
96017+
type: number
96018+
description: Discount amount of the usage line item.
96019+
netAmount:
96020+
type: number
96021+
description: Net amount of the usage line item.
96022+
repositoryName:
96023+
type: string
96024+
description: Name of the repository.
96025+
required:
96026+
- date
96027+
- product
96028+
- sku
96029+
- quantity
96030+
- unitType
96031+
- pricePerUnit
96032+
- grossAmount
96033+
- discountAmount
96034+
- netAmount
9595296035
enterprise-webhooks:
9595396036
title: Enterprise
9595496037
description: |-
@@ -229254,6 +229337,19 @@ components:
229254229337
gravatar_id: ''
229255229338
url: https://api.github.com/orgs/github
229256229339
avatar_url: https://avatars.githubusercontent.com/u/9919?
229340+
billing-usage-report-user:
229341+
value:
229342+
usageItems:
229343+
- date: '2023-08-01'
229344+
product: Actions
229345+
sku: Actions Linux
229346+
quantity: 100
229347+
unitType: minutes
229348+
pricePerUnit: 0.008
229349+
grossAmount: 0.8
229350+
discountAmount: 0
229351+
netAmount: 0.8
229352+
repositoryName: user/example
229257229353
check-run-completed:
229258229354
value:
229259229355
action: completed
@@ -232510,6 +232606,15 @@ components:
232510232606
application/json:
232511232607
schema:
232512232608
"$ref": "#/components/schemas/basic-error"
232609+
billing_usage_report_user:
232610+
description: Response when getting a billing usage report
232611+
content:
232612+
application/json:
232613+
schema:
232614+
"$ref": "#/components/schemas/billing-usage-report-user"
232615+
examples:
232616+
default:
232617+
"$ref": "#/components/examples/billing-usage-report-user"
232513232618
headers:
232514232619
link:
232515232620
example: <https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>;

0 commit comments

Comments
 (0)