Skip to content

Commit 31257b5

Browse files
github-actions[bot]github-actions[bot]
authored
Merge pull request #68 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-7bd3d57
Bump Submodule/github/rest-api-description from `2a8a2c6` to `7bd3d57`
2 parents daaecc3 + 22b1898 commit 31257b5

File tree

5 files changed

+96
-36
lines changed

5 files changed

+96
-36
lines changed

‎Sources/activity/Client.swift

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ public struct Client: APIProtocol {
4040
}
4141
/// List public events
4242
///
43-
/// 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.
43+
/// > [!NOTE]
44+
/// > 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.
4445
///
4546
/// - Remark: HTTP `GET /events`.
4647
/// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`.
@@ -237,7 +238,8 @@ public struct Client: APIProtocol {
237238
}
238239
/// List public events for a network of repositories
239240
///
240-
///
241+
/// > [!NOTE]
242+
/// > 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.
241243
///
242244
/// - Remark: HTTP `GET /networks/{owner}/{repo}/events`.
243245
/// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`.
@@ -1230,7 +1232,8 @@ public struct Client: APIProtocol {
12301232
}
12311233
/// List public organization events
12321234
///
1233-
///
1235+
/// > [!NOTE]
1236+
/// > 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.
12341237
///
12351238
/// - Remark: HTTP `GET /orgs/{org}/events`.
12361239
/// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`.
@@ -2615,6 +2618,9 @@ public struct Client: APIProtocol {
26152618
///
26162619
/// If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
26172620
///
2621+
/// > [!NOTE]
2622+
/// > 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.
2623+
///
26182624
/// - Remark: HTTP `GET /users/{username}/events`.
26192625
/// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`.
26202626
public func activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Output {
@@ -2693,6 +2699,9 @@ public struct Client: APIProtocol {
26932699
///
26942700
/// This is the user's organization dashboard. You must be authenticated as the user to view this.
26952701
///
2702+
/// > [!NOTE]
2703+
/// > 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.
2704+
///
26962705
/// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`.
26972706
/// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`.
26982707
public func activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Output {
@@ -2770,7 +2779,8 @@ public struct Client: APIProtocol {
27702779
}
27712780
/// List public events for a user
27722781
///
2773-
///
2782+
/// > [!NOTE]
2783+
/// > 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.
27742784
///
27752785
/// - Remark: HTTP `GET /users/{username}/events/public`.
27762786
/// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`.
@@ -2848,7 +2858,11 @@ public struct Client: APIProtocol {
28482858
}
28492859
/// List events received by the authenticated user
28502860
///
2851-
/// 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.
2861+
/// These are events that you've received by watching repositories and following users. If you are authenticated as the
2862+
/// given user, you will see private events. Otherwise, you'll only see public events.
2863+
///
2864+
/// > [!NOTE]
2865+
/// > 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.
28522866
///
28532867
/// - Remark: HTTP `GET /users/{username}/received_events`.
28542868
/// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`.
@@ -2926,7 +2940,8 @@ public struct Client: APIProtocol {
29262940
}
29272941
/// List public events received by a user
29282942
///
2929-
///
2943+
/// > [!NOTE]
2944+
/// > 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.
29302945
///
29312946
/// - Remark: HTTP `GET /users/{username}/received_events/public`.
29322947
/// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`.

‎Sources/activity/Types.swift

Lines changed: 63 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ import struct Foundation.Date
1313
public protocol APIProtocol: Sendable {
1414
/// List public events
1515
///
16-
/// 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.
16+
/// > [!NOTE]
17+
/// > 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.
1718
///
1819
/// - Remark: HTTP `GET /events`.
1920
/// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`.
@@ -40,7 +41,8 @@ public protocol APIProtocol: Sendable {
4041
func activity_sol_get_hyphen_feeds(_ input: Operations.activity_sol_get_hyphen_feeds.Input) async throws -> Operations.activity_sol_get_hyphen_feeds.Output
4142
/// List public events for a network of repositories
4243
///
43-
///
44+
/// > [!NOTE]
45+
/// > 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.
4446
///
4547
/// - Remark: HTTP `GET /networks/{owner}/{repo}/events`.
4648
/// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`.
@@ -109,7 +111,8 @@ public protocol APIProtocol: Sendable {
109111
func activity_sol_delete_hyphen_thread_hyphen_subscription(_ input: Operations.activity_sol_delete_hyphen_thread_hyphen_subscription.Input) async throws -> Operations.activity_sol_delete_hyphen_thread_hyphen_subscription.Output
110112
/// List public organization events
111113
///
112-
///
114+
/// > [!NOTE]
115+
/// > 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.
113116
///
114117
/// - Remark: HTTP `GET /orgs/{org}/events`.
115118
/// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`.
@@ -218,33 +221,45 @@ public protocol APIProtocol: Sendable {
218221
///
219222
/// If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
220223
///
224+
/// > [!NOTE]
225+
/// > 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.
226+
///
221227
/// - Remark: HTTP `GET /users/{username}/events`.
222228
/// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`.
223229
func activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Output
224230
/// List organization events for the authenticated user
225231
///
226232
/// This is the user's organization dashboard. You must be authenticated as the user to view this.
227233
///
234+
/// > [!NOTE]
235+
/// > 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.
236+
///
228237
/// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`.
229238
/// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`.
230239
func activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user.Output
231240
/// List public events for a user
232241
///
233-
///
242+
/// > [!NOTE]
243+
/// > 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.
234244
///
235245
/// - Remark: HTTP `GET /users/{username}/events/public`.
236246
/// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`.
237247
func activity_sol_list_hyphen_public_hyphen_events_hyphen_for_hyphen_user(_ input: Operations.activity_sol_list_hyphen_public_hyphen_events_hyphen_for_hyphen_user.Input) async throws -> Operations.activity_sol_list_hyphen_public_hyphen_events_hyphen_for_hyphen_user.Output
238248
/// List events received by the authenticated user
239249
///
240-
/// 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.
250+
/// These are events that you've received by watching repositories and following users. If you are authenticated as the
251+
/// given user, you will see private events. Otherwise, you'll only see public events.
252+
///
253+
/// > [!NOTE]
254+
/// > 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.
241255
///
242256
/// - Remark: HTTP `GET /users/{username}/received_events`.
243257
/// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`.
244258
func activity_sol_list_hyphen_received_hyphen_events_hyphen_for_hyphen_user(_ input: Operations.activity_sol_list_hyphen_received_hyphen_events_hyphen_for_hyphen_user.Input) async throws -> Operations.activity_sol_list_hyphen_received_hyphen_events_hyphen_for_hyphen_user.Output
245259
/// List public events received by a user
246260
///
247-
///
261+
/// > [!NOTE]
262+
/// > 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.
248263
///
249264
/// - Remark: HTTP `GET /users/{username}/received_events/public`.
250265
/// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`.
@@ -273,7 +288,8 @@ public protocol APIProtocol: Sendable {
273288
extension APIProtocol {
274289
/// List public events
275290
///
276-
/// 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.
291+
/// > [!NOTE]
292+
/// > 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.
277293
///
278294
/// - Remark: HTTP `GET /events`.
279295
/// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`.
@@ -310,7 +326,8 @@ extension APIProtocol {
310326
}
311327
/// List public events for a network of repositories
312328
///
313-
///
329+
/// > [!NOTE]
330+
/// > 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.
314331
///
315332
/// - Remark: HTTP `GET /networks/{owner}/{repo}/events`.
316333
/// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`.
@@ -449,7 +466,8 @@ extension APIProtocol {
449466
}
450467
/// List public organization events
451468
///
452-
///
469+
/// > [!NOTE]
470+
/// > 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.
453471
///
454472
/// - Remark: HTTP `GET /orgs/{org}/events`.
455473
/// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`.
@@ -678,6 +696,9 @@ extension APIProtocol {
678696
///
679697
/// If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
680698
///
699+
/// > [!NOTE]
700+
/// > 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.
701+
///
681702
/// - Remark: HTTP `GET /users/{username}/events`.
682703
/// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`.
683704
public func activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user(
@@ -695,6 +716,9 @@ extension APIProtocol {
695716
///
696717
/// This is the user's organization dashboard. You must be authenticated as the user to view this.
697718
///
719+
/// > [!NOTE]
720+
/// > 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.
721+
///
698722
/// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`.
699723
/// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`.
700724
public func activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user(
@@ -710,7 +734,8 @@ extension APIProtocol {
710734
}
711735
/// List public events for a user
712736
///
713-
///
737+
/// > [!NOTE]
738+
/// > 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.
714739
///
715740
/// - Remark: HTTP `GET /users/{username}/events/public`.
716741
/// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`.
@@ -727,7 +752,11 @@ extension APIProtocol {
727752
}
728753
/// List events received by the authenticated user
729754
///
730-
/// 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.
755+
/// These are events that you've received by watching repositories and following users. If you are authenticated as the
756+
/// given user, you will see private events. Otherwise, you'll only see public events.
757+
///
758+
/// > [!NOTE]
759+
/// > 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.
731760
///
732761
/// - Remark: HTTP `GET /users/{username}/received_events`.
733762
/// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`.
@@ -744,7 +773,8 @@ extension APIProtocol {
744773
}
745774
/// List public events received by a user
746775
///
747-
///
776+
/// > [!NOTE]
777+
/// > 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.
748778
///
749779
/// - Remark: HTTP `GET /users/{username}/received_events/public`.
750780
/// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`.
@@ -4704,7 +4734,8 @@ public enum Components {
47044734
public enum Operations {
47054735
/// List public events
47064736
///
4707-
/// 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.
4737+
/// > [!NOTE]
4738+
/// > 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.
47084739
///
47094740
/// - Remark: HTTP `GET /events`.
47104741
/// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`.
@@ -5039,7 +5070,8 @@ public enum Operations {
50395070
}
50405071
/// List public events for a network of repositories
50415072
///
5042-
///
5073+
/// > [!NOTE]
5074+
/// > 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.
50435075
///
50445076
/// - Remark: HTTP `GET /networks/{owner}/{repo}/events`.
50455077
/// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`.
@@ -6872,7 +6904,8 @@ public enum Operations {
68726904
}
68736905
/// List public organization events
68746906
///
6875-
///
6907+
/// > [!NOTE]
6908+
/// > 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.
68766909
///
68776910
/// - Remark: HTTP `GET /orgs/{org}/events`.
68786911
/// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`.
@@ -9696,6 +9729,9 @@ public enum Operations {
96969729
///
96979730
/// If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.
96989731
///
9732+
/// > [!NOTE]
9733+
/// > 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.
9734+
///
96999735
/// - Remark: HTTP `GET /users/{username}/events`.
97009736
/// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`.
97019737
public enum activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user {
@@ -9855,6 +9891,9 @@ public enum Operations {
98559891
///
98569892
/// This is the user's organization dashboard. You must be authenticated as the user to view this.
98579893
///
9894+
/// > [!NOTE]
9895+
/// > 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.
9896+
///
98589897
/// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`.
98599898
/// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`.
98609899
public enum activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user {
@@ -10021,7 +10060,8 @@ public enum Operations {
1002110060
}
1002210061
/// List public events for a user
1002310062
///
10024-
///
10063+
/// > [!NOTE]
10064+
/// > 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.
1002510065
///
1002610066
/// - Remark: HTTP `GET /users/{username}/events/public`.
1002710067
/// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`.
@@ -10180,7 +10220,11 @@ public enum Operations {
1018010220
}
1018110221
/// List events received by the authenticated user
1018210222
///
10183-
/// 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.
10223+
/// These are events that you've received by watching repositories and following users. If you are authenticated as the
10224+
/// given user, you will see private events. Otherwise, you'll only see public events.
10225+
///
10226+
/// > [!NOTE]
10227+
/// > 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.
1018410228
///
1018510229
/// - Remark: HTTP `GET /users/{username}/received_events`.
1018610230
/// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`.
@@ -10339,7 +10383,8 @@ public enum Operations {
1033910383
}
1034010384
/// List public events received by a user
1034110385
///
10342-
///
10386+
/// > [!NOTE]
10387+
/// > 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.
1034310388
///
1034410389
/// - Remark: HTTP `GET /users/{username}/received_events/public`.
1034510390
/// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`.

0 commit comments

Comments
 (0)