Skip to content

Commit 33e5602

Browse files
Commit via running ake Sources/rate-limit
1 parent 7467f92 commit 33e5602

File tree

2 files changed

+16
-8
lines changed

2 files changed

+16
-8
lines changed

Sources/rate-limit/Client.swift

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ public struct Client: APIProtocol {
4040
}
4141
/// Get rate limit status for the authenticated user
4242
///
43-
/// **Note:** Accessing this endpoint does not count against your REST API rate limit.
43+
/// > [!NOTE]
44+
/// > Accessing this endpoint does not count against your REST API rate limit.
4445
///
4546
/// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
4647
/// * The `core` object provides your rate limit status for all non-search-related resources in the REST API.
@@ -53,7 +54,8 @@ public struct Client: APIProtocol {
5354
/// * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
5455
/// * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."
5556
///
56-
/// **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
57+
/// > [!NOTE]
58+
/// > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
5759
///
5860
/// - Remark: HTTP `GET /rate_limit`.
5961
/// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`.

Sources/rate-limit/Types.swift

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ import struct Foundation.Date
1313
public protocol APIProtocol: Sendable {
1414
/// Get rate limit status for the authenticated user
1515
///
16-
/// **Note:** Accessing this endpoint does not count against your REST API rate limit.
16+
/// > [!NOTE]
17+
/// > Accessing this endpoint does not count against your REST API rate limit.
1718
///
1819
/// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
1920
/// * The `core` object provides your rate limit status for all non-search-related resources in the REST API.
@@ -26,7 +27,8 @@ public protocol APIProtocol: Sendable {
2627
/// * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
2728
/// * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."
2829
///
29-
/// **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
30+
/// > [!NOTE]
31+
/// > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
3032
///
3133
/// - Remark: HTTP `GET /rate_limit`.
3234
/// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`.
@@ -37,7 +39,8 @@ public protocol APIProtocol: Sendable {
3739
extension APIProtocol {
3840
/// Get rate limit status for the authenticated user
3941
///
40-
/// **Note:** Accessing this endpoint does not count against your REST API rate limit.
42+
/// > [!NOTE]
43+
/// > Accessing this endpoint does not count against your REST API rate limit.
4144
///
4245
/// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
4346
/// * The `core` object provides your rate limit status for all non-search-related resources in the REST API.
@@ -50,7 +53,8 @@ extension APIProtocol {
5053
/// * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
5154
/// * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."
5255
///
53-
/// **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
56+
/// > [!NOTE]
57+
/// > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
5458
///
5559
/// - Remark: HTTP `GET /rate_limit`.
5660
/// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`.
@@ -296,7 +300,8 @@ public enum Components {
296300
public enum Operations {
297301
/// Get rate limit status for the authenticated user
298302
///
299-
/// **Note:** Accessing this endpoint does not count against your REST API rate limit.
303+
/// > [!NOTE]
304+
/// > Accessing this endpoint does not count against your REST API rate limit.
300305
///
301306
/// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
302307
/// * The `core` object provides your rate limit status for all non-search-related resources in the REST API.
@@ -309,7 +314,8 @@ public enum Operations {
309314
/// * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)."
310315
/// * The `source_import` object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)."
311316
///
312-
/// **Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
317+
/// > [!NOTE]
318+
/// > The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.
313319
///
314320
/// - Remark: HTTP `GET /rate_limit`.
315321
/// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`.

0 commit comments

Comments
 (0)