Skip to content

Commit b363d03

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent 5c88ff6 commit b363d03

24 files changed

Lines changed: 540 additions & 336 deletions

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28431,7 +28431,7 @@
2843128431
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": {
2843228432
"get": {
2843328433
"summary": "Get route stats by actor",
28434-
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.",
28434+
"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.",
2843528435
"tags": [
2843628436
"orgs"
2843728437
],
@@ -28499,7 +28499,7 @@
2849928499
"/orgs/{org}/insights/api/subject-stats": {
2850028500
"get": {
2850128501
"summary": "Get subject stats",
28502-
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.",
28502+
"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.",
2850328503
"tags": [
2850428504
"orgs"
2850528505
],
@@ -28561,7 +28561,7 @@
2856128561
"/orgs/{org}/insights/api/summary-stats": {
2856228562
"get": {
2856328563
"summary": "Get summary stats",
28564-
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.",
28564+
"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.",
2856528565
"tags": [
2856628566
"orgs"
2856728567
],
@@ -28608,7 +28608,7 @@
2860828608
"/orgs/{org}/insights/api/summary-stats/users/{user_id}": {
2860928609
"get": {
2861028610
"summary": "Get summary stats by user",
28611-
"description": "Get overall statistics of API requests within the organization for a user.",
28611+
"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.",
2861228612
"tags": [
2861328613
"orgs"
2861428614
],
@@ -28658,7 +28658,7 @@
2865828658
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": {
2865928659
"get": {
2866028660
"summary": "Get summary stats by actor",
28661-
"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.",
28661+
"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.",
2866228662
"tags": [
2866328663
"orgs"
2866428664
],
@@ -28711,7 +28711,7 @@
2871128711
"/orgs/{org}/insights/api/time-stats": {
2871228712
"get": {
2871328713
"summary": "Get time stats",
28714-
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.",
28714+
"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.",
2871528715
"tags": [
2871628716
"orgs"
2871728717
],
@@ -28761,7 +28761,7 @@
2876128761
"/orgs/{org}/insights/api/time-stats/users/{user_id}": {
2876228762
"get": {
2876328763
"summary": "Get time stats by user",
28764-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.",
28764+
"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.",
2876528765
"tags": [
2876628766
"orgs"
2876728767
],
@@ -28814,7 +28814,7 @@
2881428814
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": {
2881528815
"get": {
2881628816
"summary": "Get time stats by actor",
28817-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.",
28817+
"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.",
2881828818
"tags": [
2881928819
"orgs"
2882028820
],
@@ -28870,7 +28870,7 @@
2887028870
"/orgs/{org}/insights/api/user-stats/{user_id}": {
2887128871
"get": {
2887228872
"summary": "Get user stats",
28873-
"description": "Get API usage statistics within an organization for a user broken down by the type of access.",
28873+
"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.",
2887428874
"tags": [
2887528875
"orgs"
2887628876
],

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

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21213,8 +21213,10 @@ paths:
2121321213
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}":
2121421214
get:
2121521215
summary: Get route stats by actor
21216-
description: Get API request count statistics for an actor broken down by route
21217-
within a specified time frame.
21216+
description: |-
21217+
Get API request count statistics for an actor broken down by route within a specified time frame.
21218+
21219+
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.
2121821220
tags:
2121921221
- orgs
2122021222
operationId: api-insights/get-route-stats-by-actor
@@ -21249,8 +21251,10 @@ paths:
2124921251
"/orgs/{org}/insights/api/subject-stats":
2125021252
get:
2125121253
summary: Get subject stats
21252-
description: Get API request statistics for all subjects within an organization
21253-
within a specified time frame. Subjects can be users or GitHub Apps.
21254+
description: |-
21255+
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.
21256+
21257+
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.
2125421258
tags:
2125521259
- orgs
2125621260
operationId: api-insights/get-subject-stats
@@ -21283,8 +21287,10 @@ paths:
2128321287
"/orgs/{org}/insights/api/summary-stats":
2128421288
get:
2128521289
summary: Get summary stats
21286-
description: Get overall statistics of API requests made within an organization
21287-
by all users and apps within a specified time frame.
21290+
description: |-
21291+
Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.
21292+
21293+
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.
2128821294
tags:
2128921295
- orgs
2129021296
operationId: api-insights/get-summary-stats
@@ -21312,8 +21318,10 @@ paths:
2131221318
"/orgs/{org}/insights/api/summary-stats/users/{user_id}":
2131321319
get:
2131421320
summary: Get summary stats by user
21315-
description: Get overall statistics of API requests within the organization
21316-
for a user.
21321+
description: |-
21322+
Get overall statistics of API requests within the organization for a user.
21323+
21324+
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.
2131721325
tags:
2131821326
- orgs
2131921327
operationId: api-insights/get-summary-stats-by-user
@@ -21342,9 +21350,10 @@ paths:
2134221350
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}":
2134321351
get:
2134421352
summary: Get summary stats by actor
21345-
description: Get overall statistics of API requests within the organization
21346-
made by a specific actor. Actors can be GitHub App installations, OAuth apps
21347-
or other tokens on behalf of a user.
21353+
description: |-
21354+
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.
21355+
21356+
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.
2134821357
tags:
2134921358
- orgs
2135021359
operationId: api-insights/get-summary-stats-by-actor
@@ -21374,8 +21383,10 @@ paths:
2137421383
"/orgs/{org}/insights/api/time-stats":
2137521384
get:
2137621385
summary: Get time stats
21377-
description: Get the number of API requests and rate-limited requests made within
21378-
an organization over a specified time period.
21386+
description: |-
21387+
Get the number of API requests and rate-limited requests made within an organization over a specified time period.
21388+
21389+
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.
2137921390
tags:
2138021391
- orgs
2138121392
operationId: api-insights/get-time-stats
@@ -21404,8 +21415,10 @@ paths:
2140421415
"/orgs/{org}/insights/api/time-stats/users/{user_id}":
2140521416
get:
2140621417
summary: Get time stats by user
21407-
description: Get the number of API requests and rate-limited requests made within
21408-
an organization by a specific user over a specified time period.
21418+
description: |-
21419+
Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.
21420+
21421+
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.
2140921422
tags:
2141021423
- orgs
2141121424
operationId: api-insights/get-time-stats-by-user
@@ -21435,8 +21448,10 @@ paths:
2143521448
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}":
2143621449
get:
2143721450
summary: Get time stats by actor
21438-
description: Get the number of API requests and rate-limited requests made within
21439-
an organization by a specific actor within a specified time period.
21451+
description: |-
21452+
Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.
21453+
21454+
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.
2144021455
tags:
2144121456
- orgs
2144221457
operationId: api-insights/get-time-stats-by-actor
@@ -21467,8 +21482,10 @@ paths:
2146721482
"/orgs/{org}/insights/api/user-stats/{user_id}":
2146821483
get:
2146921484
summary: Get user stats
21470-
description: Get API usage statistics within an organization for a user broken
21471-
down by the type of access.
21485+
description: |-
21486+
Get API usage statistics within an organization for a user broken down by the type of access.
21487+
21488+
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.
2147221489
tags:
2147321490
- orgs
2147421491
operationId: api-insights/get-user-stats

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28382,7 +28382,7 @@
2838228382
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": {
2838328383
"get": {
2838428384
"summary": "Get route stats by actor",
28385-
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.",
28385+
"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.",
2838628386
"tags": [
2838728387
"orgs"
2838828388
],
@@ -28450,7 +28450,7 @@
2845028450
"/orgs/{org}/insights/api/subject-stats": {
2845128451
"get": {
2845228452
"summary": "Get subject stats",
28453-
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.",
28453+
"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.",
2845428454
"tags": [
2845528455
"orgs"
2845628456
],
@@ -28512,7 +28512,7 @@
2851228512
"/orgs/{org}/insights/api/summary-stats": {
2851328513
"get": {
2851428514
"summary": "Get summary stats",
28515-
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.",
28515+
"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.",
2851628516
"tags": [
2851728517
"orgs"
2851828518
],
@@ -28559,7 +28559,7 @@
2855928559
"/orgs/{org}/insights/api/summary-stats/users/{user_id}": {
2856028560
"get": {
2856128561
"summary": "Get summary stats by user",
28562-
"description": "Get overall statistics of API requests within the organization for a user.",
28562+
"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.",
2856328563
"tags": [
2856428564
"orgs"
2856528565
],
@@ -28609,7 +28609,7 @@
2860928609
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": {
2861028610
"get": {
2861128611
"summary": "Get summary stats by actor",
28612-
"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.",
28612+
"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.",
2861328613
"tags": [
2861428614
"orgs"
2861528615
],
@@ -28662,7 +28662,7 @@
2866228662
"/orgs/{org}/insights/api/time-stats": {
2866328663
"get": {
2866428664
"summary": "Get time stats",
28665-
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.",
28665+
"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.",
2866628666
"tags": [
2866728667
"orgs"
2866828668
],
@@ -28712,7 +28712,7 @@
2871228712
"/orgs/{org}/insights/api/time-stats/users/{user_id}": {
2871328713
"get": {
2871428714
"summary": "Get time stats by user",
28715-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.",
28715+
"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.",
2871628716
"tags": [
2871728717
"orgs"
2871828718
],
@@ -28765,7 +28765,7 @@
2876528765
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": {
2876628766
"get": {
2876728767
"summary": "Get time stats by actor",
28768-
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.",
28768+
"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.",
2876928769
"tags": [
2877028770
"orgs"
2877128771
],
@@ -28821,7 +28821,7 @@
2882128821
"/orgs/{org}/insights/api/user-stats/{user_id}": {
2882228822
"get": {
2882328823
"summary": "Get user stats",
28824-
"description": "Get API usage statistics within an organization for a user broken down by the type of access.",
28824+
"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.",
2882528825
"tags": [
2882628826
"orgs"
2882728827
],

0 commit comments

Comments
 (0)