Skip to content

Commit 81936da

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent 5c88ff6 commit 81936da

24 files changed

Lines changed: 540 additions & 336 deletions

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28287,7 +28287,7 @@
2828728287
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": {
2828828288
"get": {
2828928289
"summary": "Get route stats by actor",
28290-
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.",
28290+
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2829128291
"tags": [
2829228292
"orgs"
2829328293
],
@@ -28355,7 +28355,7 @@
2835528355
"/orgs/{org}/insights/api/subject-stats": {
2835628356
"get": {
2835728357
"summary": "Get subject stats",
28358-
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.",
28358+
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2835928359
"tags": [
2836028360
"orgs"
2836128361
],
@@ -28417,7 +28417,7 @@
2841728417
"/orgs/{org}/insights/api/summary-stats": {
2841828418
"get": {
2841928419
"summary": "Get summary stats",
28420-
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.",
28420+
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2842128421
"tags": [
2842228422
"orgs"
2842328423
],
@@ -28464,7 +28464,7 @@
2846428464
"/orgs/{org}/insights/api/summary-stats/users/{user_id}": {
2846528465
"get": {
2846628466
"summary": "Get summary stats by user",
28467-
"description": "Get overall statistics of API requests within the organization for a user.",
28467+
"description": "Get overall statistics of API requests within the organization for a user.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2846828468
"tags": [
2846928469
"orgs"
2847028470
],
@@ -28514,7 +28514,7 @@
2851428514
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": {
2851528515
"get": {
2851628516
"summary": "Get summary stats by actor",
28517-
"description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.",
28517+
"description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2851828518
"tags": [
2851928519
"orgs"
2852028520
],
@@ -28567,7 +28567,7 @@
2856728567
"/orgs/{org}/insights/api/time-stats": {
2856828568
"get": {
2856928569
"summary": "Get time stats",
28570-
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.",
28570+
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2857128571
"tags": [
2857228572
"orgs"
2857328573
],
@@ -28617,7 +28617,7 @@
2861728617
"/orgs/{org}/insights/api/time-stats/users/{user_id}": {
2861828618
"get": {
2861928619
"summary": "Get time stats by user",
28620-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.",
28620+
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2862128621
"tags": [
2862228622
"orgs"
2862328623
],
@@ -28670,7 +28670,7 @@
2867028670
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": {
2867128671
"get": {
2867228672
"summary": "Get time stats by actor",
28673-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.",
28673+
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2867428674
"tags": [
2867528675
"orgs"
2867628676
],
@@ -28726,7 +28726,7 @@
2872628726
"/orgs/{org}/insights/api/user-stats/{user_id}": {
2872728727
"get": {
2872828728
"summary": "Get user stats",
28729-
"description": "Get API usage statistics within an organization for a user broken down by the type of access.",
28729+
"description": "Get API usage statistics within an organization for a user broken down by the type of access.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2873028730
"tags": [
2873128731
"orgs"
2873228732
],

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

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21143,8 +21143,10 @@ paths:
2114321143
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}":
2114421144
get:
2114521145
summary: Get route stats by actor
21146-
description: Get API request count statistics for an actor broken down by route
21147-
within a specified time frame.
21146+
description: |-
21147+
Get API request count statistics for an actor broken down by route within a specified time frame.
21148+
21149+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2114821150
tags:
2114921151
- orgs
2115021152
operationId: api-insights/get-route-stats-by-actor
@@ -21179,8 +21181,10 @@ paths:
2117921181
"/orgs/{org}/insights/api/subject-stats":
2118021182
get:
2118121183
summary: Get subject stats
21182-
description: Get API request statistics for all subjects within an organization
21183-
within a specified time frame. Subjects can be users or GitHub Apps.
21184+
description: |-
21185+
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
21186+
21187+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2118421188
tags:
2118521189
- orgs
2118621190
operationId: api-insights/get-subject-stats
@@ -21213,8 +21217,10 @@ paths:
2121321217
"/orgs/{org}/insights/api/summary-stats":
2121421218
get:
2121521219
summary: Get summary stats
21216-
description: Get overall statistics of API requests made within an organization
21217-
by all users and apps within a specified time frame.
21220+
description: |-
21221+
Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
21222+
21223+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2121821224
tags:
2121921225
- orgs
2122021226
operationId: api-insights/get-summary-stats
@@ -21242,8 +21248,10 @@ paths:
2124221248
"/orgs/{org}/insights/api/summary-stats/users/{user_id}":
2124321249
get:
2124421250
summary: Get summary stats by user
21245-
description: Get overall statistics of API requests within the organization
21246-
for a user.
21251+
description: |-
21252+
Get overall statistics of API requests within the organization for a user.
21253+
21254+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2124721255
tags:
2124821256
- orgs
2124921257
operationId: api-insights/get-summary-stats-by-user
@@ -21272,9 +21280,10 @@ paths:
2127221280
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}":
2127321281
get:
2127421282
summary: Get summary stats by actor
21275-
description: Get overall statistics of API requests within the organization
21276-
made by a specific actor. Actors can be GitHub App installations, OAuth apps
21277-
or other tokens on behalf of a user.
21283+
description: |-
21284+
Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.
21285+
21286+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2127821287
tags:
2127921288
- orgs
2128021289
operationId: api-insights/get-summary-stats-by-actor
@@ -21304,8 +21313,10 @@ paths:
2130421313
"/orgs/{org}/insights/api/time-stats":
2130521314
get:
2130621315
summary: Get time stats
21307-
description: Get the number of API requests and rate-limited requests made within
21308-
an organization over a specified time period.
21316+
description: |-
21317+
Get the number of API requests and rate-limited requests made within an organization over a specified time period.
21318+
21319+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2130921320
tags:
2131021321
- orgs
2131121322
operationId: api-insights/get-time-stats
@@ -21334,8 +21345,10 @@ paths:
2133421345
"/orgs/{org}/insights/api/time-stats/users/{user_id}":
2133521346
get:
2133621347
summary: Get time stats by user
21337-
description: Get the number of API requests and rate-limited requests made within
21338-
an organization by a specific user over a specified time period.
21348+
description: |-
21349+
Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
21350+
21351+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2133921352
tags:
2134021353
- orgs
2134121354
operationId: api-insights/get-time-stats-by-user
@@ -21365,8 +21378,10 @@ paths:
2136521378
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}":
2136621379
get:
2136721380
summary: Get time stats by actor
21368-
description: Get the number of API requests and rate-limited requests made within
21369-
an organization by a specific actor within a specified time period.
21381+
description: |-
21382+
Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
21383+
21384+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2137021385
tags:
2137121386
- orgs
2137221387
operationId: api-insights/get-time-stats-by-actor
@@ -21397,8 +21412,10 @@ paths:
2139721412
"/orgs/{org}/insights/api/user-stats/{user_id}":
2139821413
get:
2139921414
summary: Get user stats
21400-
description: Get API usage statistics within an organization for a user broken
21401-
down by the type of access.
21415+
description: |-
21416+
Get API usage statistics within an organization for a user broken down by the type of access.
21417+
21418+
Under normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.
2140221419
tags:
2140321420
- orgs
2140421421
operationId: api-insights/get-user-stats

‎descriptions/api.github.com/api.github.com.2026-03-10.json‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28240,7 +28240,7 @@
2824028240
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": {
2824128241
"get": {
2824228242
"summary": "Get route stats by actor",
28243-
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.",
28243+
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2824428244
"tags": [
2824528245
"orgs"
2824628246
],
@@ -28308,7 +28308,7 @@
2830828308
"/orgs/{org}/insights/api/subject-stats": {
2830928309
"get": {
2831028310
"summary": "Get subject stats",
28311-
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.",
28311+
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2831228312
"tags": [
2831328313
"orgs"
2831428314
],
@@ -28370,7 +28370,7 @@
2837028370
"/orgs/{org}/insights/api/summary-stats": {
2837128371
"get": {
2837228372
"summary": "Get summary stats",
28373-
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.",
28373+
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2837428374
"tags": [
2837528375
"orgs"
2837628376
],
@@ -28417,7 +28417,7 @@
2841728417
"/orgs/{org}/insights/api/summary-stats/users/{user_id}": {
2841828418
"get": {
2841928419
"summary": "Get summary stats by user",
28420-
"description": "Get overall statistics of API requests within the organization for a user.",
28420+
"description": "Get overall statistics of API requests within the organization for a user.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2842128421
"tags": [
2842228422
"orgs"
2842328423
],
@@ -28467,7 +28467,7 @@
2846728467
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": {
2846828468
"get": {
2846928469
"summary": "Get summary stats by actor",
28470-
"description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.",
28470+
"description": "Get overall statistics of API requests within the organization made by a specific actor. Actors can be GitHub App installations, OAuth apps or other tokens on behalf of a user.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2847128471
"tags": [
2847228472
"orgs"
2847328473
],
@@ -28520,7 +28520,7 @@
2852028520
"/orgs/{org}/insights/api/time-stats": {
2852128521
"get": {
2852228522
"summary": "Get time stats",
28523-
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.",
28523+
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2852428524
"tags": [
2852528525
"orgs"
2852628526
],
@@ -28570,7 +28570,7 @@
2857028570
"/orgs/{org}/insights/api/time-stats/users/{user_id}": {
2857128571
"get": {
2857228572
"summary": "Get time stats by user",
28573-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.",
28573+
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2857428574
"tags": [
2857528575
"orgs"
2857628576
],
@@ -28623,7 +28623,7 @@
2862328623
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": {
2862428624
"get": {
2862528625
"summary": "Get time stats by actor",
28626-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.",
28626+
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2862728627
"tags": [
2862828628
"orgs"
2862928629
],
@@ -28679,7 +28679,7 @@
2867928679
"/orgs/{org}/insights/api/user-stats/{user_id}": {
2868028680
"get": {
2868128681
"summary": "Get user stats",
28682-
"description": "Get API usage statistics within an organization for a user broken down by the type of access.",
28682+
"description": "Get API usage statistics within an organization for a user broken down by the type of access.\n\nUnder normal conditions, you can expect API data to appear within 4–6 hours after making a request. During incidents or periods of unusually high volume, it may take longer to show up.",
2868328683
"tags": [
2868428684
"orgs"
2868528685
],

0 commit comments

Comments
 (0)