diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 8a9c53205..274286731 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -2424,7 +2424,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -4852,7 +4852,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -11525,7 +11525,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63583,7 +63583,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63634,7 +63634,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63688,7 +63688,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64740,7 +64740,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64791,7 +64791,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -97868,16 +97868,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -97909,6 +97899,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -119441,6 +119441,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 76ed46dce..5ce9cafb1 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -1677,9 +1677,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -3369,7 +3369,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -8421,7 +8423,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -46050,8 +46054,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -46082,8 +46089,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -46115,7 +46125,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -46827,9 +46839,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -46860,7 +46875,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user @@ -70836,13 +70853,6 @@ components: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -70868,6 +70878,13 @@ components: description: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string code-scanning-analysis-tool-version: type: - string @@ -86470,6 +86487,7 @@ components: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 8a9c53205..274286731 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -2424,7 +2424,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -4852,7 +4852,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -11525,7 +11525,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63583,7 +63583,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63634,7 +63634,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -63688,7 +63688,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64740,7 +64740,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -64791,7 +64791,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -97868,16 +97868,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -97909,6 +97899,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -119441,6 +119441,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 76ed46dce..5ce9cafb1 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -1677,9 +1677,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -3369,7 +3369,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -8421,7 +8423,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -46050,8 +46054,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -46082,8 +46089,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -46115,7 +46125,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -46827,9 +46839,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -46860,7 +46875,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user @@ -70836,13 +70853,6 @@ components: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -70868,6 +70878,13 @@ components: description: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string code-scanning-analysis-tool-version: type: - string @@ -86470,6 +86487,7 @@ components: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 679530192..775cba01d 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -22354,7 +22354,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -46446,7 +46446,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65193,16 +65193,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -65234,6 +65224,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -81638,7 +81638,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -233468,16 +233468,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -233509,6 +233499,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -419764,6 +419764,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -420265,6 +420266,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -420729,6 +420731,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -421186,6 +421189,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -421621,6 +421625,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -422781,6 +422786,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -423280,6 +423286,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -558387,7 +558394,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -561895,7 +561902,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -565423,7 +565430,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -576169,7 +576176,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -579688,7 +579695,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 4a2092800..e7af0a371 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -9443,9 +9443,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -13754,7 +13754,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -18659,13 +18661,6 @@ paths: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -18692,6 +18687,13 @@ paths: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string tool: &316 type: object properties: @@ -22688,7 +22690,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -76329,6 +76333,7 @@ paths: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -94293,8 +94298,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -94371,8 +94379,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -94460,7 +94471,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -95276,9 +95289,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -95365,7 +95381,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 679530192..775cba01d 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -22354,7 +22354,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -46446,7 +46446,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65193,16 +65193,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -65234,6 +65224,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -81638,7 +81638,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -233468,16 +233468,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -233509,6 +233499,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -419764,6 +419764,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -420265,6 +420266,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -420729,6 +420731,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -421186,6 +421189,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -421621,6 +421625,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -422781,6 +422786,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -423280,6 +423286,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -558387,7 +558394,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -561895,7 +561902,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -565423,7 +565430,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -576169,7 +576176,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -579688,7 +579695,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 4a2092800..e7af0a371 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -9443,9 +9443,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -13754,7 +13754,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -18659,13 +18661,6 @@ paths: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -18692,6 +18687,13 @@ paths: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string tool: &316 type: object properties: @@ -22688,7 +22690,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -76329,6 +76333,7 @@ paths: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -94293,8 +94298,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -94371,8 +94379,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -94460,7 +94471,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -95276,9 +95289,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -95365,7 +95381,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index d6175d814..8f2a713bb 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -25213,16 +25213,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -25254,6 +25244,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -33320,7 +33320,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -57412,7 +57412,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -79647,16 +79647,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -79688,6 +79678,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -99301,7 +99301,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -254156,16 +254156,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -254197,6 +254187,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -440715,6 +440715,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -441216,6 +441217,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -441680,6 +441682,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -442137,6 +442140,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -442572,6 +442576,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -443732,6 +443737,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -444231,6 +444237,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -591544,7 +591551,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -595052,7 +595059,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -598580,7 +598587,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -609350,7 +609357,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -612869,7 +612876,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 87ceb6602..ad640bdc9 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -9983,13 +9983,6 @@ paths: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -10016,6 +10009,13 @@ paths: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string tool: &360 type: object properties: @@ -13636,9 +13636,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -17947,7 +17947,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -27895,7 +27897,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -82407,6 +82411,7 @@ paths: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -102370,8 +102375,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -102448,8 +102456,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -102537,7 +102548,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -103353,9 +103366,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -103442,7 +103458,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index d6175d814..8f2a713bb 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -25213,16 +25213,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -25254,6 +25244,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -33320,7 +33320,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -57412,7 +57412,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -79647,16 +79647,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -79688,6 +79678,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -99301,7 +99301,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -254156,16 +254156,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -254197,6 +254187,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -440715,6 +440715,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -441216,6 +441217,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -441680,6 +441682,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -442137,6 +442140,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -442572,6 +442576,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -443732,6 +443737,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -444231,6 +444237,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -591544,7 +591551,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -595052,7 +595059,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -598580,7 +598587,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -609350,7 +609357,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -612869,7 +612876,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 87ceb6602..ad640bdc9 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -9983,13 +9983,6 @@ paths: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -10016,6 +10009,13 @@ paths: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string tool: &360 type: object properties: @@ -13636,9 +13636,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -17947,7 +17947,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -27895,7 +27897,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -82407,6 +82411,7 @@ paths: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -102370,8 +102375,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -102448,8 +102456,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -102537,7 +102548,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -103353,9 +103366,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -103442,7 +103458,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index a0979bdb0..cbd666448 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -5434,7 +5434,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -7862,7 +7862,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -16180,7 +16180,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71131,7 +71131,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71182,7 +71182,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71236,7 +71236,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -72288,7 +72288,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -72339,7 +72339,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -101713,16 +101713,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -101754,6 +101744,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -129602,6 +129602,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 24e4c3167..5e86fcbf1 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -3830,9 +3830,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -5522,7 +5522,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -11782,7 +11784,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -51539,8 +51543,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -51571,8 +51578,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -51604,7 +51614,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -52316,9 +52328,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -52349,7 +52364,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user @@ -73584,13 +73601,6 @@ components: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -73616,6 +73626,13 @@ components: description: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string code-scanning-analysis-tool-version: type: - string @@ -93886,6 +93903,7 @@ components: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index a0979bdb0..cbd666448 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -5434,7 +5434,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -7862,7 +7862,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -16180,7 +16180,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71131,7 +71131,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71182,7 +71182,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -71236,7 +71236,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -72288,7 +72288,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -72339,7 +72339,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -101713,16 +101713,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -101754,6 +101744,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -129602,6 +129602,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 24e4c3167..5e86fcbf1 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -3830,9 +3830,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -5522,7 +5522,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -11782,7 +11784,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -51539,8 +51543,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -51571,8 +51578,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -51604,7 +51614,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -52316,9 +52328,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -52349,7 +52364,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user @@ -73584,13 +73601,6 @@ components: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -73616,6 +73626,13 @@ components: description: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string code-scanning-analysis-tool-version: type: - string @@ -93886,6 +93903,7 @@ components: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 3ea9cbd65..1c68573a2 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -38745,16 +38745,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -38786,6 +38776,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -43520,7 +43520,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65774,7 +65774,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -87162,16 +87162,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -87203,6 +87193,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -94567,7 +94567,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -223454,16 +223454,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -223495,6 +223485,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -388559,6 +388559,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -389060,6 +389061,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -389524,6 +389526,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -389981,6 +389984,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -390416,6 +390420,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -391576,6 +391581,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -392075,6 +392081,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -482374,7 +482381,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -485882,7 +485889,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -489410,7 +489417,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -500107,7 +500114,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -503626,7 +503633,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index d99a8666a..970be9014 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -11971,13 +11971,6 @@ paths: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -12004,6 +11997,13 @@ paths: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string tool: &335 type: object properties: @@ -14065,9 +14065,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -18259,7 +18259,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -24441,7 +24443,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -70210,6 +70214,7 @@ paths: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -85630,8 +85635,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -85708,8 +85716,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -85797,7 +85808,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -86613,9 +86626,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -86702,7 +86718,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json index 3ea9cbd65..1c68573a2 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -38745,16 +38745,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -38786,6 +38776,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -43520,7 +43520,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -65774,7 +65774,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -87162,16 +87162,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -87203,6 +87193,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -94567,7 +94567,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -223454,16 +223454,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -223495,6 +223485,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -388559,6 +388559,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -389060,6 +389061,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -389524,6 +389526,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -389981,6 +389984,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -390416,6 +390420,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -391576,6 +391581,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -392075,6 +392081,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] @@ -482374,7 +482381,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -485882,7 +485889,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -489410,7 +489417,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -500107,7 +500114,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -503626,7 +503633,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index d99a8666a..970be9014 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -11971,13 +11971,6 @@ paths: name: type: string description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string severity: type: - string @@ -12004,6 +11997,13 @@ paths: type: string description: A short description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string tool: &335 type: object properties: @@ -14065,9 +14065,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -18259,7 +18259,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -24441,7 +24443,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -70210,6 +70214,7 @@ paths: id: description: Unique identifier of the review type: integer + format: int64 examples: - 42 node_id: @@ -85630,8 +85635,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -85708,8 +85716,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -85797,7 +85808,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -86613,9 +86626,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -86702,7 +86718,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-public-events-for-user diff --git a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json index 1c18a9a77..4a9a3f25b 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json @@ -7639,7 +7639,7 @@ "/events": { "get": { "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -10041,7 +10041,7 @@ "/networks/{owner}/{repo}/events": { "get": { "summary": "List public events for a network of repositories", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -15310,7 +15310,7 @@ "/orgs/{org}/events": { "get": { "summary": "List public organization events", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -60547,7 +60547,7 @@ "/users/{username}/events": { "get": { "summary": "List events for the authenticated user", - "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -60598,7 +60598,7 @@ "/users/{username}/events/orgs/{org}": { "get": { "summary": "List organization events for the authenticated user", - "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -60652,7 +60652,7 @@ "/users/{username}/events/public": { "get": { "summary": "List public events for a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -61704,7 +61704,7 @@ "/users/{username}/received_events": { "get": { "summary": "List events received by the authenticated user", - "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "description": "These are events that you've received by watching repositories and following users. If you are authenticated as the\ngiven user, you will see private events. Otherwise, you'll only see public events.\n\n> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -61755,7 +61755,7 @@ "/users/{username}/received_events/public": { "get": { "summary": "List public events received by a user", - "description": "", + "description": "> [!NOTE]\n> This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.", "tags": [ "activity" ], @@ -91406,16 +91406,6 @@ "type": "string", "description": "The name of the rule used to detect the alert." }, - "tags": { - "type": [ - "array", - "null" - ], - "description": "A set of tags applicable for the rule.", - "items": { - "type": "string" - } - }, "severity": { "type": [ "string", @@ -91447,6 +91437,16 @@ "description": { "type": "string", "description": "A short description of the rule used to detect the alert." + }, + "tags": { + "type": [ + "array", + "null" + ], + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } } } }, @@ -113599,6 +113599,7 @@ "id": { "description": "Unique identifier of the review", "type": "integer", + "format": "int64", "examples": [ 42 ] diff --git a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml index a75bacfe1..e5f1ac777 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml +++ b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml @@ -5357,9 +5357,9 @@ paths: "/events": get: summary: List public events - description: We delay the public events feed by five minutes, which means the - most recent event returned by the public events API actually occurred at least - five minutes ago. + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events @@ -7013,7 +7013,9 @@ paths: "/networks/{owner}/{repo}/events": get: summary: List public events for a network of repositories - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-repo-network @@ -10936,7 +10938,9 @@ paths: "/orgs/{org}/events": get: summary: List public organization events - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-org-events @@ -43712,8 +43716,11 @@ paths: "/users/{username}/events": get: summary: List events for the authenticated user - description: If you are authenticated as the given user, you will see your private - events. Otherwise, you'll only see public events. + description: |- + If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-events-for-authenticated-user @@ -43744,8 +43751,11 @@ paths: "/users/{username}/events/orgs/{org}": get: summary: List organization events for the authenticated user - description: This is the user's organization dashboard. You must be authenticated - as the user to view this. + description: |- + This is the user's organization dashboard. You must be authenticated as the user to view this. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-org-events-for-authenticated-user @@ -43777,7 +43787,9 @@ paths: "/users/{username}/events/public": get: summary: List public events for a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-public-events-for-user @@ -44489,9 +44501,12 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repositories - and following users. If you are authenticated as the given user, you will - see private events. Otherwise, you'll only see public events. + description: |- + These are events that you've received by watching repositories and following users. If you are authenticated as the + given user, you will see private events. Otherwise, you'll only see public events. + + > [!NOTE] + > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h. tags: - activity operationId: activity/list-received-events-for-user @@ -44522,7 +44537,9 @@ paths: "/users/{username}/received_events/public": get: summary: List public events received by a user - description: '' + description: |- + > [!NOTE] + > This API is not built to serve real-time use case{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}