diff --git a/Sources/activity/Client.swift b/Sources/activity/Client.swift index 25f02c2cad6..b052b53df12 100644 --- a/Sources/activity/Client.swift +++ b/Sources/activity/Client.swift @@ -40,7 +40,8 @@ public struct Client: APIProtocol { } /// List public events /// - /// 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. + /// > [!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. /// /// - Remark: HTTP `GET /events`. /// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`. @@ -237,7 +238,8 @@ public struct Client: APIProtocol { } /// List public events for a network of repositories /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /networks/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`. @@ -1230,7 +1232,8 @@ public struct Client: APIProtocol { } /// List public organization 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. /// /// - Remark: HTTP `GET /orgs/{org}/events`. /// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`. @@ -2615,6 +2618,9 @@ public struct Client: APIProtocol { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events`. /// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`. 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 { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`. /// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`. 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 { } /// List public events for a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/events/public`. /// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`. @@ -2848,7 +2858,11 @@ public struct Client: APIProtocol { } /// List events received by the authenticated user /// - /// 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. + /// 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. /// /// - Remark: HTTP `GET /users/{username}/received_events`. /// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`. @@ -2926,7 +2940,8 @@ public struct Client: APIProtocol { } /// List public events received by a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/received_events/public`. /// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`. diff --git a/Sources/activity/Types.swift b/Sources/activity/Types.swift index 454c501bff6..09231940490 100644 --- a/Sources/activity/Types.swift +++ b/Sources/activity/Types.swift @@ -13,7 +13,8 @@ import struct Foundation.Date public protocol APIProtocol: Sendable { /// List public events /// - /// 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. + /// > [!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. /// /// - Remark: HTTP `GET /events`. /// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`. @@ -40,7 +41,8 @@ public protocol APIProtocol: Sendable { func activity_sol_get_hyphen_feeds(_ input: Operations.activity_sol_get_hyphen_feeds.Input) async throws -> Operations.activity_sol_get_hyphen_feeds.Output /// List public events for a network of repositories /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /networks/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`. @@ -109,7 +111,8 @@ public protocol APIProtocol: Sendable { 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 /// List public organization 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. /// /// - Remark: HTTP `GET /orgs/{org}/events`. /// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`. @@ -218,6 +221,9 @@ public protocol APIProtocol: Sendable { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events`. /// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`. 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 @@ -225,26 +231,35 @@ public protocol APIProtocol: Sendable { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`. /// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`. 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 /// List public events for a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/events/public`. /// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`. 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 /// List events received by the authenticated user /// - /// 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. + /// 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. /// /// - Remark: HTTP `GET /users/{username}/received_events`. /// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`. 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 /// List public events received by a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/received_events/public`. /// - 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 { extension APIProtocol { /// List public events /// - /// 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. + /// > [!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. /// /// - Remark: HTTP `GET /events`. /// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`. @@ -310,7 +326,8 @@ extension APIProtocol { } /// List public events for a network of repositories /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /networks/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`. @@ -449,7 +466,8 @@ extension APIProtocol { } /// List public organization 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. /// /// - Remark: HTTP `GET /orgs/{org}/events`. /// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`. @@ -678,6 +696,9 @@ extension APIProtocol { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events`. /// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`. public func activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user( @@ -695,6 +716,9 @@ extension APIProtocol { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`. /// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`. public func activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user( @@ -710,7 +734,8 @@ extension APIProtocol { } /// List public events for a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/events/public`. /// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`. @@ -727,7 +752,11 @@ extension APIProtocol { } /// List events received by the authenticated user /// - /// 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. + /// 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. /// /// - Remark: HTTP `GET /users/{username}/received_events`. /// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`. @@ -744,7 +773,8 @@ extension APIProtocol { } /// List public events received by a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/received_events/public`. /// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`. @@ -4704,7 +4734,8 @@ public enum Components { public enum Operations { /// List public events /// - /// 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. + /// > [!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. /// /// - Remark: HTTP `GET /events`. /// - Remark: Generated from `#/paths//events/get(activity/list-public-events)`. @@ -5039,7 +5070,8 @@ public enum Operations { } /// List public events for a network of repositories /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /networks/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//networks/{owner}/{repo}/events/get(activity/list-public-events-for-repo-network)`. @@ -6872,7 +6904,8 @@ public enum Operations { } /// List public organization 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. /// /// - Remark: HTTP `GET /orgs/{org}/events`. /// - Remark: Generated from `#/paths//orgs/{org}/events/get(activity/list-public-org-events)`. @@ -9696,6 +9729,9 @@ public enum Operations { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events`. /// - Remark: Generated from `#/paths//users/{username}/events/get(activity/list-events-for-authenticated-user)`. public enum activity_sol_list_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user { @@ -9855,6 +9891,9 @@ public enum Operations { /// /// 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. + /// /// - Remark: HTTP `GET /users/{username}/events/orgs/{org}`. /// - Remark: Generated from `#/paths//users/{username}/events/orgs/{org}/get(activity/list-org-events-for-authenticated-user)`. public enum activity_sol_list_hyphen_org_hyphen_events_hyphen_for_hyphen_authenticated_hyphen_user { @@ -10021,7 +10060,8 @@ public enum Operations { } /// List public events for a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/events/public`. /// - Remark: Generated from `#/paths//users/{username}/events/public/get(activity/list-public-events-for-user)`. @@ -10180,7 +10220,11 @@ public enum Operations { } /// List events received by the authenticated user /// - /// 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. + /// 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. /// /// - Remark: HTTP `GET /users/{username}/received_events`. /// - Remark: Generated from `#/paths//users/{username}/received_events/get(activity/list-received-events-for-user)`. @@ -10339,7 +10383,8 @@ public enum Operations { } /// List public events received by a user /// - /// + /// > [!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. /// /// - Remark: HTTP `GET /users/{username}/received_events/public`. /// - Remark: Generated from `#/paths//users/{username}/received_events/public/get(activity/list-received-public-events-for-user)`. diff --git a/Sources/code-scanning/Types.swift b/Sources/code-scanning/Types.swift index b7c4d19fd57..098effdac07 100644 --- a/Sources/code-scanning/Types.swift +++ b/Sources/code-scanning/Types.swift @@ -1601,10 +1601,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/code-scanning-alert-rule-summary/name`. public var name: Swift.String? - /// A set of tags applicable for the rule. - /// - /// - Remark: Generated from `#/components/schemas/code-scanning-alert-rule-summary/tags`. - public var tags: [Swift.String]? /// The severity of the alert. /// /// - Remark: Generated from `#/components/schemas/code-scanning-alert-rule-summary/severity`. @@ -1635,37 +1631,41 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/code-scanning-alert-rule-summary/description`. public var description: Swift.String? + /// A set of tags applicable for the rule. + /// + /// - Remark: Generated from `#/components/schemas/code-scanning-alert-rule-summary/tags`. + public var tags: [Swift.String]? /// Creates a new `code_hyphen_scanning_hyphen_alert_hyphen_rule_hyphen_summary`. /// /// - Parameters: /// - id: A unique identifier for the rule used to detect the alert. /// - name: The name of the rule used to detect the alert. - /// - tags: A set of tags applicable for the rule. /// - severity: The severity of the alert. /// - security_severity_level: The security severity of the alert. /// - description: A short description of the rule used to detect the alert. + /// - tags: A set of tags applicable for the rule. public init( id: Swift.String? = nil, name: Swift.String? = nil, - tags: [Swift.String]? = nil, severity: Components.Schemas.code_hyphen_scanning_hyphen_alert_hyphen_rule_hyphen_summary.severityPayload? = nil, security_severity_level: Components.Schemas.code_hyphen_scanning_hyphen_alert_hyphen_rule_hyphen_summary.security_severity_levelPayload? = nil, - description: Swift.String? = nil + description: Swift.String? = nil, + tags: [Swift.String]? = nil ) { self.id = id self.name = name - self.tags = tags self.severity = severity self.security_severity_level = security_severity_level self.description = description + self.tags = tags } public enum CodingKeys: String, CodingKey { case id case name - case tags case severity case security_severity_level case description + case tags } } /// The version of the tool used to generate the code scanning analysis. diff --git a/Sources/pulls/Types.swift b/Sources/pulls/Types.swift index 666917176c8..981a93264fc 100644 --- a/Sources/pulls/Types.swift +++ b/Sources/pulls/Types.swift @@ -6364,7 +6364,7 @@ public enum Components { /// Unique identifier of the review /// /// - Remark: Generated from `#/components/schemas/pull-request-review/id`. - public var id: Swift.Int + public var id: Swift.Int64 /// - Remark: Generated from `#/components/schemas/pull-request-review/node_id`. public var node_id: Swift.String /// - Remark: Generated from `#/components/schemas/pull-request-review/user`. @@ -6463,7 +6463,7 @@ public enum Components { /// - body_text: /// - author_association: public init( - id: Swift.Int, + id: Swift.Int64, node_id: Swift.String, user: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, body: Swift.String, diff --git a/Submodule/github/rest-api-description b/Submodule/github/rest-api-description index 2a8a2c6f064..7bd3d57638a 160000 --- a/Submodule/github/rest-api-description +++ b/Submodule/github/rest-api-description @@ -1 +1 @@ -Subproject commit 2a8a2c6f064a6d0c2bff8cb96b43791beb470f07 +Subproject commit 7bd3d57638a0363a2d4ebf03dfcf50aacdb0d8da