Skip to content

Commit 7ef2c83

Browse files
docs-botmchammer01
docs-bot
and
mchammer01
authored
Update OpenAPI Description (#55480)
Co-authored-by: mc <[email protected]>
1 parent 54fac9b commit 7ef2c83

File tree

14 files changed

+452
-6
lines changed

14 files changed

+452
-6
lines changed

‎src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8222,6 +8222,15 @@
82228222
"requestPath": "/users/{username}/settings/billing/shared-storage",
82238223
"additional-permissions": false,
82248224
"access": "read"
8225+
},
8226+
{
8227+
"category": "billing",
8228+
"slug": "get-billing-usage-report-for-a-user",
8229+
"subcategory": "enhanced-billing",
8230+
"verb": "get",
8231+
"requestPath": "/users/{username}/settings/billing/usage",
8232+
"additional-permissions": false,
8233+
"access": "read"
82258234
}
82268235
]
82278236
},

‎src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,6 +1085,12 @@
10851085
"subcategory": "billing",
10861086
"verb": "get",
10871087
"requestPath": "/users/{username}/settings/billing/shared-storage"
1088+
},
1089+
{
1090+
"slug": "get-billing-usage-report-for-a-user",
1091+
"subcategory": "enhanced-billing",
1092+
"verb": "get",
1093+
"requestPath": "/users/{username}/settings/billing/usage"
10881094
}
10891095
],
10901096
"branches": [

‎src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9981,6 +9981,17 @@
99819981
"user-to-server": true,
99829982
"server-to-server": false,
99839983
"additional-permissions": false
9984+
},
9985+
{
9986+
"category": "billing",
9987+
"slug": "get-billing-usage-report-for-a-user",
9988+
"subcategory": "enhanced-billing",
9989+
"verb": "get",
9990+
"requestPath": "/users/{username}/settings/billing/usage",
9991+
"access": "read",
9992+
"user-to-server": true,
9993+
"server-to-server": false,
9994+
"additional-permissions": false
99849995
}
99859996
]
99869997
},

‎src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,6 +1085,12 @@
10851085
"subcategory": "billing",
10861086
"verb": "get",
10871087
"requestPath": "/users/{username}/settings/billing/shared-storage"
1088+
},
1089+
{
1090+
"slug": "get-billing-usage-report-for-a-user",
1091+
"subcategory": "enhanced-billing",
1092+
"verb": "get",
1093+
"requestPath": "/users/{username}/settings/billing/usage"
10881094
}
10891095
],
10901096
"branches": [

‎src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8921,6 +8921,15 @@
89218921
"requestPath": "/users/{username}/settings/billing/shared-storage",
89228922
"additional-permissions": false,
89238923
"access": "read"
8924+
},
8925+
{
8926+
"category": "billing",
8927+
"slug": "get-billing-usage-report-for-a-user",
8928+
"subcategory": "enhanced-billing",
8929+
"verb": "get",
8930+
"requestPath": "/users/{username}/settings/billing/usage",
8931+
"additional-permissions": false,
8932+
"access": "read"
89248933
}
89258934
]
89268935
},

‎src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,6 +1123,12 @@
11231123
"subcategory": "billing",
11241124
"verb": "get",
11251125
"requestPath": "/users/{username}/settings/billing/shared-storage"
1126+
},
1127+
{
1128+
"slug": "get-billing-usage-report-for-a-user",
1129+
"subcategory": "enhanced-billing",
1130+
"verb": "get",
1131+
"requestPath": "/users/{username}/settings/billing/usage"
11261132
}
11271133
],
11281134
"branches": [

‎src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10830,6 +10830,17 @@
1083010830
"user-to-server": true,
1083110831
"server-to-server": false,
1083210832
"additional-permissions": false
10833+
},
10834+
{
10835+
"category": "billing",
10836+
"slug": "get-billing-usage-report-for-a-user",
10837+
"subcategory": "enhanced-billing",
10838+
"verb": "get",
10839+
"requestPath": "/users/{username}/settings/billing/usage",
10840+
"access": "read",
10841+
"user-to-server": true,
10842+
"server-to-server": false,
10843+
"additional-permissions": false
1083310844
}
1083410845
]
1083510846
},

‎src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1123,6 +1123,12 @@
11231123
"subcategory": "billing",
11241124
"verb": "get",
11251125
"requestPath": "/users/{username}/settings/billing/shared-storage"
1126+
},
1127+
{
1128+
"slug": "get-billing-usage-report-for-a-user",
1129+
"subcategory": "enhanced-billing",
1130+
"verb": "get",
1131+
"requestPath": "/users/{username}/settings/billing/usage"
11261132
}
11271133
],
11281134
"branches": [

‎src/github-apps/lib/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "1c22f3361af92533fad97262cf4b7c18574f22a6"
63+
"sha": "467f6a98a97a73630a1f1e75ddee01cb59f33dd5"
6464
}

‎src/rest/data/fpt-2022-11-28/schema.json‎

Lines changed: 192 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109554,6 +109554,193 @@
109554109554
"description": "<p>Service unavailable</p>"
109555109555
}
109556109556
]
109557+
},
109558+
{
109559+
"serverUrl": "https://api.github.com",
109560+
"verb": "get",
109561+
"requestPath": "/users/{username}/settings/billing/usage",
109562+
"title": "Get billing usage report for a user",
109563+
"category": "billing",
109564+
"subcategory": "enhanced-billing",
109565+
"parameters": [
109566+
{
109567+
"name": "username",
109568+
"description": "<p>The handle for the GitHub user account.</p>",
109569+
"in": "path",
109570+
"required": true,
109571+
"schema": {
109572+
"type": "string"
109573+
}
109574+
},
109575+
{
109576+
"name": "year",
109577+
"description": "<p>If specified, only return results for a single year. The value of <code>year</code> is an integer with four digits representing a year. For example, <code>2025</code>. Default value is the current year.</p>",
109578+
"in": "query",
109579+
"required": false,
109580+
"schema": {
109581+
"type": "integer"
109582+
}
109583+
},
109584+
{
109585+
"name": "month",
109586+
"description": "<p>If specified, only return results for a single month. The value of <code>month</code> is an integer between <code>1</code> and <code>12</code>. If no year is specified the default <code>year</code> is used.</p>",
109587+
"in": "query",
109588+
"required": false,
109589+
"schema": {
109590+
"type": "integer"
109591+
}
109592+
},
109593+
{
109594+
"name": "day",
109595+
"description": "<p>If specified, only return results for a single day. The value of <code>day</code> is an integer between <code>1</code> and <code>31</code>. If no <code>year</code> or <code>month</code> is specified, the default <code>year</code> and <code>month</code> are used.</p>",
109596+
"in": "query",
109597+
"required": false,
109598+
"schema": {
109599+
"type": "integer"
109600+
}
109601+
},
109602+
{
109603+
"name": "hour",
109604+
"description": "<p>If specified, only return results for a single hour. The value of <code>hour</code> is an integer between <code>0</code> and <code>23</code>. If no <code>year</code>, <code>month</code>, or <code>day</code> is specified, the default <code>year</code>, <code>month</code>, and <code>day</code> are used.</p>",
109605+
"in": "query",
109606+
"required": false,
109607+
"schema": {
109608+
"type": "integer"
109609+
}
109610+
}
109611+
],
109612+
"bodyParameters": [],
109613+
"progAccess": {
109614+
"userToServerRest": true,
109615+
"serverToServer": false,
109616+
"fineGrainedPat": true,
109617+
"permissions": [
109618+
{
109619+
"\"Plan\" user permissions": "read"
109620+
}
109621+
]
109622+
},
109623+
"codeExamples": [
109624+
{
109625+
"key": "default",
109626+
"request": {
109627+
"description": "Example",
109628+
"acceptHeader": "application/vnd.github.v3+json",
109629+
"parameters": {
109630+
"username": "USERNAME"
109631+
}
109632+
},
109633+
"response": {
109634+
"statusCode": "200",
109635+
"contentType": "application/json",
109636+
"description": "<p>Response when getting a billing usage report</p>",
109637+
"example": {
109638+
"usageItems": [
109639+
{
109640+
"date": "2023-08-01",
109641+
"product": "Actions",
109642+
"sku": "Actions Linux",
109643+
"quantity": 100,
109644+
"unitType": "minutes",
109645+
"pricePerUnit": 0.008,
109646+
"grossAmount": 0.8,
109647+
"discountAmount": 0,
109648+
"netAmount": 0.8,
109649+
"repositoryName": "user/example"
109650+
}
109651+
]
109652+
},
109653+
"schema": {
109654+
"type": "object",
109655+
"properties": {
109656+
"usageItems": {
109657+
"type": "array",
109658+
"items": {
109659+
"type": "object",
109660+
"properties": {
109661+
"date": {
109662+
"type": "string",
109663+
"description": "Date of the usage line item."
109664+
},
109665+
"product": {
109666+
"type": "string",
109667+
"description": "Product name."
109668+
},
109669+
"sku": {
109670+
"type": "string",
109671+
"description": "SKU name."
109672+
},
109673+
"quantity": {
109674+
"type": "integer",
109675+
"description": "Quantity of the usage line item."
109676+
},
109677+
"unitType": {
109678+
"type": "string",
109679+
"description": "Unit type of the usage line item."
109680+
},
109681+
"pricePerUnit": {
109682+
"type": "number",
109683+
"description": "Price per unit of the usage line item."
109684+
},
109685+
"grossAmount": {
109686+
"type": "number",
109687+
"description": "Gross amount of the usage line item."
109688+
},
109689+
"discountAmount": {
109690+
"type": "number",
109691+
"description": "Discount amount of the usage line item."
109692+
},
109693+
"netAmount": {
109694+
"type": "number",
109695+
"description": "Net amount of the usage line item."
109696+
},
109697+
"repositoryName": {
109698+
"type": "string",
109699+
"description": "Name of the repository."
109700+
}
109701+
},
109702+
"required": [
109703+
"date",
109704+
"product",
109705+
"sku",
109706+
"quantity",
109707+
"unitType",
109708+
"pricePerUnit",
109709+
"grossAmount",
109710+
"discountAmount",
109711+
"netAmount"
109712+
]
109713+
}
109714+
}
109715+
}
109716+
}
109717+
}
109718+
}
109719+
],
109720+
"previews": [],
109721+
"descriptionHTML": "<p>Gets a report of the total usage for a user.</p>\n<p><strong>Note:</strong> This endpoint is only available to users with access to the enhanced billing platform.</p>",
109722+
"statusCodes": [
109723+
{
109724+
"httpStatusCode": "200",
109725+
"description": "<p>Response when getting a billing usage report</p>"
109726+
},
109727+
{
109728+
"httpStatusCode": "400",
109729+
"description": "<p>Bad Request</p>"
109730+
},
109731+
{
109732+
"httpStatusCode": "403",
109733+
"description": "<p>Forbidden</p>"
109734+
},
109735+
{
109736+
"httpStatusCode": "500",
109737+
"description": "<p>Internal Error</p>"
109738+
},
109739+
{
109740+
"httpStatusCode": "503",
109741+
"description": "<p>Service unavailable</p>"
109742+
}
109743+
]
109557109744
}
109558109745
]
109559109746
},
@@ -163542,6 +163729,10 @@
163542163729
"httpStatusCode": "404",
163543163730
"description": "<p>Resource not found</p>"
163544163731
},
163732+
{
163733+
"httpStatusCode": "422",
163734+
"description": "<p>Response if analysis could not be processed</p>"
163735+
},
163545163736
{
163546163737
"httpStatusCode": "503",
163547163738
"description": "<p>Service unavailable</p>"
@@ -566367,7 +566558,7 @@
566367566558
"type": "string or null",
566368566559
"name": "resolution_comment",
566369566560
"in": "body",
566370-
"description": "<p>An optional comment when closing an alert. Cannot be updated or deleted. Must be <code>null</code> when changing <code>state</code> to <code>open</code>.</p>"
566561+
"description": "<p>An optional comment when closing or reopening an alert. Cannot be updated or deleted.</p>"
566371566562
}
566372566563
],
566373566564
"progAccess": {

0 commit comments

Comments
 (0)