Skip to content

Commit fa6d3f5

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 5efe9a4 commit fa6d3f5

16 files changed

+29076
-19720
lines changed

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

Lines changed: 455 additions & 2 deletions
Large diffs are not rendered by default.

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

Lines changed: 321 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5113,6 +5113,44 @@ paths:
51135113
enabledForGitHubApps: true
51145114
category: dependabot
51155115
subcategory: repository-access
5116+
"/organizations/{org}/settings/billing/premium_request/usage":
5117+
get:
5118+
summary: Get billing premium request usage report for an organization
5119+
description: Gets a report of premium request usage for an organization. To
5120+
use this endpoint, you must be an administrator of an organization within
5121+
an enterprise or an organization account.
5122+
tags:
5123+
- billing
5124+
operationId: billing/get-github-billing-premium-request-usage-report-org
5125+
externalDocs:
5126+
description: API method documentation
5127+
url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-an-organization
5128+
parameters:
5129+
- "$ref": "#/components/parameters/org"
5130+
- "$ref": "#/components/parameters/billing-usage-report-year"
5131+
- "$ref": "#/components/parameters/billing-usage-report-month-default"
5132+
- "$ref": "#/components/parameters/billing-usage-report-day"
5133+
- "$ref": "#/components/parameters/billing-usage-report-user"
5134+
- "$ref": "#/components/parameters/billing-usage-report-model"
5135+
- "$ref": "#/components/parameters/billing-usage-report-product"
5136+
responses:
5137+
'200':
5138+
"$ref": "#/components/responses/billing_premium_request_usage_report_org"
5139+
'400':
5140+
"$ref": "#/components/responses/bad_request"
5141+
'403':
5142+
"$ref": "#/components/responses/forbidden"
5143+
'404':
5144+
"$ref": "#/components/responses/not_found"
5145+
'500':
5146+
"$ref": "#/components/responses/internal_error"
5147+
'503':
5148+
"$ref": "#/components/responses/service_unavailable"
5149+
x-github:
5150+
githubCloudOnly: false
5151+
enabledForGitHubApps: true
5152+
category: billing
5153+
subcategory: enhanced-billing
51165154
"/organizations/{org}/settings/billing/usage":
51175155
get:
51185156
summary: Get billing usage report for an organization
@@ -54394,6 +54432,41 @@ paths:
5439454432
enabledForGitHubApps: false
5439554433
category: billing
5439654434
subcategory: billing
54435+
"/users/{username}/settings/billing/premium_request/usage":
54436+
get:
54437+
summary: Get billing premium request usage report for a user
54438+
description: Gets a report of premium request usage for a user.
54439+
tags:
54440+
- billing
54441+
operationId: billing/get-github-billing-premium-request-usage-report-user
54442+
externalDocs:
54443+
description: API method documentation
54444+
url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-premium-request-usage-report-for-a-user
54445+
parameters:
54446+
- "$ref": "#/components/parameters/username"
54447+
- "$ref": "#/components/parameters/billing-usage-report-year"
54448+
- "$ref": "#/components/parameters/billing-usage-report-month-default"
54449+
- "$ref": "#/components/parameters/billing-usage-report-day"
54450+
- "$ref": "#/components/parameters/billing-usage-report-model"
54451+
- "$ref": "#/components/parameters/billing-usage-report-product"
54452+
responses:
54453+
'200':
54454+
"$ref": "#/components/responses/billing_premium_request_usage_report_user"
54455+
'400':
54456+
"$ref": "#/components/responses/bad_request"
54457+
'403':
54458+
"$ref": "#/components/responses/forbidden"
54459+
'404':
54460+
"$ref": "#/components/responses/not_found"
54461+
'500':
54462+
"$ref": "#/components/responses/internal_error"
54463+
'503':
54464+
"$ref": "#/components/responses/service_unavailable"
54465+
x-github:
54466+
githubCloudOnly: false
54467+
enabledForGitHubApps: true
54468+
category: billing
54469+
subcategory: enhanced-billing
5439754470
"/users/{username}/settings/billing/shared-storage":
5439854471
get:
5439954472
summary: Get shared storage billing for a user
@@ -78671,6 +78744,89 @@ components:
7867178744
items:
7867278745
"$ref": "#/components/schemas/nullable-simple-repository"
7867378746
additionalProperties: false
78747+
billing-premium-request-usage-report-org:
78748+
type: object
78749+
properties:
78750+
timePeriod:
78751+
type: object
78752+
properties:
78753+
year:
78754+
type: integer
78755+
description: The year for the usage report.
78756+
month:
78757+
type: integer
78758+
description: The month for the usage report.
78759+
day:
78760+
type: integer
78761+
description: The day for the usage report.
78762+
required:
78763+
- year
78764+
organization:
78765+
type: string
78766+
description: The unique identifier of the organization.
78767+
user:
78768+
type: string
78769+
description: The name of the user for the usage report.
78770+
product:
78771+
type: string
78772+
description: The product for the usage report.
78773+
model:
78774+
type: string
78775+
description: The model for the usage report.
78776+
usageItems:
78777+
type: array
78778+
items:
78779+
type: object
78780+
properties:
78781+
product:
78782+
type: string
78783+
description: Product name.
78784+
sku:
78785+
type: string
78786+
description: SKU name.
78787+
model:
78788+
type: string
78789+
description: Model name.
78790+
unitType:
78791+
type: string
78792+
description: Unit type of the usage line item.
78793+
pricePerUnit:
78794+
type: number
78795+
description: Price per unit of the usage line item.
78796+
grossQuantity:
78797+
type: integer
78798+
description: Gross quantity of the usage line item.
78799+
grossAmount:
78800+
type: number
78801+
description: Gross amount of the usage line item.
78802+
discountQuantity:
78803+
type: integer
78804+
description: Discount quantity of the usage line item.
78805+
discountAmount:
78806+
type: number
78807+
description: Discount amount of the usage line item.
78808+
netQuantity:
78809+
type: integer
78810+
description: Net quantity of the usage line item.
78811+
netAmount:
78812+
type: number
78813+
description: Net amount of the usage line item.
78814+
required:
78815+
- product
78816+
- sku
78817+
- model
78818+
- unitType
78819+
- pricePerUnit
78820+
- grossQuantity
78821+
- grossAmount
78822+
- discountQuantity
78823+
- discountAmount
78824+
- netQuantity
78825+
- netAmount
78826+
required:
78827+
- timePeriod
78828+
- organization
78829+
- usageItems
7867478830
billing-usage-report:
7867578831
type: object
7867678832
properties:
@@ -99400,6 +99556,86 @@ components:
9940099556
required:
9940199557
- key
9940299558
- id
99559+
billing-premium-request-usage-report-user:
99560+
type: object
99561+
properties:
99562+
timePeriod:
99563+
type: object
99564+
properties:
99565+
year:
99566+
type: integer
99567+
description: The year for the usage report.
99568+
month:
99569+
type: integer
99570+
description: The month for the usage report.
99571+
day:
99572+
type: integer
99573+
description: The day for the usage report.
99574+
required:
99575+
- year
99576+
user:
99577+
type: string
99578+
description: The unique identifier of the user.
99579+
product:
99580+
type: string
99581+
description: The product for the usage report.
99582+
model:
99583+
type: string
99584+
description: The model for the usage report.
99585+
usageItems:
99586+
type: array
99587+
items:
99588+
type: object
99589+
properties:
99590+
product:
99591+
type: string
99592+
description: Product name.
99593+
sku:
99594+
type: string
99595+
description: SKU name.
99596+
model:
99597+
type: string
99598+
description: Model name.
99599+
unitType:
99600+
type: string
99601+
description: Unit type of the usage line item.
99602+
pricePerUnit:
99603+
type: number
99604+
description: Price per unit of the usage line item.
99605+
grossQuantity:
99606+
type: integer
99607+
description: Gross quantity of the usage line item.
99608+
grossAmount:
99609+
type: number
99610+
description: Gross amount of the usage line item.
99611+
discountQuantity:
99612+
type: integer
99613+
description: Discount quantity of the usage line item.
99614+
discountAmount:
99615+
type: number
99616+
description: Discount amount of the usage line item.
99617+
netQuantity:
99618+
type: integer
99619+
description: Net quantity of the usage line item.
99620+
netAmount:
99621+
type: number
99622+
description: Net amount of the usage line item.
99623+
required:
99624+
- product
99625+
- sku
99626+
- model
99627+
- unitType
99628+
- pricePerUnit
99629+
- grossQuantity
99630+
- grossAmount
99631+
- discountQuantity
99632+
- discountAmount
99633+
- netQuantity
99634+
- netAmount
99635+
required:
99636+
- timePeriod
99637+
- user
99638+
- usageItems
9940399639
billing-usage-report-user:
9940499640
type: object
9940599641
properties:
@@ -209745,6 +209981,23 @@ components:
209745209981
teams_url: https://api.github.com/repos/octocat/example-repo/teams
209746209982
trees_url: https://api.github.com/repos/octocat/example-repo/git/trees{/sha}
209747209983
hooks_url: https://api.github.com/repos/octocat/example-repo/hooks
209984+
billing-premium-request-usage-report-org:
209985+
value:
209986+
timePeriod:
209987+
year: 2025
209988+
organization: GitHub
209989+
usageItems:
209990+
- product: Copilot
209991+
sku: Copilot Premium Request
209992+
model: GPT-5
209993+
unitType: requests
209994+
pricePerUnit: 0.04
209995+
grossQuantity: 100
209996+
grossAmount: 4.0
209997+
discountQuantity: 0
209998+
discountAmount: 0.0
209999+
netQuantity: 100
210000+
netAmount: 4.0
209748210001
billing-usage-report:
209749210002
value:
209750210003
usageItems:
@@ -231579,6 +231832,23 @@ components:
231579231832
gravatar_id: ''
231580231833
url: https://api.github.com/orgs/github
231581231834
avatar_url: https://avatars.githubusercontent.com/u/9919?
231835+
billing-premium-request-usage-report-user:
231836+
value:
231837+
timePeriod:
231838+
year: 2025
231839+
user: monalisa
231840+
usageItems:
231841+
- product: Copilot
231842+
sku: Copilot Premium Request
231843+
model: GPT-5
231844+
unitType: requests
231845+
pricePerUnit: 0.04
231846+
grossQuantity: 100
231847+
grossAmount: 4.0
231848+
discountQuantity: 0
231849+
discountAmount: 0.0
231850+
netQuantity: 100
231851+
netAmount: 4.0
231582231852
billing-usage-report-user:
231583231853
value:
231584231854
usageItems:
@@ -233520,11 +233790,11 @@ components:
233520233790
required: false
233521233791
schema:
233522233792
type: integer
233523-
billing-usage-report-month:
233793+
billing-usage-report-month-default:
233524233794
name: month
233525233795
description: If specified, only return results for a single month. The value
233526-
of `month` is an integer between `1` and `12`. If no year is specified the
233527-
default `year` is used.
233796+
of `month` is an integer between `1` and `12`. Default value is the current
233797+
month. If no year is specified the default `year` is used.
233528233798
in: query
233529233799
required: false
233530233800
schema:
@@ -233538,6 +233808,36 @@ components:
233538233808
required: false
233539233809
schema:
233540233810
type: integer
233811+
billing-usage-report-user:
233812+
name: user
233813+
description: The user name to query usage for. The name is not case sensitive.
233814+
in: query
233815+
required: false
233816+
schema:
233817+
type: string
233818+
billing-usage-report-model:
233819+
name: model
233820+
description: The model name to query usage for. The name is not case sensitive.
233821+
in: query
233822+
required: false
233823+
schema:
233824+
type: string
233825+
billing-usage-report-product:
233826+
name: product
233827+
description: The product name to query usage for. The name is not case sensitive.
233828+
in: query
233829+
required: false
233830+
schema:
233831+
type: string
233832+
billing-usage-report-month:
233833+
name: month
233834+
description: If specified, only return results for a single month. The value
233835+
of `month` is an integer between `1` and `12`. If no year is specified the
233836+
default `year` is used.
233837+
in: query
233838+
required: false
233839+
schema:
233840+
type: integer
233541233841
billing-usage-report-hour:
233542233842
name: hour
233543233843
description: If specified, only return results for a single hour. The value
@@ -234749,6 +235049,15 @@ components:
234749235049
application/json:
234750235050
schema:
234751235051
"$ref": "#/components/schemas/basic-error"
235052+
billing_premium_request_usage_report_org:
235053+
description: Response when getting a billing premium request usage report
235054+
content:
235055+
application/json:
235056+
schema:
235057+
"$ref": "#/components/schemas/billing-premium-request-usage-report-org"
235058+
examples:
235059+
default:
235060+
"$ref": "#/components/examples/billing-premium-request-usage-report-org"
234752235061
billing_usage_report_org:
234753235062
description: Billing usage report response for an organization
234754235063
content:
@@ -234906,6 +235215,15 @@ components:
234906235215
application/json:
234907235216
schema:
234908235217
"$ref": "#/components/schemas/basic-error"
235218+
billing_premium_request_usage_report_user:
235219+
description: Response when getting a billing premium request usage report
235220+
content:
235221+
application/json:
235222+
schema:
235223+
"$ref": "#/components/schemas/billing-premium-request-usage-report-user"
235224+
examples:
235225+
default:
235226+
"$ref": "#/components/examples/billing-premium-request-usage-report-user"
234909235227
billing_usage_report_user:
234910235228
description: Response when getting a billing usage report
234911235229
content:

0 commit comments

Comments
 (0)