Skip to content

Bump Submodule/github/rest-api-description from e44bcaa to ec36bcf #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
12 changes: 9 additions & 3 deletions Sources/activity/Client.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1576,7 +1576,9 @@ public struct Client: APIProtocol {
///
/// Lists the people that have starred the repository.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
Expand Down Expand Up @@ -1980,7 +1982,9 @@ public struct Client: APIProtocol {
///
/// Lists repositories the authenticated user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /user/starred`.
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
Expand Down Expand Up @@ -2991,7 +2995,9 @@ public struct Client: APIProtocol {
///
/// Lists repositories a user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /users/{username}/starred`.
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.
Expand Down
36 changes: 27 additions & 9 deletions Sources/activity/Types.swift
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,9 @@ public protocol APIProtocol: Sendable {
///
/// Lists the people that have starred the repository.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
Expand Down Expand Up @@ -170,7 +172,9 @@ public protocol APIProtocol: Sendable {
///
/// Lists repositories the authenticated user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /user/starred`.
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
Expand Down Expand Up @@ -238,7 +242,9 @@ public protocol APIProtocol: Sendable {
///
/// Lists repositories a user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /users/{username}/starred`.
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.
Expand Down Expand Up @@ -496,7 +502,9 @@ extension APIProtocol {
///
/// Lists the people that have starred the repository.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
Expand Down Expand Up @@ -573,7 +581,9 @@ extension APIProtocol {
///
/// Lists repositories the authenticated user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /user/starred`.
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
Expand Down Expand Up @@ -731,7 +741,9 @@ extension APIProtocol {
///
/// Lists repositories a user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /users/{username}/starred`.
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.
Expand Down Expand Up @@ -8350,7 +8362,9 @@ public enum Operations {
///
/// Lists the people that have starred the repository.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/stargazers`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stargazers/get(activity/list-stargazers-for-repo)`.
Expand Down Expand Up @@ -9239,7 +9253,9 @@ public enum Operations {
///
/// Lists repositories the authenticated user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /user/starred`.
/// - Remark: Generated from `#/paths//user/starred/get(activity/list-repos-starred-by-authenticated-user)`.
Expand Down Expand Up @@ -11208,7 +11224,9 @@ public enum Operations {
///
/// Lists repositories a user has starred.
///
/// 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`.
/// 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)."
///
/// - **`application/vnd.github.star+json`**: Includes a timestamp of when the star was created.
///
/// - Remark: HTTP `GET /users/{username}/starred`.
/// - Remark: Generated from `#/paths//users/{username}/starred/get(activity/list-repos-starred-by-user)`.
Expand Down
8 changes: 4 additions & 4 deletions Sources/code-scanning/Client.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1065,6 +1065,7 @@ public struct Client: APIProtocol {
/// Get a code scanning analysis for a repository
///
/// Gets a specified code scanning analysis for a repository.
///
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
/// the `public_repo` scope also grants permission to read security events on public repositories only.
///
Expand All @@ -1078,10 +1079,9 @@ public struct Client: APIProtocol {
/// For very old analyses this data is not available,
/// and `0` is returned in this field.
///
/// If you use the Accept header `application/sarif+json`,
/// the response contains the analysis data that was uploaded.
/// This 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).
/// 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)."
///
/// - **`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.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
Expand Down
24 changes: 12 additions & 12 deletions Sources/code-scanning/Types.swift
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ public protocol APIProtocol: Sendable {
/// Get a code scanning analysis for a repository
///
/// Gets a specified code scanning analysis for a repository.
///
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
/// the `public_repo` scope also grants permission to read security events on public repositories only.
///
Expand All @@ -96,10 +97,9 @@ public protocol APIProtocol: Sendable {
/// For very old analyses this data is not available,
/// and `0` is returned in this field.
///
/// If you use the Accept header `application/sarif+json`,
/// the response contains the analysis data that was uploaded.
/// This 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).
/// 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)."
///
/// - **`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.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
Expand Down Expand Up @@ -396,6 +396,7 @@ extension APIProtocol {
/// Get a code scanning analysis for a repository
///
/// Gets a specified code scanning analysis for a repository.
///
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
/// the `public_repo` scope also grants permission to read security events on public repositories only.
///
Expand All @@ -409,10 +410,9 @@ extension APIProtocol {
/// For very old analyses this data is not available,
/// and `0` is returned in this field.
///
/// If you use the Accept header `application/sarif+json`,
/// the response contains the analysis data that was uploaded.
/// This 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).
/// 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)."
///
/// - **`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.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
Expand Down Expand Up @@ -4684,6 +4684,7 @@ public enum Operations {
/// Get a code scanning analysis for a repository
///
/// Gets a specified code scanning analysis for a repository.
///
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
/// the `public_repo` scope also grants permission to read security events on public repositories only.
///
Expand All @@ -4697,10 +4698,9 @@ public enum Operations {
/// For very old analyses this data is not available,
/// and `0` is returned in this field.
///
/// If you use the Accept header `application/sarif+json`,
/// the response contains the analysis data that was uploaded.
/// This 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).
/// 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)."
///
/// - **`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.
///
/// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
Expand Down
Loading