Skip to content

Update OpenAPI 3.1 Descriptions #6852

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
github-openapi-bot wants to merge 1 commit into from
Closed

Update OpenAPI 3.1 Descriptions #6852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28431,7 +28431,7 @@
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": {
"get": {
"summary": "Get route stats by actor",
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28499,7 +28499,7 @@
"/orgs/{org}/insights/api/subject-stats": {
"get": {
"summary": "Get subject stats",
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28561,7 +28561,7 @@
"/orgs/{org}/insights/api/summary-stats": {
"get": {
"summary": "Get summary stats",
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28608,7 +28608,7 @@
"/orgs/{org}/insights/api/summary-stats/users/{user_id}": {
"get": {
"summary": "Get summary stats by user",
"description": "Get overall statistics of API requests within the organization for a user.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28658,7 +28658,7 @@
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": {
"get": {
"summary": "Get summary stats by actor",
"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.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28711,7 +28711,7 @@
"/orgs/{org}/insights/api/time-stats": {
"get": {
"summary": "Get time stats",
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28761,7 +28761,7 @@
"/orgs/{org}/insights/api/time-stats/users/{user_id}": {
"get": {
"summary": "Get time stats by user",
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28814,7 +28814,7 @@
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": {
"get": {
"summary": "Get time stats by actor",
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28870,7 +28870,7 @@
"/orgs/{org}/insights/api/user-stats/{user_id}": {
"get": {
"summary": "Get user stats",
"description": "Get API usage statistics within an organization for a user broken down by the type of access.",
"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.",
"tags": [
"orgs"
],
Expand Down
55 changes: 36 additions & 19 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21213,8 +21213,10 @@ paths:
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}":
get:
summary: Get route stats by actor
description: Get API request count statistics for an actor broken down by route
within a specified time frame.
description: |-
Get API request count statistics for an actor broken down by route within a specified time frame.

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.
tags:
- orgs
operationId: api-insights/get-route-stats-by-actor
Expand Down Expand Up @@ -21249,8 +21251,10 @@ paths:
"/orgs/{org}/insights/api/subject-stats":
get:
summary: Get subject stats
description: Get API request statistics for all subjects within an organization
within a specified time frame. Subjects can be users or GitHub Apps.
description: |-
Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.

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.
tags:
- orgs
operationId: api-insights/get-subject-stats
Expand Down Expand Up @@ -21283,8 +21287,10 @@ paths:
"/orgs/{org}/insights/api/summary-stats":
get:
summary: Get summary stats
description: Get overall statistics of API requests made within an organization
by all users and apps within a specified time frame.
description: |-
Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.

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.
tags:
- orgs
operationId: api-insights/get-summary-stats
Expand Down Expand Up @@ -21312,8 +21318,10 @@ paths:
"/orgs/{org}/insights/api/summary-stats/users/{user_id}":
get:
summary: Get summary stats by user
description: Get overall statistics of API requests within the organization
for a user.
description: |-
Get overall statistics of API requests within the organization for a user.

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.
tags:
- orgs
operationId: api-insights/get-summary-stats-by-user
Expand Down Expand Up @@ -21342,9 +21350,10 @@ paths:
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}":
get:
summary: Get summary stats by actor
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.
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.

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.
tags:
- orgs
operationId: api-insights/get-summary-stats-by-actor
Expand Down Expand Up @@ -21374,8 +21383,10 @@ paths:
"/orgs/{org}/insights/api/time-stats":
get:
summary: Get time stats
description: Get the number of API requests and rate-limited requests made within
an organization over a specified time period.
description: |-
Get the number of API requests and rate-limited requests made within an organization over a specified time period.

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.
tags:
- orgs
operationId: api-insights/get-time-stats
Expand Down Expand Up @@ -21404,8 +21415,10 @@ paths:
"/orgs/{org}/insights/api/time-stats/users/{user_id}":
get:
summary: Get time stats by user
description: Get the number of API requests and rate-limited requests made within
an organization by a specific user over a specified time period.
description: |-
Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.

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.
tags:
- orgs
operationId: api-insights/get-time-stats-by-user
Expand Down Expand Up @@ -21435,8 +21448,10 @@ paths:
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}":
get:
summary: Get time stats by actor
description: Get the number of API requests and rate-limited requests made within
an organization by a specific actor within a specified time period.
description: |-
Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.

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.
tags:
- orgs
operationId: api-insights/get-time-stats-by-actor
Expand Down Expand Up @@ -21467,8 +21482,10 @@ paths:
"/orgs/{org}/insights/api/user-stats/{user_id}":
get:
summary: Get user stats
description: Get API usage statistics within an organization for a user broken
down by the type of access.
description: |-
Get API usage statistics within an organization for a user broken down by the type of access.

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.
tags:
- orgs
operationId: api-insights/get-user-stats
Expand Down
18 changes: 9 additions & 9 deletions descriptions-next/api.github.com/api.github.com.2026-03-10.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28382,7 +28382,7 @@
"/orgs/{org}/insights/api/route-stats/{actor_type}/{actor_id}": {
"get": {
"summary": "Get route stats by actor",
"description": "Get API request count statistics for an actor broken down by route within a specified time frame.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28450,7 +28450,7 @@
"/orgs/{org}/insights/api/subject-stats": {
"get": {
"summary": "Get subject stats",
"description": "Get API request statistics for all subjects within an organization within a specified time frame. Subjects can be users or GitHub Apps.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28512,7 +28512,7 @@
"/orgs/{org}/insights/api/summary-stats": {
"get": {
"summary": "Get summary stats",
"description": "Get overall statistics of API requests made within an organization by all users and apps within a specified time frame.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28559,7 +28559,7 @@
"/orgs/{org}/insights/api/summary-stats/users/{user_id}": {
"get": {
"summary": "Get summary stats by user",
"description": "Get overall statistics of API requests within the organization for a user.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28609,7 +28609,7 @@
"/orgs/{org}/insights/api/summary-stats/{actor_type}/{actor_id}": {
"get": {
"summary": "Get summary stats by actor",
"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.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28662,7 +28662,7 @@
"/orgs/{org}/insights/api/time-stats": {
"get": {
"summary": "Get time stats",
"description": "Get the number of API requests and rate-limited requests made within an organization over a specified time period.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28712,7 +28712,7 @@
"/orgs/{org}/insights/api/time-stats/users/{user_id}": {
"get": {
"summary": "Get time stats by user",
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific user over a specified time period.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28765,7 +28765,7 @@
"/orgs/{org}/insights/api/time-stats/{actor_type}/{actor_id}": {
"get": {
"summary": "Get time stats by actor",
"description": "Get the number of API requests and rate-limited requests made within an organization by a specific actor within a specified time period.",
"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.",
"tags": [
"orgs"
],
Expand Down Expand Up @@ -28821,7 +28821,7 @@
"/orgs/{org}/insights/api/user-stats/{user_id}": {
"get": {
"summary": "Get user stats",
"description": "Get API usage statistics within an organization for a user broken down by the type of access.",
"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.",
"tags": [
"orgs"
],
Expand Down
Loading