Skip to content

Commit c823f80

Browse files
wei18wei18
authored
Merge pull request #19 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-ec36bcf
Bump Submodule/github/rest-api-description from `e44bcaa` to `ec36bcf`
2 parents 619ff6e + f1b9092 commit c823f80

File tree

19 files changed

+2444
-321
lines changed

19 files changed

+2444
-321
lines changed

‎Sources/activity/Client.swift‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1576,7 +1576,9 @@ public struct Client: APIProtocol {
15761576
///
15771577
/// Lists the people that have starred the repository.
15781578
///
1579-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
1579+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
1580+
///
1581+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
15801582
///
15811583
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
15821584
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
@@ -1980,7 +1982,9 @@ public struct Client: APIProtocol {
19801982
///
19811983
/// Lists repositories the authenticated user has starred.
19821984
///
1983-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
1985+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
1986+
///
1987+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
19841988
///
19851989
/// - Remark: HTTP `GET /user/starred`.
19861990
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
@@ -2991,7 +2995,9 @@ public struct Client: APIProtocol {
29912995
///
29922996
/// Lists repositories a user has starred.
29932997
///
2994-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
2998+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
2999+
///
3000+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
29953001
///
29963002
/// - Remark: HTTP `GET /users/{username}/starred`.
29973003
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.

‎Sources/activity/Types.swift‎

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,9 @@ public protocol APIProtocol: Sendable {
133133
///
134134
/// Lists the people that have starred the repository.
135135
///
136-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
136+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
137+
///
138+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
137139
///
138140
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
139141
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
@@ -170,7 +172,9 @@ public protocol APIProtocol: Sendable {
170172
///
171173
/// Lists repositories the authenticated user has starred.
172174
///
173-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
175+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
176+
///
177+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
174178
///
175179
/// - Remark: HTTP `GET /user/starred`.
176180
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
@@ -238,7 +242,9 @@ public protocol APIProtocol: Sendable {
238242
///
239243
/// Lists repositories a user has starred.
240244
///
241-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
245+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
246+
///
247+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
242248
///
243249
/// - Remark: HTTP `GET /users/{username}/starred`.
244250
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.
@@ -496,7 +502,9 @@ extension APIProtocol {
496502
///
497503
/// Lists the people that have starred the repository.
498504
///
499-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
505+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
506+
///
507+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
500508
///
501509
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
502510
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
@@ -573,7 +581,9 @@ extension APIProtocol {
573581
///
574582
/// Lists repositories the authenticated user has starred.
575583
///
576-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
584+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
585+
///
586+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
577587
///
578588
/// - Remark: HTTP `GET /user/starred`.
579589
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
@@ -731,7 +741,9 @@ extension APIProtocol {
731741
///
732742
/// Lists repositories a user has starred.
733743
///
734-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
744+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
745+
///
746+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
735747
///
736748
/// - Remark: HTTP `GET /users/{username}/starred`.
737749
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.
@@ -8350,7 +8362,9 @@ public enum Operations {
83508362
///
83518363
/// Lists the people that have starred the repository.
83528364
///
8353-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
8365+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
8366+
///
8367+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
83548368
///
83558369
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
83568370
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
@@ -9239,7 +9253,9 @@ public enum Operations {
92399253
///
92409254
/// Lists repositories the authenticated user has starred.
92419255
///
9242-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
9256+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
9257+
///
9258+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
92439259
///
92449260
/// - Remark: HTTP `GET /user/starred`.
92459261
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
@@ -11208,7 +11224,9 @@ public enum Operations {
1120811224
///
1120911225
/// Lists repositories a user has starred.
1121011226
///
11211-
/// You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`.
11227+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
11228+
///
11229+
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
1121211230
///
1121311231
/// - Remark: HTTP `GET /users/{username}/starred`.
1121411232
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.

‎Sources/code-scanning/Client.swift‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,6 +1065,7 @@ public struct Client: APIProtocol {
10651065
/// Get a code scanning analysis for a repository
10661066
///
10671067
/// Gets a specified code scanning analysis for a repository.
1068+
///
10681069
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
10691070
/// the `public_repo` scope also grants permission to read security events on public repositories only.
10701071
///
@@ -1078,10 +1079,9 @@ public struct Client: APIProtocol {
10781079
/// For very old analyses this data is not available,
10791080
/// and `0` is returned in this field.
10801081
///
1081-
/// If you use the Accept header `application/sarif+json`,
1082-
/// the response contains the analysis data that was uploaded.
1083-
/// This is formatted as
1084-
/// [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
1082+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
1083+
///
1084+
/// - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
10851085
///
10861086
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
10871087
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.

‎Sources/code-scanning/Types.swift‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ public protocol APIProtocol: Sendable {
8383
/// Get a code scanning analysis for a repository
8484
///
8585
/// Gets a specified code scanning analysis for a repository.
86+
///
8687
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
8788
/// the `public_repo` scope also grants permission to read security events on public repositories only.
8889
///
@@ -96,10 +97,9 @@ public protocol APIProtocol: Sendable {
9697
/// For very old analyses this data is not available,
9798
/// and `0` is returned in this field.
9899
///
99-
/// If you use the Accept header `application/sarif+json`,
100-
/// the response contains the analysis data that was uploaded.
101-
/// This is formatted as
102-
/// [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
100+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
101+
///
102+
/// - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
103103
///
104104
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
105105
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
@@ -396,6 +396,7 @@ extension APIProtocol {
396396
/// Get a code scanning analysis for a repository
397397
///
398398
/// Gets a specified code scanning analysis for a repository.
399+
///
399400
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
400401
/// the `public_repo` scope also grants permission to read security events on public repositories only.
401402
///
@@ -409,10 +410,9 @@ extension APIProtocol {
409410
/// For very old analyses this data is not available,
410411
/// and `0` is returned in this field.
411412
///
412-
/// If you use the Accept header `application/sarif+json`,
413-
/// the response contains the analysis data that was uploaded.
414-
/// This is formatted as
415-
/// [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
413+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
414+
///
415+
/// - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
416416
///
417417
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
418418
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
@@ -4684,6 +4684,7 @@ public enum Operations {
46844684
/// Get a code scanning analysis for a repository
46854685
///
46864686
/// Gets a specified code scanning analysis for a repository.
4687+
///
46874688
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
46884689
/// the `public_repo` scope also grants permission to read security events on public repositories only.
46894690
///
@@ -4697,10 +4698,9 @@ public enum Operations {
46974698
/// For very old analyses this data is not available,
46984699
/// and `0` is returned in this field.
46994700
///
4700-
/// If you use the Accept header `application/sarif+json`,
4701-
/// the response contains the analysis data that was uploaded.
4702-
/// This is formatted as
4703-
/// [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
4701+
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
4702+
///
4703+
/// - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
47044704
///
47054705
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
47064706
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.

0 commit comments

Comments
 (0)