diff --git a/Sources/actions/Client.swift b/Sources/actions/Client.swift index 27f77f31e77..add941952b2 100644 --- a/Sources/actions/Client.swift +++ b/Sources/actions/Client.swift @@ -6809,8 +6809,8 @@ public struct Client: APIProtocol { /// /// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// - /// **Note:** GitHub Apps can only review their own custom deployment protection rules. - /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + /// > [!NOTE] + /// > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// diff --git a/Sources/actions/Types.swift b/Sources/actions/Types.swift index 045abfb4562..47dc724f8b9 100644 --- a/Sources/actions/Types.swift +++ b/Sources/actions/Types.swift @@ -984,8 +984,8 @@ public protocol APIProtocol: Sendable { /// /// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// - /// **Note:** GitHub Apps can only review their own custom deployment protection rules. - /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + /// > [!NOTE] + /// > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// @@ -3027,8 +3027,8 @@ extension APIProtocol { /// /// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// - /// **Note:** GitHub Apps can only review their own custom deployment protection rules. - /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + /// > [!NOTE] + /// > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// @@ -6341,7 +6341,8 @@ public enum Components { public var verified_allowed: Swift.Bool? /// Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`. /// - /// **Note**: The `patterns_allowed` setting only applies to public repositories. + /// > [!NOTE] + /// > The `patterns_allowed` setting only applies to public repositories. /// /// - Remark: Generated from `#/components/schemas/selected-actions/patterns_allowed`. public var patterns_allowed: [Swift.String]? @@ -23019,8 +23020,8 @@ public enum Operations { /// /// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// - /// **Note:** GitHub Apps can only review their own custom deployment protection rules. - /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). + /// > [!NOTE] + /// > GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// diff --git a/Sources/activity/Client.swift b/Sources/activity/Client.swift index 0210a5d032b..25f02c2cad6 100644 --- a/Sources/activity/Client.swift +++ b/Sources/activity/Client.swift @@ -174,7 +174,8 @@ public struct Client: APIProtocol { /// /// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." /// - /// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + /// > [!NOTE] + /// > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. /// /// - Remark: HTTP `GET /feeds`. /// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`. @@ -1307,8 +1308,8 @@ public struct Client: APIProtocol { } /// List repository 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. - /// + /// > [!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 /repos/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`. diff --git a/Sources/activity/Types.swift b/Sources/activity/Types.swift index 3ce59e162af..454c501bff6 100644 --- a/Sources/activity/Types.swift +++ b/Sources/activity/Types.swift @@ -32,7 +32,8 @@ public protocol APIProtocol: Sendable { /// /// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." /// - /// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + /// > [!NOTE] + /// > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. /// /// - Remark: HTTP `GET /feeds`. /// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`. @@ -115,8 +116,8 @@ public protocol APIProtocol: Sendable { func activity_sol_list_hyphen_public_hyphen_org_hyphen_events(_ input: Operations.activity_sol_list_hyphen_public_hyphen_org_hyphen_events.Input) async throws -> Operations.activity_sol_list_hyphen_public_hyphen_org_hyphen_events.Output /// List repository 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. - /// + /// > [!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 /repos/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`. @@ -299,7 +300,8 @@ extension APIProtocol { /// /// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." /// - /// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + /// > [!NOTE] + /// > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. /// /// - Remark: HTTP `GET /feeds`. /// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`. @@ -464,8 +466,8 @@ extension APIProtocol { } /// List repository 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. - /// + /// > [!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 /repos/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`. @@ -4924,7 +4926,8 @@ public enum Operations { /// /// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." /// - /// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. + /// > [!NOTE] + /// > Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens. /// /// - Remark: HTTP `GET /feeds`. /// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`. @@ -7028,8 +7031,8 @@ public enum Operations { } /// List repository 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. - /// + /// > [!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 /repos/{owner}/{repo}/events`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`. diff --git a/Sources/apps/Client.swift b/Sources/apps/Client.swift index 104dcdb68f4..dfae4f8f131 100644 --- a/Sources/apps/Client.swift +++ b/Sources/apps/Client.swift @@ -1916,7 +1916,8 @@ public struct Client: APIProtocol { } /// Get an app /// - /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + /// > [!NOTE] + /// > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. diff --git a/Sources/apps/Types.swift b/Sources/apps/Types.swift index a64544bb888..f94f2c69c9e 100644 --- a/Sources/apps/Types.swift +++ b/Sources/apps/Types.swift @@ -181,7 +181,8 @@ public protocol APIProtocol: Sendable { func apps_sol_scope_hyphen_token(_ input: Operations.apps_sol_scope_hyphen_token.Input) async throws -> Operations.apps_sol_scope_hyphen_token.Output /// Get an app /// - /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + /// > [!NOTE] + /// > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. @@ -663,7 +664,8 @@ extension APIProtocol { } /// Get an app /// - /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + /// > [!NOTE] + /// > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. @@ -8420,7 +8422,8 @@ public enum Operations { } /// Get an app /// - /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). + /// > [!NOTE] + /// > The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. diff --git a/Sources/checks/Client.swift b/Sources/checks/Client.swift index 74a2ce03de2..c5b2d196a42 100644 --- a/Sources/checks/Client.swift +++ b/Sources/checks/Client.swift @@ -46,7 +46,8 @@ public struct Client: APIProtocol { /// /// In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/post(checks/create)`. @@ -122,7 +123,8 @@ public struct Client: APIProtocol { /// /// Gets a single check run using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -192,7 +194,8 @@ public struct Client: APIProtocol { /// /// Updates a check run for a specific commit in a repository. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -497,7 +500,8 @@ public struct Client: APIProtocol { /// /// Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -672,7 +676,8 @@ public struct Client: APIProtocol { /// /// Gets a single check suite using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -742,7 +747,8 @@ public struct Client: APIProtocol { /// /// Lists check runs for a check suite using its `id`. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -923,7 +929,8 @@ public struct Client: APIProtocol { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. /// @@ -1045,7 +1052,8 @@ public struct Client: APIProtocol { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// diff --git a/Sources/checks/Types.swift b/Sources/checks/Types.swift index b19df27f944..d4aa2f859c7 100644 --- a/Sources/checks/Types.swift +++ b/Sources/checks/Types.swift @@ -19,7 +19,8 @@ public protocol APIProtocol: Sendable { /// /// In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/post(checks/create)`. @@ -28,7 +29,8 @@ public protocol APIProtocol: Sendable { /// /// Gets a single check run using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -39,7 +41,8 @@ public protocol APIProtocol: Sendable { /// /// Updates a check run for a specific commit in a repository. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -70,7 +73,8 @@ public protocol APIProtocol: Sendable { /// /// Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -89,7 +93,8 @@ public protocol APIProtocol: Sendable { /// /// Gets a single check suite using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -100,7 +105,8 @@ public protocol APIProtocol: Sendable { /// /// Lists check runs for a check suite using its `id`. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -120,7 +126,8 @@ public protocol APIProtocol: Sendable { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. /// @@ -133,7 +140,8 @@ public protocol APIProtocol: Sendable { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -152,7 +160,8 @@ extension APIProtocol { /// /// In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/post(checks/create)`. @@ -171,7 +180,8 @@ extension APIProtocol { /// /// Gets a single check run using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -190,7 +200,8 @@ extension APIProtocol { /// /// Updates a check run for a specific commit in a repository. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -249,7 +260,8 @@ extension APIProtocol { /// /// Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -288,7 +300,8 @@ extension APIProtocol { /// /// Gets a single check suite using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -307,7 +320,8 @@ extension APIProtocol { /// /// Lists check runs for a check suite using its `id`. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -345,7 +359,8 @@ extension APIProtocol { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. /// @@ -368,7 +383,8 @@ extension APIProtocol { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -2738,7 +2754,8 @@ public enum Operations { /// /// In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/post(checks/create)`. @@ -3005,7 +3022,8 @@ public enum Operations { /// /// Gets a single check run using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -3157,7 +3175,8 @@ public enum Operations { /// /// Updates a check run for a specific commit in a repository. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -3916,7 +3935,8 @@ public enum Operations { /// /// Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// @@ -4337,7 +4357,8 @@ public enum Operations { /// /// Gets a single check suite using its `id`. /// - /// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -4489,7 +4510,8 @@ public enum Operations { /// /// Lists check runs for a check suite using its `id`. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// @@ -4892,7 +4914,8 @@ public enum Operations { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. /// /// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. /// @@ -5152,7 +5175,8 @@ public enum Operations { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + /// > [!NOTE] + /// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// diff --git a/Sources/code-scanning/Client.swift b/Sources/code-scanning/Client.swift index d4e6d8808e2..4f1ba064bfe 100644 --- a/Sources/code-scanning/Client.swift +++ b/Sources/code-scanning/Client.swift @@ -876,8 +876,8 @@ public struct Client: APIProtocol { /// For very old analyses this data is not available, /// and `0` is returned in this field. /// - /// **Deprecation notice**: - /// The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + /// > [!WARNING] + /// > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. /// /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. /// diff --git a/Sources/code-scanning/Types.swift b/Sources/code-scanning/Types.swift index 79c78d33f2a..b7c4d19fd57 100644 --- a/Sources/code-scanning/Types.swift +++ b/Sources/code-scanning/Types.swift @@ -74,8 +74,8 @@ public protocol APIProtocol: Sendable { /// For very old analyses this data is not available, /// and `0` is returned in this field. /// - /// **Deprecation notice**: - /// The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + /// > [!WARNING] + /// > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. /// /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. /// @@ -412,8 +412,8 @@ extension APIProtocol { /// For very old analyses this data is not available, /// and `0` is returned in this field. /// - /// **Deprecation notice**: - /// The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + /// > [!WARNING] + /// > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. /// /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. /// @@ -4903,8 +4903,8 @@ public enum Operations { /// For very old analyses this data is not available, /// and `0` is returned in this field. /// - /// **Deprecation notice**: - /// The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + /// > [!WARNING] + /// > **Deprecation notice:** The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. /// /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories. /// diff --git a/Sources/code-security/Types.swift b/Sources/code-security/Types.swift index 2243d502a7a..0884b269c6e 100644 --- a/Sources/code-security/Types.swift +++ b/Sources/code-security/Types.swift @@ -1510,8 +1510,7 @@ public enum Operations { /// /// - Remark: Generated from `#/paths/orgs/{org}/code-security/configurations/GET/query/target_type`. public var target_type: Operations.code_hyphen_security_sol_get_hyphen_configurations_hyphen_for_hyphen_org.Input.Query.target_typePayload? - /// 'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."' - /// + /// The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." /// /// - Remark: Generated from `#/paths/orgs/{org}/code-security/configurations/GET/query/per_page`. public var per_page: Swift.Int? @@ -1527,7 +1526,7 @@ public enum Operations { /// /// - Parameters: /// - target_type: The target type of the code security configuration - /// - per_page: 'The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)."' + /// - per_page: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." /// - before: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." /// - after: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." public init( diff --git a/Sources/copilot/Client.swift b/Sources/copilot/Client.swift index 8f654366a6f..67d2e428196 100644 --- a/Sources/copilot/Client.swift +++ b/Sources/copilot/Client.swift @@ -40,7 +40,8 @@ public struct Client: APIProtocol { } /// List all Copilot seat assignments for an enterprise /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// @@ -224,7 +225,8 @@ public struct Client: APIProtocol { } /// Get a summary of Copilot usage for enterprise members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -416,7 +418,8 @@ public struct Client: APIProtocol { } /// Get Copilot seat information and settings for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -578,7 +581,8 @@ public struct Client: APIProtocol { } /// List all Copilot seat assignments for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. /// Only organization owners can view assigned seats. @@ -757,7 +761,8 @@ public struct Client: APIProtocol { } /// Add teams to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -933,7 +938,8 @@ public struct Client: APIProtocol { } /// Remove teams from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for all members of each team specified. /// This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -1107,7 +1113,8 @@ public struct Client: APIProtocol { } /// Add users to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -1283,7 +1290,8 @@ public struct Client: APIProtocol { } /// Remove users from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for each user specified. /// This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -1457,7 +1465,8 @@ public struct Client: APIProtocol { } /// Get a summary of Copilot usage for organization members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -1649,7 +1658,8 @@ public struct Client: APIProtocol { } /// Get Copilot seat assignment details for a user /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// diff --git a/Sources/copilot/Types.swift b/Sources/copilot/Types.swift index 8bc31623a37..3757e956641 100644 --- a/Sources/copilot/Types.swift +++ b/Sources/copilot/Types.swift @@ -13,7 +13,8 @@ import struct Foundation.Date public protocol APIProtocol: Sendable { /// List all Copilot seat assignments for an enterprise /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// @@ -30,7 +31,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_list_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_enterprise(_ input: Operations.copilot_sol_list_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_enterprise.Input) async throws -> Operations.copilot_sol_list_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_enterprise.Output /// Get a summary of Copilot usage for enterprise members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -49,7 +51,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_usage_hyphen_metrics_hyphen_for_hyphen_enterprise(_ input: Operations.copilot_sol_usage_hyphen_metrics_hyphen_for_hyphen_enterprise.Input) async throws -> Operations.copilot_sol_usage_hyphen_metrics_hyphen_for_hyphen_enterprise.Output /// Get Copilot seat information and settings for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -64,7 +67,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_get_hyphen_copilot_hyphen_organization_hyphen_details(_ input: Operations.copilot_sol_get_hyphen_copilot_hyphen_organization_hyphen_details.Input) async throws -> Operations.copilot_sol_get_hyphen_copilot_hyphen_organization_hyphen_details.Output /// List all Copilot seat assignments for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. /// Only organization owners can view assigned seats. @@ -76,7 +80,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_list_hyphen_copilot_hyphen_seats(_ input: Operations.copilot_sol_list_hyphen_copilot_hyphen_seats.Input) async throws -> Operations.copilot_sol_list_hyphen_copilot_hyphen_seats.Output /// Add teams to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -96,7 +101,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_add_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_teams(_ input: Operations.copilot_sol_add_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_teams.Input) async throws -> Operations.copilot_sol_add_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_teams.Output /// Remove teams from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for all members of each team specified. /// This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -114,7 +120,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_cancel_hyphen_copilot_hyphen_seat_hyphen_assignment_hyphen_for_hyphen_teams(_ input: Operations.copilot_sol_cancel_hyphen_copilot_hyphen_seat_hyphen_assignment_hyphen_for_hyphen_teams.Input) async throws -> Operations.copilot_sol_cancel_hyphen_copilot_hyphen_seat_hyphen_assignment_hyphen_for_hyphen_teams.Output /// Add users to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -134,7 +141,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_add_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_users(_ input: Operations.copilot_sol_add_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_users.Input) async throws -> Operations.copilot_sol_add_hyphen_copilot_hyphen_seats_hyphen_for_hyphen_users.Output /// Remove users from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for each user specified. /// This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -152,7 +160,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_cancel_hyphen_copilot_hyphen_seat_hyphen_assignment_hyphen_for_hyphen_users(_ input: Operations.copilot_sol_cancel_hyphen_copilot_hyphen_seat_hyphen_assignment_hyphen_for_hyphen_users.Input) async throws -> Operations.copilot_sol_cancel_hyphen_copilot_hyphen_seat_hyphen_assignment_hyphen_for_hyphen_users.Output /// Get a summary of Copilot usage for organization members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -171,7 +180,8 @@ public protocol APIProtocol: Sendable { func copilot_sol_usage_hyphen_metrics_hyphen_for_hyphen_org(_ input: Operations.copilot_sol_usage_hyphen_metrics_hyphen_for_hyphen_org.Input) async throws -> Operations.copilot_sol_usage_hyphen_metrics_hyphen_for_hyphen_org.Output /// Get Copilot seat assignment details for a user /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// @@ -188,7 +198,8 @@ public protocol APIProtocol: Sendable { extension APIProtocol { /// List all Copilot seat assignments for an enterprise /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// @@ -215,7 +226,8 @@ extension APIProtocol { } /// Get a summary of Copilot usage for enterprise members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -244,7 +256,8 @@ extension APIProtocol { } /// Get Copilot seat information and settings for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -267,7 +280,8 @@ extension APIProtocol { } /// List all Copilot seat assignments for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. /// Only organization owners can view assigned seats. @@ -289,7 +303,8 @@ extension APIProtocol { } /// Add teams to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -319,7 +334,8 @@ extension APIProtocol { } /// Remove teams from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for all members of each team specified. /// This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -347,7 +363,8 @@ extension APIProtocol { } /// Add users to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -377,7 +394,8 @@ extension APIProtocol { } /// Remove users from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for each user specified. /// This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -405,7 +423,8 @@ extension APIProtocol { } /// Get a summary of Copilot usage for organization members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -434,7 +453,8 @@ extension APIProtocol { } /// Get Copilot seat assignment details for a user /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// @@ -2203,7 +2223,8 @@ public enum Components { public enum Operations { /// List all Copilot seat assignments for an enterprise /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. /// @@ -2508,7 +2529,8 @@ public enum Operations { } /// Get a summary of Copilot usage for enterprise members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// for all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances, @@ -2785,7 +2807,8 @@ public enum Operations { } /// Get Copilot seat information and settings for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets information about an organization's Copilot subscription, including seat breakdown /// and feature policies. To configure these settings, go to your organization's settings on GitHub.com. @@ -3044,7 +3067,8 @@ public enum Operations { } /// List all Copilot seat assignments for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Lists all active Copilot seats for an organization with a Copilot Business or Copilot Enterprise subscription. /// Only organization owners can view assigned seats. @@ -3344,7 +3368,8 @@ public enum Operations { } /// Add teams to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -3651,7 +3676,8 @@ public enum Operations { } /// Remove teams from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for all members of each team specified. /// This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -3956,7 +3982,8 @@ public enum Operations { } /// Add users to the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Purchases a GitHub Copilot seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". @@ -4263,7 +4290,8 @@ public enum Operations { } /// Remove users from the Copilot subscription for an organization /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Cancels the Copilot seat assignment for each user specified. /// This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. @@ -4568,7 +4596,8 @@ public enum Operations { } /// Get a summary of Copilot usage for organization members /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE /// across an organization, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. @@ -4845,7 +4874,8 @@ public enum Operations { } /// Get Copilot seat assignment details for a user /// - /// **Note**: This endpoint is in beta and is subject to change. + /// > [!NOTE] + /// > This endpoint is in beta and is subject to change. /// /// Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// diff --git a/Sources/gists/Client.swift b/Sources/gists/Client.swift index 65a456f88e6..334f4dbd58d 100644 --- a/Sources/gists/Client.swift +++ b/Sources/gists/Client.swift @@ -157,7 +157,8 @@ public struct Client: APIProtocol { /// /// Allows you to add a new gist with one or more files. /// - /// **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + /// > [!NOTE] + /// > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. /// /// - Remark: HTTP `POST /gists`. /// - Remark: Generated from `#/paths//gists/post(gists/create)`. diff --git a/Sources/gists/Types.swift b/Sources/gists/Types.swift index b8015b40a01..1b538eb8d6d 100644 --- a/Sources/gists/Types.swift +++ b/Sources/gists/Types.swift @@ -22,7 +22,8 @@ public protocol APIProtocol: Sendable { /// /// Allows you to add a new gist with one or more files. /// - /// **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + /// > [!NOTE] + /// > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. /// /// - Remark: HTTP `POST /gists`. /// - Remark: Generated from `#/paths//gists/post(gists/create)`. @@ -217,7 +218,8 @@ extension APIProtocol { /// /// Allows you to add a new gist with one or more files. /// - /// **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + /// > [!NOTE] + /// > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. /// /// - Remark: HTTP `POST /gists`. /// - Remark: Generated from `#/paths//gists/post(gists/create)`. @@ -2826,7 +2828,8 @@ public enum Operations { /// /// Allows you to add a new gist with one or more files. /// - /// **Note:** Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. + /// > [!NOTE] + /// > Don't name your files "gistfile" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally. /// /// - Remark: HTTP `POST /gists`. /// - Remark: Generated from `#/paths//gists/post(gists/create)`. diff --git a/Sources/git/Client.swift b/Sources/git/Client.swift index 6a2eaeabbcc..8de5f0ee12c 100644 --- a/Sources/git/Client.swift +++ b/Sources/git/Client.swift @@ -693,7 +693,8 @@ public struct Client: APIProtocol { /// /// When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. /// @@ -793,7 +794,8 @@ public struct Client: APIProtocol { /// /// Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/ref/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/ref/{ref}/get(git/get-ref)`. @@ -1708,8 +1710,8 @@ public struct Client: APIProtocol { /// /// If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. /// - /// - /// **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + /// > [!NOTE] + /// > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/trees/{tree_sha}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/trees/{tree_sha}/get(git/get-tree)`. diff --git a/Sources/git/Types.swift b/Sources/git/Types.swift index ce0602433b8..64050038238 100644 --- a/Sources/git/Types.swift +++ b/Sources/git/Types.swift @@ -112,7 +112,8 @@ public protocol APIProtocol: Sendable { /// /// When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. /// @@ -123,7 +124,8 @@ public protocol APIProtocol: Sendable { /// /// Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/ref/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/ref/{ref}/get(git/get-ref)`. @@ -236,8 +238,8 @@ public protocol APIProtocol: Sendable { /// /// If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. /// - /// - /// **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + /// > [!NOTE] + /// > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/trees/{tree_sha}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/trees/{tree_sha}/get(git/get-tree)`. @@ -383,7 +385,8 @@ extension APIProtocol { /// /// When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. /// @@ -402,7 +405,8 @@ extension APIProtocol { /// /// Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/ref/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/ref/{ref}/get(git/get-ref)`. @@ -579,8 +583,8 @@ extension APIProtocol { /// /// If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. /// - /// - /// **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + /// > [!NOTE] + /// > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/trees/{tree_sha}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/trees/{tree_sha}/get(git/get-tree)`. @@ -2184,7 +2188,7 @@ public enum Operations { /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/git/commits/POST/requestBody/json/tree`. public var tree: Swift.String - /// The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + /// The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/git/commits/POST/requestBody/json/parents`. public var parents: [Swift.String]? @@ -2279,7 +2283,7 @@ public enum Operations { /// - Parameters: /// - message: The commit message /// - tree: The SHA of the tree object this commit points to - /// - parents: The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. + /// - parents: The full SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided. /// - author: Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details. /// - committer: Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details. /// - signature: The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits. @@ -2729,7 +2733,8 @@ public enum Operations { /// /// When you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// If you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`. /// @@ -2923,7 +2928,8 @@ public enum Operations { /// /// Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned. /// - /// **Note:** You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". + /// > [!NOTE] + /// > You need to explicitly [request a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "[Checking mergeability of pull requests](https://docs.github.com/rest/guides/getting-started-with-the-git-database-api#checking-mergeability-of-pull-requests)". /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/ref/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/ref/{ref}/get(git/get-ref)`. @@ -4453,7 +4459,6 @@ public enum Operations { /// The SHA1 of an existing Git tree object which will be used as the base for the new tree. If provided, a new Git tree object will be created from entries in the Git tree object pointed to by `base_tree` and entries defined in the `tree` parameter. Entries defined in the `tree` parameter will overwrite items from `base_tree` with the same `path`. If you're creating new changes on a branch, then normally you'd set `base_tree` to the SHA1 of the Git tree object of the current latest commit on the branch you're working on. /// If not provided, GitHub will create a new Git tree object from only the entries defined in the `tree` parameter. If you create a new commit pointing to such a tree, then all files which were a part of the parent commit's tree and were not defined in the `tree` parameter will be listed as deleted by the new commit. /// - /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/git/trees/POST/requestBody/json/base_tree`. public var base_tree: Swift.String? /// Creates a new `jsonPayload`. @@ -4693,8 +4698,8 @@ public enum Operations { /// /// If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. /// - /// - /// **Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. + /// > [!NOTE] + /// > The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/git/trees/{tree_sha}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/git/trees/{tree_sha}/get(git/get-tree)`. diff --git a/Sources/issues/Client.swift b/Sources/issues/Client.swift index f5f8f543f24..8511215829f 100644 --- a/Sources/issues/Client.swift +++ b/Sources/issues/Client.swift @@ -44,10 +44,8 @@ public struct Client: APIProtocol { /// repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not /// necessarily assigned to you. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -256,10 +254,8 @@ public struct Client: APIProtocol { /// /// List issues in an organization assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -599,10 +595,8 @@ public struct Client: APIProtocol { /// /// List issues in a repository. Only open issues will be listed. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -1708,10 +1702,8 @@ public struct Client: APIProtocol { /// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe /// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -4855,10 +4847,8 @@ public struct Client: APIProtocol { /// /// List issues across owned and member repositories assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// diff --git a/Sources/issues/Types.swift b/Sources/issues/Types.swift index 07e0bd0ad91..79ba5083877 100644 --- a/Sources/issues/Types.swift +++ b/Sources/issues/Types.swift @@ -17,10 +17,8 @@ public protocol APIProtocol: Sendable { /// repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not /// necessarily assigned to you. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -36,10 +34,8 @@ public protocol APIProtocol: Sendable { /// /// List issues in an organization assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -73,10 +69,8 @@ public protocol APIProtocol: Sendable { /// /// List issues in a repository. Only open issues will be listed. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -179,10 +173,8 @@ public protocol APIProtocol: Sendable { /// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe /// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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,10 +406,8 @@ public protocol APIProtocol: Sendable { /// /// List issues across owned and member repositories assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -439,10 +429,8 @@ extension APIProtocol { /// repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not /// necessarily assigned to you. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -466,10 +454,8 @@ extension APIProtocol { /// /// List issues in an organization assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -531,10 +517,8 @@ extension APIProtocol { /// /// List issues in a repository. Only open issues will be listed. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -705,10 +689,8 @@ extension APIProtocol { /// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe /// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -1186,10 +1168,8 @@ extension APIProtocol { /// /// List issues across owned and member repositories assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -8311,10 +8291,8 @@ public enum Operations { /// repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not /// necessarily assigned to you. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -8640,10 +8618,8 @@ public enum Operations { /// /// List issues in an organization assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -9308,10 +9284,8 @@ public enum Operations { /// /// List issues in a repository. Only open issues will be listed. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -11351,10 +11325,8 @@ public enum Operations { /// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe /// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// @@ -17682,10 +17654,8 @@ public enum Operations { /// /// List issues across owned and member repositories assigned to the authenticated user. /// - /// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this - /// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by - /// the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull - /// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + /// > [!NOTE] + /// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. /// /// 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)." /// diff --git a/Sources/meta/Client.swift b/Sources/meta/Client.swift index a514f63de60..e09e79607db 100644 --- a/Sources/meta/Client.swift +++ b/Sources/meta/Client.swift @@ -108,7 +108,8 @@ public struct Client: APIProtocol { /// /// The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. /// - /// **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + /// > [!NOTE] + /// > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. /// /// - Remark: HTTP `GET /meta`. /// - Remark: Generated from `#/paths//meta/get(meta/get)`. diff --git a/Sources/meta/Types.swift b/Sources/meta/Types.swift index 874d39c913a..21d62dc36d8 100644 --- a/Sources/meta/Types.swift +++ b/Sources/meta/Types.swift @@ -26,7 +26,8 @@ public protocol APIProtocol: Sendable { /// /// The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. /// - /// **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + /// > [!NOTE] + /// > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. /// /// - Remark: HTTP `GET /meta`. /// - Remark: Generated from `#/paths//meta/get(meta/get)`. @@ -73,7 +74,8 @@ extension APIProtocol { /// /// The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. /// - /// **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + /// > [!NOTE] + /// > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. /// /// - Remark: HTTP `GET /meta`. /// - Remark: Generated from `#/paths//meta/get(meta/get)`. @@ -721,7 +723,8 @@ public enum Operations { /// /// The values shown in the documentation's response are example values. You must always query the API directly to get the latest values. /// - /// **Note:** This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. + /// > [!NOTE] + /// > This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported. /// /// - Remark: HTTP `GET /meta`. /// - Remark: Generated from `#/paths//meta/get(meta/get)`. diff --git a/Sources/migrations/Client.swift b/Sources/migrations/Client.swift index dce7deab2e8..f0366d78270 100644 --- a/Sources/migrations/Client.swift +++ b/Sources/migrations/Client.swift @@ -666,7 +666,8 @@ public struct Client: APIProtocol { /// /// View the progress of an import. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// **Import status** /// @@ -816,7 +817,8 @@ public struct Client: APIProtocol { /// have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. /// You can select the project to import by providing one of the objects in the `project_choices` array in the update request. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/patch(migrations/update-import)`. @@ -919,8 +921,8 @@ public struct Client: APIProtocol { /// Importing into a GitHub repository with GitHub Actions enabled is not supported and will /// return a status `422 Unprocessable Entity` response. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/put(migrations/start-import)`. @@ -1071,8 +1073,8 @@ public struct Client: APIProtocol { /// /// Stop an import for a repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/delete(migrations/cancel-import)`. @@ -1144,7 +1146,8 @@ public struct Client: APIProtocol { /// /// This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/authors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/get(migrations/get-commit-authors)`. @@ -1264,8 +1267,8 @@ public struct Client: APIProtocol { /// Update an author's identity for the import. Your application can continue updating authors any time before you push /// new commits to the repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/authors/{author_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/{author_id}/patch(migrations/map-commit-author)`. @@ -1411,8 +1414,8 @@ public struct Client: APIProtocol { /// /// List files larger than 100MB found during the import /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/large_files`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/large_files/get(migrations/get-large-files)`. @@ -1506,8 +1509,8 @@ public struct Client: APIProtocol { /// You can learn more about our LFS feature and working with large files [on our help /// site](https://docs.github.com/repositories/working-with-files/managing-large-files). /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/lfs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/lfs/patch(migrations/set-lfs-preference)`. diff --git a/Sources/migrations/Types.swift b/Sources/migrations/Types.swift index 46c861f1dec..186e2d975f7 100644 --- a/Sources/migrations/Types.swift +++ b/Sources/migrations/Types.swift @@ -73,7 +73,8 @@ public protocol APIProtocol: Sendable { /// /// View the progress of an import. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// **Import status** /// @@ -121,7 +122,8 @@ public protocol APIProtocol: Sendable { /// have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. /// You can select the project to import by providing one of the objects in the `project_choices` array in the update request. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/patch(migrations/update-import)`. @@ -133,8 +135,8 @@ public protocol APIProtocol: Sendable { /// Importing into a GitHub repository with GitHub Actions enabled is not supported and will /// return a status `422 Unprocessable Entity` response. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/put(migrations/start-import)`. @@ -144,8 +146,8 @@ public protocol APIProtocol: Sendable { /// /// Stop an import for a repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/delete(migrations/cancel-import)`. @@ -157,7 +159,8 @@ public protocol APIProtocol: Sendable { /// /// This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/authors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/get(migrations/get-commit-authors)`. @@ -168,8 +171,8 @@ public protocol APIProtocol: Sendable { /// Update an author's identity for the import. Your application can continue updating authors any time before you push /// new commits to the repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/authors/{author_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/{author_id}/patch(migrations/map-commit-author)`. @@ -179,8 +182,8 @@ public protocol APIProtocol: Sendable { /// /// List files larger than 100MB found during the import /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/large_files`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/large_files/get(migrations/get-large-files)`. @@ -194,8 +197,8 @@ public protocol APIProtocol: Sendable { /// You can learn more about our LFS feature and working with large files [on our help /// site](https://docs.github.com/repositories/working-with-files/managing-large-files). /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/lfs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/lfs/patch(migrations/set-lfs-preference)`. @@ -407,7 +410,8 @@ extension APIProtocol { /// /// View the progress of an import. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// **Import status** /// @@ -463,7 +467,8 @@ extension APIProtocol { /// have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. /// You can select the project to import by providing one of the objects in the `project_choices` array in the update request. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/patch(migrations/update-import)`. @@ -485,8 +490,8 @@ extension APIProtocol { /// Importing into a GitHub repository with GitHub Actions enabled is not supported and will /// return a status `422 Unprocessable Entity` response. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/put(migrations/start-import)`. @@ -506,8 +511,8 @@ extension APIProtocol { /// /// Stop an import for a repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/delete(migrations/cancel-import)`. @@ -527,7 +532,8 @@ extension APIProtocol { /// /// This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/authors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/get(migrations/get-commit-authors)`. @@ -548,8 +554,8 @@ extension APIProtocol { /// Update an author's identity for the import. Your application can continue updating authors any time before you push /// new commits to the repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/authors/{author_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/{author_id}/patch(migrations/map-commit-author)`. @@ -569,8 +575,8 @@ extension APIProtocol { /// /// List files larger than 100MB found during the import /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/large_files`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/large_files/get(migrations/get-large-files)`. @@ -592,8 +598,8 @@ extension APIProtocol { /// You can learn more about our LFS feature and working with large files [on our help /// site](https://docs.github.com/repositories/working-with-files/managing-large-files). /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/lfs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/lfs/patch(migrations/set-lfs-preference)`. @@ -4729,7 +4735,8 @@ public enum Operations { /// /// View the progress of an import. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// **Import status** /// @@ -4956,7 +4963,8 @@ public enum Operations { /// have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. /// You can select the project to import by providing one of the objects in the `project_choices` array in the update request. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/patch(migrations/update-import)`. @@ -5185,8 +5193,8 @@ public enum Operations { /// Importing into a GitHub repository with GitHub Actions enabled is not supported and will /// return a status `422 Unprocessable Entity` response. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/put(migrations/start-import)`. @@ -5486,8 +5494,8 @@ public enum Operations { /// /// Stop an import for a repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/import`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/delete(migrations/cancel-import)`. @@ -5631,7 +5639,8 @@ public enum Operations { /// /// This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/authors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/get(migrations/get-commit-authors)`. @@ -5839,8 +5848,8 @@ public enum Operations { /// Update an author's identity for the import. Your application can continue updating authors any time before you push /// new commits to the repository. /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/authors/{author_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/authors/{author_id}/patch(migrations/map-commit-author)`. @@ -6108,8 +6117,8 @@ public enum Operations { /// /// List files larger than 100MB found during the import /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/import/large_files`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/large_files/get(migrations/get-large-files)`. @@ -6279,8 +6288,8 @@ public enum Operations { /// You can learn more about our LFS feature and working with large files [on our help /// site](https://docs.github.com/repositories/working-with-files/managing-large-files). /// - /// **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). - /// + /// > [!WARNING] + /// > **Deprecation notice:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/import/lfs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/import/lfs/patch(migrations/set-lfs-preference)`. diff --git a/Sources/orgs/Client.swift b/Sources/orgs/Client.swift index e4804752110..51f3dd1da5d 100644 --- a/Sources/orgs/Client.swift +++ b/Sources/orgs/Client.swift @@ -42,7 +42,8 @@ public struct Client: APIProtocol { /// /// Lists all organizations, in the order that they were created. /// - /// **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + /// > [!NOTE] + /// > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. /// /// - Remark: HTTP `GET /organizations`. /// - Remark: Generated from `#/paths//organizations/get(orgs/list)`. @@ -222,9 +223,11 @@ public struct Client: APIProtocol { } /// Update an organization /// - /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + /// > [!WARNING] + /// > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// **Parameter Deprecation Notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + /// > [!WARNING] + /// > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). /// /// Updates the organization's profile and member privileges. /// @@ -3166,126 +3169,9 @@ public struct Client: APIProtocol { } ) } - /// List organization fine-grained permissions for an organization - /// - /// Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. - public func orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions(_ input: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input) async throws -> Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output { - try await client.send( - input: input, - forOperation: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.id, - serializer: { input in - let path = try converter.renderedPath( - template: "/orgs/{}/organization-fine-grained-permissions", - parameters: [ - input.path.org - ] - ) - var request: HTTPTypes.HTTPRequest = .init( - soar_path: path, - method: .get - ) - suppressMutabilityWarning(&request) - converter.setAcceptHeader( - in: &request.headerFields, - contentTypes: input.headers.accept - ) - return (request, nil) - }, - deserializer: { response, responseBody in - switch response.status.code { - case 200: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output.Ok.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - [Components.Schemas.organization_hyphen_fine_hyphen_grained_hyphen_permission].self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .ok(.init(body: body)) - case 404: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.not_found.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.basic_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .notFound(.init(body: body)) - case 422: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.validation_failed.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.validation_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .unprocessableContent(.init(body: body)) - default: - return .undocumented( - statusCode: response.status.code, - .init( - headerFields: response.headerFields, - body: responseBody - ) - ) - } - } - ) - } /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -3398,155 +3284,9 @@ public struct Client: APIProtocol { } ) } - /// Create a custom organization role - /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. - public func orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output { - try await client.send( - input: input, - forOperation: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.id, - serializer: { input in - let path = try converter.renderedPath( - template: "/orgs/{}/organization-roles", - parameters: [ - input.path.org - ] - ) - var request: HTTPTypes.HTTPRequest = .init( - soar_path: path, - method: .post - ) - suppressMutabilityWarning(&request) - converter.setAcceptHeader( - in: &request.headerFields, - contentTypes: input.headers.accept - ) - let body: OpenAPIRuntime.HTTPBody? - switch input.body { - case let .json(value): - body = try converter.setRequiredRequestBodyAsJSON( - value, - headerFields: &request.headerFields, - contentType: "application/json; charset=utf-8" - ) - } - return (request, body) - }, - deserializer: { response, responseBody in - switch response.status.code { - case 201: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output.Created.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.organization_hyphen_role.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .created(.init(body: body)) - case 422: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.validation_failed.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.validation_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .unprocessableContent(.init(body: body)) - case 404: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.not_found.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.basic_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .notFound(.init(body: body)) - case 409: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.conflict.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.basic_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .conflict(.init(body: body)) - default: - return .undocumented( - statusCode: response.status.code, - .init( - headerFields: response.headerFields, - body: responseBody - ) - ) - } - } - ) - } /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -3591,7 +3331,7 @@ public struct Client: APIProtocol { } /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -3641,7 +3381,7 @@ public struct Client: APIProtocol { } /// Remove an organization role from a team /// - /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -3687,7 +3427,7 @@ public struct Client: APIProtocol { } /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -3732,7 +3472,7 @@ public struct Client: APIProtocol { } /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -3782,7 +3522,7 @@ public struct Client: APIProtocol { } /// Remove an organization role from a user /// - /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -3828,7 +3568,7 @@ public struct Client: APIProtocol { } /// Get an organization role /// - /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -3942,205 +3682,9 @@ public struct Client: APIProtocol { } ) } - /// Update a custom organization role - /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. - public func orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output { - try await client.send( - input: input, - forOperation: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.id, - serializer: { input in - let path = try converter.renderedPath( - template: "/orgs/{}/organization-roles/{}", - parameters: [ - input.path.org, - input.path.role_id - ] - ) - var request: HTTPTypes.HTTPRequest = .init( - soar_path: path, - method: .patch - ) - suppressMutabilityWarning(&request) - converter.setAcceptHeader( - in: &request.headerFields, - contentTypes: input.headers.accept - ) - let body: OpenAPIRuntime.HTTPBody? - switch input.body { - case let .json(value): - body = try converter.setRequiredRequestBodyAsJSON( - value, - headerFields: &request.headerFields, - contentType: "application/json; charset=utf-8" - ) - } - return (request, body) - }, - deserializer: { response, responseBody in - switch response.status.code { - case 200: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output.Ok.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.organization_hyphen_role.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .ok(.init(body: body)) - case 422: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.validation_failed.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.validation_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .unprocessableContent(.init(body: body)) - case 409: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.conflict.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.basic_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .conflict(.init(body: body)) - case 404: - let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) - let body: Components.Responses.not_found.Body - let chosenContentType = try converter.bestContentType( - received: contentType, - options: [ - "application/json" - ] - ) - switch chosenContentType { - case "application/json": - body = try await converter.getResponseBodyAsJSON( - Components.Schemas.basic_hyphen_error.self, - from: responseBody, - transforming: { value in - .json(value) - } - ) - default: - preconditionFailure("bestContentType chose an invalid content type.") - } - return .notFound(.init(body: body)) - default: - return .undocumented( - statusCode: response.status.code, - .init( - headerFields: response.headerFields, - body: responseBody - ) - ) - } - } - ) - } - /// Delete a custom organization role. - /// - /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. - public func orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Output { - try await client.send( - input: input, - forOperation: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.id, - serializer: { input in - let path = try converter.renderedPath( - template: "/orgs/{}/organization-roles/{}", - parameters: [ - input.path.org, - input.path.role_id - ] - ) - var request: HTTPTypes.HTTPRequest = .init( - soar_path: path, - method: .delete - ) - suppressMutabilityWarning(&request) - return (request, nil) - }, - deserializer: { response, responseBody in - switch response.status.code { - case 204: - return .noContent(.init()) - default: - return .undocumented( - statusCode: response.status.code, - .init( - headerFields: response.headerFields, - body: responseBody - ) - ) - } - } - ) - } /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -4235,7 +3779,7 @@ public struct Client: APIProtocol { } /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -7184,6 +6728,9 @@ public struct Client: APIProtocol { } /// Enable or disable a security feature for an organization /// + /// > [!WARNING] + /// > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + /// /// Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -7192,6 +6739,7 @@ public struct Client: APIProtocol { /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. + @available(*, deprecated) public func orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos(_ input: Operations.orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos.Input) async throws -> Operations.orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos.Output { try await client.send( input: input, diff --git a/Sources/orgs/Types.swift b/Sources/orgs/Types.swift index ac9573b07f7..03b208720a2 100644 --- a/Sources/orgs/Types.swift +++ b/Sources/orgs/Types.swift @@ -15,7 +15,8 @@ public protocol APIProtocol: Sendable { /// /// Lists all organizations, in the order that they were created. /// - /// **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + /// > [!NOTE] + /// > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. /// /// - Remark: HTTP `GET /organizations`. /// - Remark: Generated from `#/paths//organizations/get(orgs/list)`. @@ -37,9 +38,11 @@ public protocol APIProtocol: Sendable { func orgs_sol_get(_ input: Operations.orgs_sol_get.Input) async throws -> Operations.orgs_sol_get.Output /// Update an organization /// - /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + /// > [!WARNING] + /// > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// **Parameter Deprecation Notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + /// > [!WARNING] + /// > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). /// /// Updates the organization's profile and member privileges. /// @@ -343,25 +346,9 @@ public protocol APIProtocol: Sendable { /// - Remark: HTTP `DELETE /orgs/{org}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/memberships/{username}/delete(orgs/remove-membership-for-user)`. func orgs_sol_remove_hyphen_membership_hyphen_for_hyphen_user(_ input: Operations.orgs_sol_remove_hyphen_membership_hyphen_for_hyphen_user.Input) async throws -> Operations.orgs_sol_remove_hyphen_membership_hyphen_for_hyphen_user.Output - /// List organization fine-grained permissions for an organization - /// - /// Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. - func orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions(_ input: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input) async throws -> Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -373,23 +360,9 @@ public protocol APIProtocol: Sendable { /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. func orgs_sol_list_hyphen_org_hyphen_roles(_ input: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input) async throws -> Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output - /// Create a custom organization role - /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. - func orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -400,7 +373,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team(_ input: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Input) async throws -> Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Output /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -411,7 +384,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_assign_hyphen_team_hyphen_to_hyphen_org_hyphen_role(_ input: Operations.orgs_sol_assign_hyphen_team_hyphen_to_hyphen_org_hyphen_role.Input) async throws -> Operations.orgs_sol_assign_hyphen_team_hyphen_to_hyphen_org_hyphen_role.Output /// Remove an organization role from a team /// - /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -422,7 +395,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_team(_ input: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_team.Input) async throws -> Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_team.Output /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -433,7 +406,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_user(_ input: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_user.Input) async throws -> Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_user.Output /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -444,7 +417,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_assign_hyphen_user_hyphen_to_hyphen_org_hyphen_role(_ input: Operations.orgs_sol_assign_hyphen_user_hyphen_to_hyphen_org_hyphen_role.Input) async throws -> Operations.orgs_sol_assign_hyphen_user_hyphen_to_hyphen_org_hyphen_role.Output /// Remove an organization role from a user /// - /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -455,7 +428,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user(_ input: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Input) async throws -> Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Output /// Get an organization role /// - /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -467,38 +440,9 @@ public protocol APIProtocol: Sendable { /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. func orgs_sol_get_hyphen_org_hyphen_role(_ input: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input) async throws -> Operations.orgs_sol_get_hyphen_org_hyphen_role.Output - /// Update a custom organization role - /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. - func orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output - /// Delete a custom organization role. - /// - /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. - func orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Output /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -509,7 +453,7 @@ public protocol APIProtocol: Sendable { func orgs_sol_list_hyphen_org_hyphen_role_hyphen_teams(_ input: Operations.orgs_sol_list_hyphen_org_hyphen_role_hyphen_teams.Input) async throws -> Operations.orgs_sol_list_hyphen_org_hyphen_role_hyphen_teams.Output /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -749,6 +693,9 @@ public protocol APIProtocol: Sendable { func orgs_sol_remove_hyphen_security_hyphen_manager_hyphen_team(_ input: Operations.orgs_sol_remove_hyphen_security_hyphen_manager_hyphen_team.Input) async throws -> Operations.orgs_sol_remove_hyphen_security_hyphen_manager_hyphen_team.Output /// Enable or disable a security feature for an organization /// + /// > [!WARNING] + /// > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + /// /// Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -757,6 +704,7 @@ public protocol APIProtocol: Sendable { /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. + @available(*, deprecated) func orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos(_ input: Operations.orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos.Input) async throws -> Operations.orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos.Output /// List organization memberships for the authenticated user /// @@ -805,7 +753,8 @@ extension APIProtocol { /// /// Lists all organizations, in the order that they were created. /// - /// **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + /// > [!NOTE] + /// > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. /// /// - Remark: HTTP `GET /organizations`. /// - Remark: Generated from `#/paths//organizations/get(orgs/list)`. @@ -843,9 +792,11 @@ extension APIProtocol { } /// Update an organization /// - /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + /// > [!WARNING] + /// > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// **Parameter Deprecation Notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + /// > [!WARNING] + /// > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). /// /// Updates the organization's profile and member privileges. /// @@ -1407,33 +1358,9 @@ extension APIProtocol { headers: headers )) } - /// List organization fine-grained permissions for an organization - /// - /// Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. - public func orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions( - path: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input.Path, - headers: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input.Headers = .init() - ) async throws -> Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output { - try await orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions(Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input( - path: path, - headers: headers - )) - } /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -1453,33 +1380,9 @@ extension APIProtocol { headers: headers )) } - /// Create a custom organization role - /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. - public func orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role( - path: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Path, - headers: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Headers = .init(), - body: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Body - ) async throws -> Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output { - try await orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role(Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input( - path: path, - headers: headers, - body: body - )) - } /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -1492,7 +1395,7 @@ extension APIProtocol { } /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -1505,7 +1408,7 @@ extension APIProtocol { } /// Remove an organization role from a team /// - /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -1518,7 +1421,7 @@ extension APIProtocol { } /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -1531,7 +1434,7 @@ extension APIProtocol { } /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -1544,7 +1447,7 @@ extension APIProtocol { } /// Remove an organization role from a user /// - /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -1557,7 +1460,7 @@ extension APIProtocol { } /// Get an organization role /// - /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -1577,50 +1480,9 @@ extension APIProtocol { headers: headers )) } - /// Update a custom organization role - /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. - public func orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role( - path: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Path, - headers: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Headers = .init(), - body: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Body - ) async throws -> Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output { - try await orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role(Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input( - path: path, - headers: headers, - body: body - )) - } - /// Delete a custom organization role. - /// - /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. - public func orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role(path: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input.Path) async throws -> Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Output { - try await orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role(Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input(path: path)) - } /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -1641,7 +1503,7 @@ extension APIProtocol { } /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -2097,6 +1959,9 @@ extension APIProtocol { } /// Enable or disable a security feature for an organization /// + /// > [!WARNING] + /// > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + /// /// Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. @@ -2105,6 +1970,7 @@ extension APIProtocol { /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. + @available(*, deprecated) public func orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos( path: Operations.orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos.Input.Path, body: Operations.orgs_sol_enable_hyphen_or_hyphen_disable_hyphen_security_hyphen_product_hyphen_on_hyphen_all_hyphen_org_hyphen_repos.Input.Body? = nil @@ -6047,31 +5913,6 @@ public enum Components { case permissions } } - /// A fine-grained permission that protects organization resources. - /// - /// - Remark: Generated from `#/components/schemas/organization-fine-grained-permission`. - public struct organization_hyphen_fine_hyphen_grained_hyphen_permission: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/organization-fine-grained-permission/name`. - public var name: Swift.String - /// - Remark: Generated from `#/components/schemas/organization-fine-grained-permission/description`. - public var description: Swift.String - /// Creates a new `organization_hyphen_fine_hyphen_grained_hyphen_permission`. - /// - /// - Parameters: - /// - name: - /// - description: - public init( - name: Swift.String, - description: Swift.String - ) { - self.name = name - self.description = description - } - public enum CodingKeys: String, CodingKey { - case name - case description - } - } /// Organization roles /// /// - Remark: Generated from `#/components/schemas/organization-role`. @@ -7502,7 +7343,8 @@ public enum Operations { /// /// Lists all organizations, in the order that they were created. /// - /// **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. + /// > [!NOTE] + /// > Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. /// /// - Remark: HTTP `GET /organizations`. /// - Remark: Generated from `#/paths//organizations/get(orgs/list)`. @@ -7848,9 +7690,11 @@ public enum Operations { } /// Update an organization /// - /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). + /// > [!WARNING] + /// > **Parameter deprecation notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// **Parameter Deprecation Notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). + /// > [!WARNING] + /// > **Parameter deprecation notice:** Code security product enablement for new repositories through the organization API is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations#set-a-code-security-configuration-as-a-default-for-an-organization) to set defaults instead. For more information on setting a default security configuration, see the [changelog](https://github.blog/changelog/2024-07-09-sunsetting-security-settings-defaults-parameters-in-the-organizations-rest-api/). /// /// Updates the organization's profile and member privileges. /// @@ -13949,11 +13793,9 @@ public enum Operations { } } } - /// List organization fine-grained permissions for an organization - /// - /// Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Get all organization roles for an organization /// - /// To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// @@ -13962,16 +13804,16 @@ public enum Operations { /// /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// - /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. - public enum orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions { - public static let id: Swift.String = "orgs/list-organization-fine-grained-permissions" + /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. + public enum orgs_sol_list_hyphen_org_hyphen_roles { + public static let id: Swift.String = "orgs/list-org-roles" public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-fine-grained-permissions/GET/path`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/path`. public struct Path: Sendable, Hashable { /// The organization name. The name is not case sensitive. /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-fine-grained-permissions/GET/path/org`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/path/org`. public var org: Components.Parameters.org /// Creates a new `Path`. /// @@ -13981,27 +13823,27 @@ public enum Operations { self.org = org } } - public var path: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input.Path - /// - Remark: Generated from `#/paths/orgs/{org}/organization-fine-grained-permissions/GET/header`. + public var path: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Path + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/header`. public struct Headers: Sendable, Hashable { - public var accept: [OpenAPIRuntime.AcceptHeaderContentType] + public var accept: [OpenAPIRuntime.AcceptHeaderContentType] /// Creates a new `Headers`. /// /// - Parameters: /// - accept: - public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { + public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { self.accept = accept } } - public var headers: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input.Headers + public var headers: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Headers /// Creates a new `Input`. /// /// - Parameters: /// - path: /// - headers: public init( - path: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input.Path, - headers: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input.Headers = .init() + path: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Path, + headers: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Headers = .init() ) { self.path = path self.headers = headers @@ -14009,15 +13851,42 @@ public enum Operations { } @frozen public enum Output: Sendable, Hashable { public struct Ok: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-fine-grained-permissions/GET/responses/200/content`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content`. @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-fine-grained-permissions/GET/responses/200/content/application\/json`. - case json([Components.Schemas.organization_hyphen_fine_hyphen_grained_hyphen_permission]) + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/json`. + public struct jsonPayload: Codable, Hashable, Sendable { + /// The total number of organization roles available to the organization. + /// + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/json/total_count`. + public var total_count: Swift.Int? + /// The list of organization roles available to the organization. + /// + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/json/roles`. + public var roles: [Components.Schemas.organization_hyphen_role]? + /// Creates a new `jsonPayload`. + /// + /// - Parameters: + /// - total_count: The total number of organization roles available to the organization. + /// - roles: The list of organization roles available to the organization. + public init( + total_count: Swift.Int? = nil, + roles: [Components.Schemas.organization_hyphen_role]? = nil + ) { + self.total_count = total_count + self.roles = roles + } + public enum CodingKeys: String, CodingKey { + case total_count + case roles + } + } + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/application\/json`. + case json(Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body.jsonPayload) /// The associated value of the enum case if `self` is `.json`. /// /// - Throws: An error if `self` is not `.json`. /// - SeeAlso: `.json`. - public var json: [Components.Schemas.organization_hyphen_fine_hyphen_grained_hyphen_permission] { + public var json: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body.jsonPayload { get throws { switch self { case let .json(body): @@ -14027,26 +13896,26 @@ public enum Operations { } } /// Received HTTP response body - public var body: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output.Ok.Body + public var body: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body /// Creates a new `Ok`. /// /// - Parameters: /// - body: Received HTTP response body - public init(body: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output.Ok.Body) { + public init(body: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body) { self.body = body } } - /// Response + /// Response - list of organization roles /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)/responses/200`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)/responses/200`. /// /// HTTP response code: `200 ok`. - case ok(Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output.Ok) + case ok(Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok) /// The associated value of the enum case if `self` is `.ok`. /// /// - Throws: An error if `self` is not `.ok`. /// - SeeAlso: `.ok`. - public var ok: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output.Ok { + public var ok: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok { get throws { switch self { case let .ok(response): @@ -14061,7 +13930,7 @@ public enum Operations { } /// Resource not found /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)/responses/404`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)/responses/404`. /// /// HTTP response code: `404 notFound`. case notFound(Components.Responses.not_found) @@ -14084,7 +13953,7 @@ public enum Operations { } /// Validation failed, or the endpoint has been spammed. /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)/responses/422`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)/responses/422`. /// /// HTTP response code: `422 unprocessableContent`. case unprocessableContent(Components.Responses.validation_failed) @@ -14136,512 +14005,48 @@ public enum Operations { } } } - /// Get all organization roles for an organization - /// - /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Remove all organization roles for a team /// - /// To use this endpoint, the authenticated user must be one of: + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// - /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. - public enum orgs_sol_list_hyphen_org_hyphen_roles { - public static let id: Swift.String = "orgs/list-org-roles" + /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/delete(orgs/revoke-all-org-roles-team)`. + public enum orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team { + public static let id: Swift.String = "orgs/revoke-all-org-roles-team" public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/path`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/teams/{team_slug}/DELETE/path`. public struct Path: Sendable, Hashable { /// The organization name. The name is not case sensitive. /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/path/org`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/teams/{team_slug}/DELETE/path/org`. public var org: Components.Parameters.org + /// The slug of the team name. + /// + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/teams/{team_slug}/DELETE/path/team_slug`. + public var team_slug: Components.Parameters.team_hyphen_slug /// Creates a new `Path`. /// /// - Parameters: /// - org: The organization name. The name is not case sensitive. - public init(org: Components.Parameters.org) { + /// - team_slug: The slug of the team name. + public init( + org: Components.Parameters.org, + team_slug: Components.Parameters.team_hyphen_slug + ) { self.org = org + self.team_slug = team_slug } } - public var path: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Path - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/header`. - public struct Headers: Sendable, Hashable { - public var accept: [OpenAPIRuntime.AcceptHeaderContentType] - /// Creates a new `Headers`. - /// - /// - Parameters: - /// - accept: - public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { - self.accept = accept - } - } - public var headers: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Headers + public var path: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Input.Path /// Creates a new `Input`. /// /// - Parameters: /// - path: - /// - headers: - public init( - path: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Path, - headers: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input.Headers = .init() - ) { - self.path = path - self.headers = headers - } - } - @frozen public enum Output: Sendable, Hashable { - public struct Ok: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content`. - @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/json`. - public struct jsonPayload: Codable, Hashable, Sendable { - /// The total number of organization roles available to the organization. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/json/total_count`. - public var total_count: Swift.Int? - /// The list of organization roles available to the organization. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/json/roles`. - public var roles: [Components.Schemas.organization_hyphen_role]? - /// Creates a new `jsonPayload`. - /// - /// - Parameters: - /// - total_count: The total number of organization roles available to the organization. - /// - roles: The list of organization roles available to the organization. - public init( - total_count: Swift.Int? = nil, - roles: [Components.Schemas.organization_hyphen_role]? = nil - ) { - self.total_count = total_count - self.roles = roles - } - public enum CodingKeys: String, CodingKey { - case total_count - case roles - } - } - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/GET/responses/200/content/application\/json`. - case json(Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body.jsonPayload) - /// The associated value of the enum case if `self` is `.json`. - /// - /// - Throws: An error if `self` is not `.json`. - /// - SeeAlso: `.json`. - public var json: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body.jsonPayload { - get throws { - switch self { - case let .json(body): - return body - } - } - } - } - /// Received HTTP response body - public var body: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body - /// Creates a new `Ok`. - /// - /// - Parameters: - /// - body: Received HTTP response body - public init(body: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok.Body) { - self.body = body - } - } - /// Response - list of organization roles - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)/responses/200`. - /// - /// HTTP response code: `200 ok`. - case ok(Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok) - /// The associated value of the enum case if `self` is `.ok`. - /// - /// - Throws: An error if `self` is not `.ok`. - /// - SeeAlso: `.ok`. - public var ok: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output.Ok { - get throws { - switch self { - case let .ok(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "ok", - response: self - ) - } - } - } - /// Resource not found - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)/responses/404`. - /// - /// HTTP response code: `404 notFound`. - case notFound(Components.Responses.not_found) - /// The associated value of the enum case if `self` is `.notFound`. - /// - /// - Throws: An error if `self` is not `.notFound`. - /// - SeeAlso: `.notFound`. - public var notFound: Components.Responses.not_found { - get throws { - switch self { - case let .notFound(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "notFound", - response: self - ) - } - } - } - /// Validation failed, or the endpoint has been spammed. - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)/responses/422`. - /// - /// HTTP response code: `422 unprocessableContent`. - case unprocessableContent(Components.Responses.validation_failed) - /// The associated value of the enum case if `self` is `.unprocessableContent`. - /// - /// - Throws: An error if `self` is not `.unprocessableContent`. - /// - SeeAlso: `.unprocessableContent`. - public var unprocessableContent: Components.Responses.validation_failed { - get throws { - switch self { - case let .unprocessableContent(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "unprocessableContent", - response: self - ) - } - } - } - /// Undocumented response. - /// - /// A response with a code that is not documented in the OpenAPI document. - case undocumented(statusCode: Swift.Int, OpenAPIRuntime.UndocumentedPayload) - } - @frozen public enum AcceptableContentType: AcceptableProtocol { - case json - case other(Swift.String) - public init?(rawValue: Swift.String) { - switch rawValue.lowercased() { - case "application/json": - self = .json - default: - self = .other(rawValue) - } - } - public var rawValue: Swift.String { - switch self { - case let .other(string): - return string - case .json: - return "application/json" - } - } - public static var allCases: [Self] { - [ - .json - ] - } - } - } - /// Create a custom organization role - /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. - public enum orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role { - public static let id: Swift.String = "orgs/create-custom-organization-role" - public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/path`. - public struct Path: Sendable, Hashable { - /// The organization name. The name is not case sensitive. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/path/org`. - public var org: Components.Parameters.org - /// Creates a new `Path`. - /// - /// - Parameters: - /// - org: The organization name. The name is not case sensitive. - public init(org: Components.Parameters.org) { - self.org = org - } - } - public var path: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Path - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/header`. - public struct Headers: Sendable, Hashable { - public var accept: [OpenAPIRuntime.AcceptHeaderContentType] - /// Creates a new `Headers`. - /// - /// - Parameters: - /// - accept: - public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { - self.accept = accept - } - } - public var headers: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Headers - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/requestBody`. - @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/requestBody/json`. - public struct jsonPayload: Codable, Hashable, Sendable { - /// The name of the custom role. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/requestBody/json/name`. - public var name: Swift.String - /// A short description about the intended usage of this role or what permissions it grants. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/requestBody/json/description`. - public var description: Swift.String? - /// A list of additional permissions included in this role. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/requestBody/json/permissions`. - public var permissions: [Swift.String] - /// Creates a new `jsonPayload`. - /// - /// - Parameters: - /// - name: The name of the custom role. - /// - description: A short description about the intended usage of this role or what permissions it grants. - /// - permissions: A list of additional permissions included in this role. - public init( - name: Swift.String, - description: Swift.String? = nil, - permissions: [Swift.String] - ) { - self.name = name - self.description = description - self.permissions = permissions - } - public enum CodingKeys: String, CodingKey { - case name - case description - case permissions - } - } - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/requestBody/content/application\/json`. - case json(Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Body.jsonPayload) - } - public var body: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Body - /// Creates a new `Input`. - /// - /// - Parameters: - /// - path: - /// - headers: - /// - body: - public init( - path: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Path, - headers: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Headers = .init(), - body: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input.Body - ) { - self.path = path - self.headers = headers - self.body = body - } - } - @frozen public enum Output: Sendable, Hashable { - public struct Created: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/responses/201/content`. - @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/POST/responses/201/content/application\/json`. - case json(Components.Schemas.organization_hyphen_role) - /// The associated value of the enum case if `self` is `.json`. - /// - /// - Throws: An error if `self` is not `.json`. - /// - SeeAlso: `.json`. - public var json: Components.Schemas.organization_hyphen_role { - get throws { - switch self { - case let .json(body): - return body - } - } - } - } - /// Received HTTP response body - public var body: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output.Created.Body - /// Creates a new `Created`. - /// - /// - Parameters: - /// - body: Received HTTP response body - public init(body: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output.Created.Body) { - self.body = body - } - } - /// Response - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)/responses/201`. - /// - /// HTTP response code: `201 created`. - case created(Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output.Created) - /// The associated value of the enum case if `self` is `.created`. - /// - /// - Throws: An error if `self` is not `.created`. - /// - SeeAlso: `.created`. - public var created: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output.Created { - get throws { - switch self { - case let .created(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "created", - response: self - ) - } - } - } - /// Validation failed, or the endpoint has been spammed. - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)/responses/422`. - /// - /// HTTP response code: `422 unprocessableContent`. - case unprocessableContent(Components.Responses.validation_failed) - /// The associated value of the enum case if `self` is `.unprocessableContent`. - /// - /// - Throws: An error if `self` is not `.unprocessableContent`. - /// - SeeAlso: `.unprocessableContent`. - public var unprocessableContent: Components.Responses.validation_failed { - get throws { - switch self { - case let .unprocessableContent(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "unprocessableContent", - response: self - ) - } - } - } - /// Resource not found - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)/responses/404`. - /// - /// HTTP response code: `404 notFound`. - case notFound(Components.Responses.not_found) - /// The associated value of the enum case if `self` is `.notFound`. - /// - /// - Throws: An error if `self` is not `.notFound`. - /// - SeeAlso: `.notFound`. - public var notFound: Components.Responses.not_found { - get throws { - switch self { - case let .notFound(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "notFound", - response: self - ) - } - } - } - /// Conflict - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)/responses/409`. - /// - /// HTTP response code: `409 conflict`. - case conflict(Components.Responses.conflict) - /// The associated value of the enum case if `self` is `.conflict`. - /// - /// - Throws: An error if `self` is not `.conflict`. - /// - SeeAlso: `.conflict`. - public var conflict: Components.Responses.conflict { - get throws { - switch self { - case let .conflict(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "conflict", - response: self - ) - } - } - } - /// Undocumented response. - /// - /// A response with a code that is not documented in the OpenAPI document. - case undocumented(statusCode: Swift.Int, OpenAPIRuntime.UndocumentedPayload) - } - @frozen public enum AcceptableContentType: AcceptableProtocol { - case json - case other(Swift.String) - public init?(rawValue: Swift.String) { - switch rawValue.lowercased() { - case "application/json": - self = .json - default: - self = .other(rawValue) - } - } - public var rawValue: Swift.String { - switch self { - case let .other(string): - return string - case .json: - return "application/json" - } - } - public static var allCases: [Self] { - [ - .json - ] - } - } - } - /// Remove all organization roles for a team - /// - /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// The authenticated user must be an administrator for the organization to use this endpoint. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/delete(orgs/revoke-all-org-roles-team)`. - public enum orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team { - public static let id: Swift.String = "orgs/revoke-all-org-roles-team" - public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/teams/{team_slug}/DELETE/path`. - public struct Path: Sendable, Hashable { - /// The organization name. The name is not case sensitive. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/teams/{team_slug}/DELETE/path/org`. - public var org: Components.Parameters.org - /// The slug of the team name. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/teams/{team_slug}/DELETE/path/team_slug`. - public var team_slug: Components.Parameters.team_hyphen_slug - /// Creates a new `Path`. - /// - /// - Parameters: - /// - org: The organization name. The name is not case sensitive. - /// - team_slug: The slug of the team name. - public init( - org: Components.Parameters.org, - team_slug: Components.Parameters.team_hyphen_slug - ) { - self.org = org - self.team_slug = team_slug - } - } - public var path: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Input.Path - /// Creates a new `Input`. - /// - /// - Parameters: - /// - path: - public init(path: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Input.Path) { + public init(path: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Input.Path) { self.path = path } } @@ -14681,7 +14086,7 @@ public enum Operations { } /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -14821,7 +14226,7 @@ public enum Operations { } /// Remove an organization role from a team /// - /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Removes an organization role from a team. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -14907,7 +14312,7 @@ public enum Operations { } /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -14986,7 +14391,7 @@ public enum Operations { } /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -15126,7 +14531,7 @@ public enum Operations { } /// Remove an organization role from a user /// - /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Remove an organization role from a user. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// The authenticated user must be an administrator for the organization to use this endpoint. /// @@ -15164,210 +14569,41 @@ public enum Operations { ) { self.org = org self.username = username - self.role_id = role_id - } - } - public var path: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Input.Path - /// Creates a new `Input`. - /// - /// - Parameters: - /// - path: - public init(path: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Input.Path) { - self.path = path - } - } - @frozen public enum Output: Sendable, Hashable { - public struct NoContent: Sendable, Hashable { - /// Creates a new `NoContent`. - public init() {} - } - /// Response - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/delete(orgs/revoke-org-role-user)/responses/204`. - /// - /// HTTP response code: `204 noContent`. - case noContent(Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Output.NoContent) - /// The associated value of the enum case if `self` is `.noContent`. - /// - /// - Throws: An error if `self` is not `.noContent`. - /// - SeeAlso: `.noContent`. - public var noContent: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Output.NoContent { - get throws { - switch self { - case let .noContent(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "noContent", - response: self - ) - } - } - } - /// Undocumented response. - /// - /// A response with a code that is not documented in the OpenAPI document. - case undocumented(statusCode: Swift.Int, OpenAPIRuntime.UndocumentedPayload) - } - } - /// Get an organization role - /// - /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. - public enum orgs_sol_get_hyphen_org_hyphen_role { - public static let id: Swift.String = "orgs/get-org-role" - public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/path`. - public struct Path: Sendable, Hashable { - /// The organization name. The name is not case sensitive. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/path/org`. - public var org: Components.Parameters.org - /// The unique identifier of the role. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/path/role_id`. - public var role_id: Components.Parameters.role_hyphen_id - /// Creates a new `Path`. - /// - /// - Parameters: - /// - org: The organization name. The name is not case sensitive. - /// - role_id: The unique identifier of the role. - public init( - org: Components.Parameters.org, - role_id: Components.Parameters.role_hyphen_id - ) { - self.org = org - self.role_id = role_id - } - } - public var path: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Path - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/header`. - public struct Headers: Sendable, Hashable { - public var accept: [OpenAPIRuntime.AcceptHeaderContentType] - /// Creates a new `Headers`. - /// - /// - Parameters: - /// - accept: - public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { - self.accept = accept - } - } - public var headers: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Headers - /// Creates a new `Input`. - /// - /// - Parameters: - /// - path: - /// - headers: - public init( - path: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Path, - headers: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Headers = .init() - ) { - self.path = path - self.headers = headers - } - } - @frozen public enum Output: Sendable, Hashable { - public struct Ok: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/responses/200/content`. - @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/responses/200/content/application\/json`. - case json(Components.Schemas.organization_hyphen_role) - /// The associated value of the enum case if `self` is `.json`. - /// - /// - Throws: An error if `self` is not `.json`. - /// - SeeAlso: `.json`. - public var json: Components.Schemas.organization_hyphen_role { - get throws { - switch self { - case let .json(body): - return body - } - } - } - } - /// Received HTTP response body - public var body: Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok.Body - /// Creates a new `Ok`. - /// - /// - Parameters: - /// - body: Received HTTP response body - public init(body: Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok.Body) { - self.body = body - } - } - /// Response - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)/responses/200`. - /// - /// HTTP response code: `200 ok`. - case ok(Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok) - /// The associated value of the enum case if `self` is `.ok`. - /// - /// - Throws: An error if `self` is not `.ok`. - /// - SeeAlso: `.ok`. - public var ok: Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok { - get throws { - switch self { - case let .ok(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "ok", - response: self - ) - } + self.role_id = role_id } } - /// Resource not found - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)/responses/404`. - /// - /// HTTP response code: `404 notFound`. - case notFound(Components.Responses.not_found) - /// The associated value of the enum case if `self` is `.notFound`. + public var path: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Input.Path + /// Creates a new `Input`. /// - /// - Throws: An error if `self` is not `.notFound`. - /// - SeeAlso: `.notFound`. - public var notFound: Components.Responses.not_found { - get throws { - switch self { - case let .notFound(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "notFound", - response: self - ) - } - } + /// - Parameters: + /// - path: + public init(path: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Input.Path) { + self.path = path } - /// Validation failed, or the endpoint has been spammed. + } + @frozen public enum Output: Sendable, Hashable { + public struct NoContent: Sendable, Hashable { + /// Creates a new `NoContent`. + public init() {} + } + /// Response /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)/responses/422`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/delete(orgs/revoke-org-role-user)/responses/204`. /// - /// HTTP response code: `422 unprocessableContent`. - case unprocessableContent(Components.Responses.validation_failed) - /// The associated value of the enum case if `self` is `.unprocessableContent`. + /// HTTP response code: `204 noContent`. + case noContent(Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Output.NoContent) + /// The associated value of the enum case if `self` is `.noContent`. /// - /// - Throws: An error if `self` is not `.unprocessableContent`. - /// - SeeAlso: `.unprocessableContent`. - public var unprocessableContent: Components.Responses.validation_failed { + /// - Throws: An error if `self` is not `.noContent`. + /// - SeeAlso: `.noContent`. + public var noContent: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Output.NoContent { get throws { switch self { - case let .unprocessableContent(response): + case let .noContent(response): return response default: try throwUnexpectedResponseStatus( - expectedStatus: "unprocessableContent", + expectedStatus: "noContent", response: self ) } @@ -15378,58 +14614,32 @@ public enum Operations { /// A response with a code that is not documented in the OpenAPI document. case undocumented(statusCode: Swift.Int, OpenAPIRuntime.UndocumentedPayload) } - @frozen public enum AcceptableContentType: AcceptableProtocol { - case json - case other(Swift.String) - public init?(rawValue: Swift.String) { - switch rawValue.lowercased() { - case "application/json": - self = .json - default: - self = .other(rawValue) - } - } - public var rawValue: Swift.String { - switch self { - case let .other(string): - return string - case .json: - return "application/json" - } - } - public static var allCases: [Self] { - [ - .json - ] - } - } } - /// Update a custom organization role - /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Get an organization role /// + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. + /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// - /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. - public enum orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role { - public static let id: Swift.String = "orgs/patch-custom-organization-role" + /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. + public enum orgs_sol_get_hyphen_org_hyphen_role { + public static let id: Swift.String = "orgs/get-org-role" public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/path`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/path`. public struct Path: Sendable, Hashable { /// The organization name. The name is not case sensitive. /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/path/org`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/path/org`. public var org: Components.Parameters.org /// The unique identifier of the role. /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/path/role_id`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/path/role_id`. public var role_id: Components.Parameters.role_hyphen_id /// Creates a new `Path`. /// @@ -15444,81 +14654,37 @@ public enum Operations { self.role_id = role_id } } - public var path: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Path - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/header`. + public var path: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Path + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/header`. public struct Headers: Sendable, Hashable { - public var accept: [OpenAPIRuntime.AcceptHeaderContentType] + public var accept: [OpenAPIRuntime.AcceptHeaderContentType] /// Creates a new `Headers`. /// /// - Parameters: /// - accept: - public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { + public init(accept: [OpenAPIRuntime.AcceptHeaderContentType] = .defaultValues()) { self.accept = accept } } - public var headers: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Headers - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/requestBody`. - @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/requestBody/json`. - public struct jsonPayload: Codable, Hashable, Sendable { - /// The name of the custom role. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/requestBody/json/name`. - public var name: Swift.String? - /// A short description about the intended usage of this role or what permissions it grants. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/requestBody/json/description`. - public var description: Swift.String? - /// A list of additional permissions included in this role. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/requestBody/json/permissions`. - public var permissions: [Swift.String]? - /// Creates a new `jsonPayload`. - /// - /// - Parameters: - /// - name: The name of the custom role. - /// - description: A short description about the intended usage of this role or what permissions it grants. - /// - permissions: A list of additional permissions included in this role. - public init( - name: Swift.String? = nil, - description: Swift.String? = nil, - permissions: [Swift.String]? = nil - ) { - self.name = name - self.description = description - self.permissions = permissions - } - public enum CodingKeys: String, CodingKey { - case name - case description - case permissions - } - } - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/requestBody/content/application\/json`. - case json(Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Body.jsonPayload) - } - public var body: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Body + public var headers: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Headers /// Creates a new `Input`. /// /// - Parameters: /// - path: /// - headers: - /// - body: public init( - path: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Path, - headers: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Headers = .init(), - body: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input.Body + path: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Path, + headers: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input.Headers = .init() ) { self.path = path self.headers = headers - self.body = body } } @frozen public enum Output: Sendable, Hashable { public struct Ok: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/responses/200/content`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/responses/200/content`. @frozen public enum Body: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/PATCH/responses/200/content/application\/json`. + /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/GET/responses/200/content/application\/json`. case json(Components.Schemas.organization_hyphen_role) /// The associated value of the enum case if `self` is `.json`. /// @@ -15534,26 +14700,26 @@ public enum Operations { } } /// Received HTTP response body - public var body: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output.Ok.Body + public var body: Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok.Body /// Creates a new `Ok`. /// /// - Parameters: /// - body: Received HTTP response body - public init(body: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output.Ok.Body) { + public init(body: Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok.Body) { self.body = body } } /// Response /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)/responses/200`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)/responses/200`. /// /// HTTP response code: `200 ok`. - case ok(Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output.Ok) + case ok(Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok) /// The associated value of the enum case if `self` is `.ok`. /// /// - Throws: An error if `self` is not `.ok`. /// - SeeAlso: `.ok`. - public var ok: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output.Ok { + public var ok: Operations.orgs_sol_get_hyphen_org_hyphen_role.Output.Ok { get throws { switch self { case let .ok(response): @@ -15566,70 +14732,47 @@ public enum Operations { } } } - /// Validation failed, or the endpoint has been spammed. - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)/responses/422`. - /// - /// HTTP response code: `422 unprocessableContent`. - case unprocessableContent(Components.Responses.validation_failed) - /// The associated value of the enum case if `self` is `.unprocessableContent`. - /// - /// - Throws: An error if `self` is not `.unprocessableContent`. - /// - SeeAlso: `.unprocessableContent`. - public var unprocessableContent: Components.Responses.validation_failed { - get throws { - switch self { - case let .unprocessableContent(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "unprocessableContent", - response: self - ) - } - } - } - /// Conflict + /// Resource not found /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)/responses/409`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)/responses/404`. /// - /// HTTP response code: `409 conflict`. - case conflict(Components.Responses.conflict) - /// The associated value of the enum case if `self` is `.conflict`. + /// HTTP response code: `404 notFound`. + case notFound(Components.Responses.not_found) + /// The associated value of the enum case if `self` is `.notFound`. /// - /// - Throws: An error if `self` is not `.conflict`. - /// - SeeAlso: `.conflict`. - public var conflict: Components.Responses.conflict { + /// - Throws: An error if `self` is not `.notFound`. + /// - SeeAlso: `.notFound`. + public var notFound: Components.Responses.not_found { get throws { switch self { - case let .conflict(response): + case let .notFound(response): return response default: try throwUnexpectedResponseStatus( - expectedStatus: "conflict", + expectedStatus: "notFound", response: self ) } } } - /// Resource not found + /// Validation failed, or the endpoint has been spammed. /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)/responses/404`. + /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)/responses/422`. /// - /// HTTP response code: `404 notFound`. - case notFound(Components.Responses.not_found) - /// The associated value of the enum case if `self` is `.notFound`. + /// HTTP response code: `422 unprocessableContent`. + case unprocessableContent(Components.Responses.validation_failed) + /// The associated value of the enum case if `self` is `.unprocessableContent`. /// - /// - Throws: An error if `self` is not `.notFound`. - /// - SeeAlso: `.notFound`. - public var notFound: Components.Responses.not_found { + /// - Throws: An error if `self` is not `.unprocessableContent`. + /// - SeeAlso: `.unprocessableContent`. + public var unprocessableContent: Components.Responses.validation_failed { get throws { switch self { - case let .notFound(response): + case let .unprocessableContent(response): return response default: try throwUnexpectedResponseStatus( - expectedStatus: "notFound", + expectedStatus: "unprocessableContent", response: self ) } @@ -15666,91 +14809,9 @@ public enum Operations { } } } - /// Delete a custom organization role. - /// - /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - /// - /// To use this endpoint, the authenticated user must be one of: - /// - /// - An administrator for the organization. - /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. - /// - /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. - public enum orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role { - public static let id: Swift.String = "orgs/delete-custom-organization-role" - public struct Input: Sendable, Hashable { - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/DELETE/path`. - public struct Path: Sendable, Hashable { - /// The organization name. The name is not case sensitive. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/DELETE/path/org`. - public var org: Components.Parameters.org - /// The unique identifier of the role. - /// - /// - Remark: Generated from `#/paths/orgs/{org}/organization-roles/{role_id}/DELETE/path/role_id`. - public var role_id: Components.Parameters.role_hyphen_id - /// Creates a new `Path`. - /// - /// - Parameters: - /// - org: The organization name. The name is not case sensitive. - /// - role_id: The unique identifier of the role. - public init( - org: Components.Parameters.org, - role_id: Components.Parameters.role_hyphen_id - ) { - self.org = org - self.role_id = role_id - } - } - public var path: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input.Path - /// Creates a new `Input`. - /// - /// - Parameters: - /// - path: - public init(path: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input.Path) { - self.path = path - } - } - @frozen public enum Output: Sendable, Hashable { - public struct NoContent: Sendable, Hashable { - /// Creates a new `NoContent`. - public init() {} - } - /// Response - /// - /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)/responses/204`. - /// - /// HTTP response code: `204 noContent`. - case noContent(Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Output.NoContent) - /// The associated value of the enum case if `self` is `.noContent`. - /// - /// - Throws: An error if `self` is not `.noContent`. - /// - SeeAlso: `.noContent`. - public var noContent: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Output.NoContent { - get throws { - switch self { - case let .noContent(response): - return response - default: - try throwUnexpectedResponseStatus( - expectedStatus: "noContent", - response: self - ) - } - } - } - /// Undocumented response. - /// - /// A response with a code that is not documented in the OpenAPI document. - case undocumented(statusCode: Swift.Int, OpenAPIRuntime.UndocumentedPayload) - } - } /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -15995,7 +15056,7 @@ public enum Operations { } /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Using organization roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/using-organization-roles)." /// /// To use this endpoint, you must be an administrator for the organization. /// @@ -21308,6 +20369,9 @@ public enum Operations { } /// Enable or disable a security feature for an organization /// + /// > [!WARNING] + /// > **Deprecation notice:** The ability to enable or disable a security feature for all eligible repositories in an organization is deprecated. Please use [code security configurations](https://docs.github.com/rest/code-security/configurations) instead. For more information, see the [changelog](https://github.blog/changelog/2024-07-22-deprecation-api-endpoint-to-enable-or-disable-a-security-feature-for-an-organization/). + /// /// Enables or disables the specified security feature for all eligible repositories in an organization. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. diff --git a/Sources/pulls/Client.swift b/Sources/pulls/Client.swift index 421e5b6991e..0d806b85bb7 100644 --- a/Sources/pulls/Client.swift +++ b/Sources/pulls/Client.swift @@ -1478,8 +1478,8 @@ public struct Client: APIProtocol { /// /// Lists the files in a specified pull request. /// - /// **Note:** Responses include a maximum of 3000 files. The paginated response - /// returns 30 files per page by default. + /// > [!NOTE] + /// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. /// /// 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)." /// @@ -2246,7 +2246,8 @@ public struct Client: APIProtocol { /// /// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." /// - /// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + /// > [!NOTE] + /// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. /// /// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. /// @@ -2815,9 +2816,8 @@ public struct Client: APIProtocol { /// /// Dismisses a specified review on a pull request. /// - /// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - /// you must be a repository administrator or be included in the list of people or teams - /// who can dismiss pull request reviews. + /// > [!NOTE] + /// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. /// /// 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)." /// diff --git a/Sources/pulls/Types.swift b/Sources/pulls/Types.swift index 719cf194fee..666917176c8 100644 --- a/Sources/pulls/Types.swift +++ b/Sources/pulls/Types.swift @@ -217,8 +217,8 @@ public protocol APIProtocol: Sendable { /// /// Lists the files in a specified pull request. /// - /// **Note:** Responses include a maximum of 3000 files. The paginated response - /// returns 30 files per page by default. + /// > [!NOTE] + /// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. /// /// 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)." /// @@ -289,7 +289,8 @@ public protocol APIProtocol: Sendable { /// /// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." /// - /// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + /// > [!NOTE] + /// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. /// /// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. /// @@ -363,9 +364,8 @@ public protocol APIProtocol: Sendable { /// /// Dismisses a specified review on a pull request. /// - /// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - /// you must be a repository administrator or be included in the list of people or teams - /// who can dismiss pull request reviews. + /// > [!NOTE] + /// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. /// /// 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)." /// @@ -722,8 +722,8 @@ extension APIProtocol { /// /// Lists the files in a specified pull request. /// - /// **Note:** Responses include a maximum of 3000 files. The paginated response - /// returns 30 files per page by default. + /// > [!NOTE] + /// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. /// /// 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)." /// @@ -854,7 +854,8 @@ extension APIProtocol { /// /// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." /// - /// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + /// > [!NOTE] + /// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. /// /// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. /// @@ -974,9 +975,8 @@ extension APIProtocol { /// /// Dismisses a specified review on a pull request. /// - /// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - /// you must be a repository administrator or be included in the list of people or teams - /// who can dismiss pull request reviews. + /// > [!NOTE] + /// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. /// /// 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)." /// @@ -9938,8 +9938,8 @@ public enum Operations { /// /// Lists the files in a specified pull request. /// - /// **Note:** Responses include a maximum of 3000 files. The paginated response - /// returns 30 files per page by default. + /// > [!NOTE] + /// > Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. /// /// 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)." /// @@ -11588,7 +11588,8 @@ public enum Operations { /// /// Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." /// - /// **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + /// > [!NOTE] + /// > To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. /// /// The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. /// @@ -12751,9 +12752,8 @@ public enum Operations { /// /// Dismisses a specified review on a pull request. /// - /// **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - /// you must be a repository administrator or be included in the list of people or teams - /// who can dismiss pull request reviews. + /// > [!NOTE] + /// > To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. /// /// 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)." /// diff --git a/Sources/rate-limit/Client.swift b/Sources/rate-limit/Client.swift index 343a675a408..5cfda7888c1 100644 --- a/Sources/rate-limit/Client.swift +++ b/Sources/rate-limit/Client.swift @@ -40,7 +40,8 @@ public struct Client: APIProtocol { } /// Get rate limit status for the authenticated user /// - /// **Note:** Accessing this endpoint does not count against your REST API rate limit. + /// > [!NOTE] + /// > Accessing this endpoint does not count against your REST API rate limit. /// /// 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: /// * 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 { /// * 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)." /// * 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)." /// - /// **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. + /// > [!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. /// /// - Remark: HTTP `GET /rate_limit`. /// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`. diff --git a/Sources/rate-limit/Types.swift b/Sources/rate-limit/Types.swift index cedd3ad37c7..dc38c7028d0 100644 --- a/Sources/rate-limit/Types.swift +++ b/Sources/rate-limit/Types.swift @@ -13,7 +13,8 @@ import struct Foundation.Date public protocol APIProtocol: Sendable { /// Get rate limit status for the authenticated user /// - /// **Note:** Accessing this endpoint does not count against your REST API rate limit. + /// > [!NOTE] + /// > Accessing this endpoint does not count against your REST API rate limit. /// /// 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: /// * 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 { /// * 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)." /// * 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)." /// - /// **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. + /// > [!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. /// /// - Remark: HTTP `GET /rate_limit`. /// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`. @@ -37,7 +39,8 @@ public protocol APIProtocol: Sendable { extension APIProtocol { /// Get rate limit status for the authenticated user /// - /// **Note:** Accessing this endpoint does not count against your REST API rate limit. + /// > [!NOTE] + /// > Accessing this endpoint does not count against your REST API rate limit. /// /// 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: /// * The `core` object provides your rate limit status for all non-search-related resources in the REST API. @@ -50,7 +53,8 @@ extension APIProtocol { /// * 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)." /// * 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)." /// - /// **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. + /// > [!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. /// /// - Remark: HTTP `GET /rate_limit`. /// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`. @@ -296,7 +300,8 @@ public enum Components { public enum Operations { /// Get rate limit status for the authenticated user /// - /// **Note:** Accessing this endpoint does not count against your REST API rate limit. + /// > [!NOTE] + /// > Accessing this endpoint does not count against your REST API rate limit. /// /// 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: /// * 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 { /// * 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)." /// * 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)." /// - /// **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. + /// > [!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. /// /// - Remark: HTTP `GET /rate_limit`. /// - Remark: Generated from `#/paths//rate_limit/get(rate-limit/get)`. diff --git a/Sources/reactions/Client.swift b/Sources/reactions/Client.swift index b8abadb7cb1..21656304d0d 100644 --- a/Sources/reactions/Client.swift +++ b/Sources/reactions/Client.swift @@ -42,7 +42,8 @@ public struct Client: APIProtocol { /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -144,7 +145,8 @@ public struct Client: APIProtocol { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -244,7 +246,8 @@ public struct Client: APIProtocol { } /// Delete team discussion comment reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -294,7 +297,8 @@ public struct Client: APIProtocol { /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -395,7 +399,8 @@ public struct Client: APIProtocol { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -494,7 +499,8 @@ public struct Client: APIProtocol { } /// Delete team discussion reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -777,7 +783,8 @@ public struct Client: APIProtocol { } /// Delete a commit comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). /// @@ -1058,7 +1065,8 @@ public struct Client: APIProtocol { } /// Delete an issue comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). /// @@ -1361,7 +1369,8 @@ public struct Client: APIProtocol { } /// Delete an issue reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. /// /// Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). /// @@ -1642,7 +1651,8 @@ public struct Client: APIProtocol { } /// Delete a pull request comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` /// /// Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). /// @@ -1923,7 +1933,8 @@ public struct Client: APIProtocol { } /// Delete a release reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. /// /// Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). /// @@ -1968,7 +1979,8 @@ public struct Client: APIProtocol { } /// List reactions for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -2068,7 +2080,8 @@ public struct Client: APIProtocol { } /// Create reaction for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -2150,7 +2163,8 @@ public struct Client: APIProtocol { } /// List reactions for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -2249,7 +2263,8 @@ public struct Client: APIProtocol { } /// Create reaction for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// diff --git a/Sources/reactions/Types.swift b/Sources/reactions/Types.swift index 442c25ef1e7..e4eb68d7d2a 100644 --- a/Sources/reactions/Types.swift +++ b/Sources/reactions/Types.swift @@ -15,7 +15,8 @@ public protocol APIProtocol: Sendable { /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -28,7 +29,8 @@ public protocol APIProtocol: Sendable { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -37,7 +39,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output /// Delete team discussion comment reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -50,7 +53,8 @@ public protocol APIProtocol: Sendable { /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -63,7 +67,8 @@ public protocol APIProtocol: Sendable { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -72,7 +77,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Output /// Delete team discussion reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -97,7 +103,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_commit_hyphen_comment(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_commit_hyphen_comment.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_commit_hyphen_comment.Output /// Delete a commit comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). /// @@ -120,7 +127,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_issue_hyphen_comment(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_issue_hyphen_comment.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_issue_hyphen_comment.Output /// Delete an issue comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). /// @@ -143,7 +151,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_issue(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_issue.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_issue.Output /// Delete an issue reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. /// /// Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). /// @@ -166,7 +175,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_pull_hyphen_request_hyphen_review_hyphen_comment(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_pull_hyphen_request_hyphen_review_hyphen_comment.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_pull_hyphen_request_hyphen_review_hyphen_comment.Output /// Delete a pull request comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` /// /// Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). /// @@ -189,7 +199,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_release(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_release.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_release.Output /// Delete a release reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. /// /// Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). /// @@ -198,7 +209,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_delete_hyphen_for_hyphen_release(_ input: Operations.reactions_sol_delete_hyphen_for_hyphen_release.Input) async throws -> Operations.reactions_sol_delete_hyphen_for_hyphen_release.Output /// List reactions for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -210,7 +222,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_legacy(_ input: Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_legacy.Input) async throws -> Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_legacy.Output /// Create reaction for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -224,7 +237,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_legacy(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_legacy.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_legacy.Output /// List reactions for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -236,7 +250,8 @@ public protocol APIProtocol: Sendable { func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_legacy(_ input: Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_legacy.Input) async throws -> Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_legacy.Output /// Create reaction for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -256,7 +271,8 @@ extension APIProtocol { /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -279,7 +295,8 @@ extension APIProtocol { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -298,7 +315,8 @@ extension APIProtocol { } /// Delete team discussion comment reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -313,7 +331,8 @@ extension APIProtocol { /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -336,7 +355,8 @@ extension APIProtocol { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -355,7 +375,8 @@ extension APIProtocol { } /// Delete team discussion reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -402,7 +423,8 @@ extension APIProtocol { } /// Delete a commit comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). /// @@ -447,7 +469,8 @@ extension APIProtocol { } /// Delete an issue comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). /// @@ -492,7 +515,8 @@ extension APIProtocol { } /// Delete an issue reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. /// /// Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). /// @@ -537,7 +561,8 @@ extension APIProtocol { } /// Delete a pull request comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` /// /// Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). /// @@ -582,7 +607,8 @@ extension APIProtocol { } /// Delete a release reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. /// /// Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). /// @@ -593,7 +619,8 @@ extension APIProtocol { } /// List reactions for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -615,7 +642,8 @@ extension APIProtocol { } /// Create reaction for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -639,7 +667,8 @@ extension APIProtocol { } /// List reactions for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -661,7 +690,8 @@ extension APIProtocol { } /// Create reaction for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -1216,7 +1246,8 @@ public enum Operations { /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -1441,7 +1472,8 @@ public enum Operations { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -1688,7 +1720,8 @@ public enum Operations { } /// Delete team discussion comment reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -1790,7 +1823,8 @@ public enum Operations { /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -2008,7 +2042,8 @@ public enum Operations { /// /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -2248,7 +2283,8 @@ public enum Operations { } /// Delete team discussion reaction /// - /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -2837,7 +2873,8 @@ public enum Operations { } /// Delete a commit comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to a [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment). /// @@ -3424,7 +3461,8 @@ public enum Operations { } /// Delete an issue comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/issues/comments/:comment_id/reactions/:reaction_id`. /// /// Delete a reaction to an [issue comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment). /// @@ -4034,7 +4072,8 @@ public enum Operations { } /// Delete an issue reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/issues/:issue_number/reactions/:reaction_id`. /// /// Delete a reaction to an [issue](https://docs.github.com/rest/issues/issues#get-an-issue). /// @@ -4621,7 +4660,8 @@ public enum Operations { } /// Delete a pull request comment reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE /repositories/:repository_id/pulls/comments/:comment_id/reactions/:reaction_id.` /// /// Delete a reaction to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). /// @@ -5204,7 +5244,8 @@ public enum Operations { } /// Delete a release reaction /// - /// **Note:** You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. + /// > [!NOTE] + /// > You can also specify a repository by `repository_id` using the route `DELETE delete /repositories/:repository_id/releases/:release_id/reactions/:reaction_id`. /// /// Delete a reaction to a [release](https://docs.github.com/rest/releases/releases#get-a-release). /// @@ -5295,7 +5336,8 @@ public enum Operations { } /// List reactions for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -5511,7 +5553,8 @@ public enum Operations { } /// Create reaction for a team discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// @@ -5704,7 +5747,8 @@ public enum Operations { } /// List reactions for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// @@ -5913,7 +5957,8 @@ public enum Operations { } /// Create reaction for a team discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// diff --git a/Sources/repos/Client.swift b/Sources/repos/Client.swift index bb0b59efa4e..f1f53cd307f 100644 --- a/Sources/repos/Client.swift +++ b/Sources/repos/Client.swift @@ -42,7 +42,8 @@ public struct Client: APIProtocol { /// /// Lists repositories for the specified organization. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/get(repos/list-for-org)`. @@ -536,6 +537,13 @@ public struct Client: APIProtocol { method: .get ) suppressMutabilityWarning(&request) + try converter.setQueryItemAsURI( + in: &request, + style: .form, + explode: true, + name: "ref", + value: input.query.ref + ) try converter.setQueryItemAsURI( in: &request, style: .form, @@ -1096,7 +1104,8 @@ public struct Client: APIProtocol { /// /// The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/get(repos/get)`. @@ -2672,9 +2681,11 @@ public struct Client: APIProtocol { /// /// Protecting a branch requires admin or owner permissions to the repository. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// - /// **Note**: The list of users, apps, and teams in total is limited to 100 items. + /// > [!NOTE] + /// > The list of users, apps, and teams in total is limited to 100 items. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/put(repos/update-branch-protection)`. @@ -3157,7 +3168,8 @@ public struct Client: APIProtocol { /// /// Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews/patch(repos/update-pull-request-review-protection)`. @@ -3328,7 +3340,8 @@ public struct Client: APIProtocol { /// /// When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. /// - /// **Note**: You must enable branch protection to require signed commits. + /// > [!NOTE] + /// > You must enable branch protection to require signed commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_signatures/get(repos/get-commit-signature-protection)`. @@ -4306,7 +4319,8 @@ public struct Client: APIProtocol { /// /// Lists who has access to this protected branch. /// - /// **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + /// > [!NOTE] + /// > Users, apps, and teams `restrictions` are only available for organization-owned repositories. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/get(repos/get-access-restrictions)`. @@ -5631,7 +5645,8 @@ public struct Client: APIProtocol { /// /// Renames a branch in a repository. /// - /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + /// > [!NOTE] + /// > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// @@ -6193,7 +6208,8 @@ public struct Client: APIProtocol { /// - If the user had their own fork of the repository, the fork will be deleted. /// - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. /// - /// **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + /// > [!NOTE] + /// > A user can still have access to the repository through organization permissions like base repository permissions. /// /// Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. /// @@ -7452,7 +7468,8 @@ public struct Client: APIProtocol { /// /// Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. /// - /// **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + /// > [!NOTE] + /// > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. /// /// 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)." Pagination query parameters are not supported for these media types. /// @@ -8324,7 +8341,8 @@ public struct Client: APIProtocol { /// /// Creates a new file or replaces an existing file in a repository. /// - /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. /// @@ -8497,7 +8515,8 @@ public struct Client: APIProtocol { /// /// You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. /// - /// **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/delete(repos/delete-file)`. @@ -9764,7 +9783,8 @@ public struct Client: APIProtocol { } /// Get an environment /// - /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + /// > [!NOTE] + /// > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// /// Anyone with read access to the repository can use this endpoint. /// @@ -9836,9 +9856,11 @@ public struct Client: APIProtocol { /// /// Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." /// - /// **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + /// > [!NOTE] + /// > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." /// - /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + /// > [!NOTE] + /// > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// @@ -10491,7 +10513,9 @@ public struct Client: APIProtocol { } /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. + /// + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// @@ -10822,9 +10846,11 @@ public struct Client: APIProtocol { /// /// Create a fork for the authenticated user. /// - /// **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + /// > [!NOTE] + /// > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). /// - /// **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + /// > [!NOTE] + /// > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/forks/post(repos/create-fork)`. @@ -12129,7 +12155,8 @@ public struct Client: APIProtocol { /// /// This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. /// - /// **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + /// > [!NOTE] + /// > Previously `/repos/:owner/:repo/hooks/:hook_id/test` /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/hooks/{hook_id}/tests`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/tests/post(repos/test-push-webhook)`. @@ -15596,9 +15623,8 @@ public struct Client: APIProtocol { /// /// Gets a public release with the specified release ID. /// - /// **Note:** This returns an `upload_url` key corresponding to the endpoint - /// for uploading release assets. This key is a hypermedia resource. For more information, see - /// "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + /// > [!NOTE] + /// > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/releases/{release_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/releases/{release_id}/get(repos/get-release)`. @@ -16928,12 +16954,10 @@ public struct Client: APIProtocol { } /// Get the weekly commit activity /// - /// /// Returns a weekly aggregate of the number of additions and deletions pushed to a repository. /// - /// **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - /// 10,000 or more commits, a 422 status code will be returned. - /// + /// > [!NOTE] + /// > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/code_frequency`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/code_frequency/get(repos/get-code-frequency-stats)`. @@ -17121,7 +17145,8 @@ public struct Client: APIProtocol { /// * `d` - Number of deletions /// * `c` - Number of commits /// - /// **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + /// > [!NOTE] + /// > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/contributors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/contributors/get(repos/get-contributors-stats)`. @@ -17546,8 +17571,8 @@ public struct Client: APIProtocol { } /// Deprecated - List tag protection states for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. /// /// This returns the tag protection states of a repository. /// @@ -17661,8 +17686,8 @@ public struct Client: APIProtocol { } /// Deprecated - Create a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. /// /// This creates a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -17784,8 +17809,8 @@ public struct Client: APIProtocol { } /// Deprecated - Delete a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. /// /// This deletes a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -17882,7 +17907,9 @@ public struct Client: APIProtocol { /// Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. - /// **Note**: For private repositories, these links are temporary and expire after five minutes. + /// + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/tarball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/tarball/{ref}/get(repos/download-tarball-archive)`. @@ -18828,7 +18855,8 @@ public struct Client: APIProtocol { /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. /// - /// **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/zipball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/zipball/{ref}/get(repos/download-zipball-archive)`. diff --git a/Sources/repos/Types.swift b/Sources/repos/Types.swift index 99a89ff539b..c4b29648c8d 100644 --- a/Sources/repos/Types.swift +++ b/Sources/repos/Types.swift @@ -15,7 +15,8 @@ public protocol APIProtocol: Sendable { /// /// Lists repositories for the specified organization. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/get(repos/list-for-org)`. @@ -84,7 +85,8 @@ public protocol APIProtocol: Sendable { /// /// The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/get(repos/get)`. @@ -222,9 +224,11 @@ public protocol APIProtocol: Sendable { /// /// Protecting a branch requires admin or owner permissions to the repository. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// - /// **Note**: The list of users, apps, and teams in total is limited to 100 items. + /// > [!NOTE] + /// > The list of users, apps, and teams in total is limited to 100 items. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/put(repos/update-branch-protection)`. @@ -274,7 +278,8 @@ public protocol APIProtocol: Sendable { /// /// Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews/patch(repos/update-pull-request-review-protection)`. @@ -292,7 +297,8 @@ public protocol APIProtocol: Sendable { /// /// When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. /// - /// **Note**: You must enable branch protection to require signed commits. + /// > [!NOTE] + /// > You must enable branch protection to require signed commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_signatures/get(repos/get-commit-signature-protection)`. @@ -372,7 +378,8 @@ public protocol APIProtocol: Sendable { /// /// Lists who has access to this protected branch. /// - /// **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + /// > [!NOTE] + /// > Users, apps, and teams `restrictions` are only available for organization-owned repositories. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/get(repos/get-access-restrictions)`. @@ -510,7 +517,8 @@ public protocol APIProtocol: Sendable { /// /// Renames a branch in a repository. /// - /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + /// > [!NOTE] + /// > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// @@ -602,7 +610,8 @@ public protocol APIProtocol: Sendable { /// - If the user had their own fork of the repository, the fork will be deleted. /// - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. /// - /// **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + /// > [!NOTE] + /// > A user can still have access to the repository through organization permissions like base repository permissions. /// /// Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. /// @@ -759,7 +768,8 @@ public protocol APIProtocol: Sendable { /// /// Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. /// - /// **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + /// > [!NOTE] + /// > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. /// /// 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)." Pagination query parameters are not supported for these media types. /// @@ -930,7 +940,8 @@ public protocol APIProtocol: Sendable { /// /// Creates a new file or replaces an existing file in a repository. /// - /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. /// @@ -947,7 +958,8 @@ public protocol APIProtocol: Sendable { /// /// You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. /// - /// **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/delete(repos/delete-file)`. @@ -1094,7 +1106,8 @@ public protocol APIProtocol: Sendable { func repos_sol_get_hyphen_all_hyphen_environments(_ input: Operations.repos_sol_get_hyphen_all_hyphen_environments.Input) async throws -> Operations.repos_sol_get_hyphen_all_hyphen_environments.Output /// Get an environment /// - /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + /// > [!NOTE] + /// > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// /// Anyone with read access to the repository can use this endpoint. /// @@ -1107,9 +1120,11 @@ public protocol APIProtocol: Sendable { /// /// Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." /// - /// **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + /// > [!NOTE] + /// > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." /// - /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + /// > [!NOTE] + /// > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// @@ -1198,7 +1213,9 @@ public protocol APIProtocol: Sendable { func repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule(_ input: Operations.repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule.Input) async throws -> Operations.repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule.Output /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. + /// + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// @@ -1242,9 +1259,11 @@ public protocol APIProtocol: Sendable { /// /// Create a fork for the authenticated user. /// - /// **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + /// > [!NOTE] + /// > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). /// - /// **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + /// > [!NOTE] + /// > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/forks/post(repos/create-fork)`. @@ -1335,7 +1354,8 @@ public protocol APIProtocol: Sendable { /// /// This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. /// - /// **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + /// > [!NOTE] + /// > Previously `/repos/:owner/:repo/hooks/:hook_id/test` /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/hooks/{hook_id}/tests`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/tests/post(repos/test-push-webhook)`. @@ -1657,9 +1677,8 @@ public protocol APIProtocol: Sendable { /// /// Gets a public release with the specified release ID. /// - /// **Note:** This returns an `upload_url` key corresponding to the endpoint - /// for uploading release assets. This key is a hypermedia resource. For more information, see - /// "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + /// > [!NOTE] + /// > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/releases/{release_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/releases/{release_id}/get(repos/get-release)`. @@ -1773,12 +1792,10 @@ public protocol APIProtocol: Sendable { func repos_sol_delete_hyphen_repo_hyphen_ruleset(_ input: Operations.repos_sol_delete_hyphen_repo_hyphen_ruleset.Input) async throws -> Operations.repos_sol_delete_hyphen_repo_hyphen_ruleset.Output /// Get the weekly commit activity /// - /// /// Returns a weekly aggregate of the number of additions and deletions pushed to a repository. /// - /// **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - /// 10,000 or more commits, a 422 status code will be returned. - /// + /// > [!NOTE] + /// > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/code_frequency`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/code_frequency/get(repos/get-code-frequency-stats)`. @@ -1800,7 +1817,8 @@ public protocol APIProtocol: Sendable { /// * `d` - Number of deletions /// * `c` - Number of commits /// - /// **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + /// > [!NOTE] + /// > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/contributors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/contributors/get(repos/get-contributors-stats)`. @@ -1847,8 +1865,8 @@ public protocol APIProtocol: Sendable { func repos_sol_list_hyphen_tags(_ input: Operations.repos_sol_list_hyphen_tags.Input) async throws -> Operations.repos_sol_list_hyphen_tags.Output /// Deprecated - List tag protection states for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. /// /// This returns the tag protection states of a repository. /// @@ -1860,8 +1878,8 @@ public protocol APIProtocol: Sendable { func repos_sol_list_hyphen_tag_hyphen_protection(_ input: Operations.repos_sol_list_hyphen_tag_hyphen_protection.Input) async throws -> Operations.repos_sol_list_hyphen_tag_hyphen_protection.Output /// Deprecated - Create a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. /// /// This creates a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -1872,8 +1890,8 @@ public protocol APIProtocol: Sendable { func repos_sol_create_hyphen_tag_hyphen_protection(_ input: Operations.repos_sol_create_hyphen_tag_hyphen_protection.Input) async throws -> Operations.repos_sol_create_hyphen_tag_hyphen_protection.Output /// Deprecated - Delete a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. /// /// This deletes a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -1887,7 +1905,9 @@ public protocol APIProtocol: Sendable { /// Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. - /// **Note**: For private repositories, these links are temporary and expire after five minutes. + /// + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/tarball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/tarball/{ref}/get(repos/download-tarball-archive)`. @@ -1981,7 +2001,8 @@ public protocol APIProtocol: Sendable { /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. /// - /// **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/zipball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/zipball/{ref}/get(repos/download-zipball-archive)`. @@ -2060,7 +2081,8 @@ extension APIProtocol { /// /// Lists repositories for the specified organization. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/get(repos/list-for-org)`. @@ -2213,7 +2235,8 @@ extension APIProtocol { /// /// The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/get(repos/get)`. @@ -2479,9 +2502,11 @@ extension APIProtocol { /// /// Protecting a branch requires admin or owner permissions to the repository. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// - /// **Note**: The list of users, apps, and teams in total is limited to 100 items. + /// > [!NOTE] + /// > The list of users, apps, and teams in total is limited to 100 items. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/put(repos/update-branch-protection)`. @@ -2581,7 +2606,8 @@ extension APIProtocol { /// /// Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews/patch(repos/update-pull-request-review-protection)`. @@ -2617,7 +2643,8 @@ extension APIProtocol { /// /// When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. /// - /// **Note**: You must enable branch protection to require signed commits. + /// > [!NOTE] + /// > You must enable branch protection to require signed commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_signatures/get(repos/get-commit-signature-protection)`. @@ -2779,7 +2806,8 @@ extension APIProtocol { /// /// Lists who has access to this protected branch. /// - /// **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + /// > [!NOTE] + /// > Users, apps, and teams `restrictions` are only available for organization-owned repositories. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/get(repos/get-access-restrictions)`. @@ -3041,7 +3069,8 @@ extension APIProtocol { /// /// Renames a branch in a repository. /// - /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + /// > [!NOTE] + /// > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// @@ -3175,7 +3204,8 @@ extension APIProtocol { /// - If the user had their own fork of the repository, the fork will be deleted. /// - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. /// - /// **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + /// > [!NOTE] + /// > A user can still have access to the repository through organization permissions like base repository permissions. /// /// Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. /// @@ -3432,7 +3462,8 @@ extension APIProtocol { /// /// Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. /// - /// **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + /// > [!NOTE] + /// > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. /// /// 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)." Pagination query parameters are not supported for these media types. /// @@ -3661,7 +3692,8 @@ extension APIProtocol { /// /// Creates a new file or replaces an existing file in a repository. /// - /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. /// @@ -3688,7 +3720,8 @@ extension APIProtocol { /// /// You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. /// - /// **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/delete(repos/delete-file)`. @@ -3939,7 +3972,8 @@ extension APIProtocol { } /// Get an environment /// - /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + /// > [!NOTE] + /// > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// /// Anyone with read access to the repository can use this endpoint. /// @@ -3960,9 +3994,11 @@ extension APIProtocol { /// /// Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." /// - /// **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + /// > [!NOTE] + /// > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." /// - /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + /// > [!NOTE] + /// > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// @@ -4121,7 +4157,9 @@ extension APIProtocol { } /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. + /// + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// @@ -4195,9 +4233,11 @@ extension APIProtocol { /// /// Create a fork for the authenticated user. /// - /// **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + /// > [!NOTE] + /// > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). /// - /// **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + /// > [!NOTE] + /// > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/forks/post(repos/create-fork)`. @@ -4396,7 +4436,8 @@ extension APIProtocol { /// /// This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. /// - /// **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + /// > [!NOTE] + /// > Previously `/repos/:owner/:repo/hooks/:hook_id/test` /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/hooks/{hook_id}/tests`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/tests/post(repos/test-push-webhook)`. @@ -5038,9 +5079,8 @@ extension APIProtocol { /// /// Gets a public release with the specified release ID. /// - /// **Note:** This returns an `upload_url` key corresponding to the endpoint - /// for uploading release assets. This key is a hypermedia resource. For more information, see - /// "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + /// > [!NOTE] + /// > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/releases/{release_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/releases/{release_id}/get(repos/get-release)`. @@ -5272,12 +5312,10 @@ extension APIProtocol { } /// Get the weekly commit activity /// - /// /// Returns a weekly aggregate of the number of additions and deletions pushed to a repository. /// - /// **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - /// 10,000 or more commits, a 422 status code will be returned. - /// + /// > [!NOTE] + /// > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/code_frequency`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/code_frequency/get(repos/get-code-frequency-stats)`. @@ -5315,7 +5353,8 @@ extension APIProtocol { /// * `d` - Number of deletions /// * `c` - Number of commits /// - /// **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + /// > [!NOTE] + /// > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/contributors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/contributors/get(repos/get-contributors-stats)`. @@ -5406,8 +5445,8 @@ extension APIProtocol { } /// Deprecated - List tag protection states for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. /// /// This returns the tag protection states of a repository. /// @@ -5427,8 +5466,8 @@ extension APIProtocol { } /// Deprecated - Create a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. /// /// This creates a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -5449,8 +5488,8 @@ extension APIProtocol { } /// Deprecated - Delete a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. /// /// This deletes a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -5472,7 +5511,9 @@ extension APIProtocol { /// Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. - /// **Note**: For private repositories, these links are temporary and expire after five minutes. + /// + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/tarball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/tarball/{ref}/get(repos/download-tarball-archive)`. @@ -5650,7 +5691,8 @@ extension APIProtocol { /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. /// - /// **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/zipball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/zipball/{ref}/get(repos/download-zipball-archive)`. @@ -12720,7 +12762,8 @@ public enum Components { public var name: Swift.String /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/components/schemas/repository-ruleset/target`. @frozen public enum targetPayload: String, Codable, Hashable, Sendable { @@ -12730,7 +12773,8 @@ public enum Components { } /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/components/schemas/repository-ruleset/target`. public var target: Components.Schemas.repository_hyphen_ruleset.targetPayload? @@ -18822,7 +18866,7 @@ public enum Components { /// The id of the environment. /// /// - Remark: Generated from `#/components/schemas/environment/id`. - public var id: Swift.Int + public var id: Swift.Int64 /// - Remark: Generated from `#/components/schemas/environment/node_id`. public var node_id: Swift.String /// The name of the environment. @@ -19102,7 +19146,7 @@ public enum Components { /// - protection_rules: Built-in deployment protection rules for the environment. /// - deployment_branch_policy: public init( - id: Swift.Int, + id: Swift.Int64, node_id: Swift.String, name: Swift.String, url: Swift.String, @@ -21803,6 +21847,11 @@ public enum Components { /// /// - Remark: Generated from `#/components/parameters/invitation-id`. public typealias invitation_hyphen_id = Swift.Int + /// The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + /// + /// + /// - Remark: Generated from `#/components/parameters/ref-in-query`. + public typealias ref_hyphen_in_hyphen_query = Swift.String /// The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. /// /// - Remark: Generated from `#/components/parameters/repository-name-in-query`. @@ -21919,10 +21968,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/parameters/release-id`. public typealias release_hyphen_id = Swift.Int - /// The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. - /// - /// - Remark: Generated from `#/components/parameters/ref-in-query`. - public typealias ref_hyphen_in_hyphen_query = Swift.String /// The unique identifier of the tag protection. /// /// - Remark: Generated from `#/components/parameters/tag-protection-id`. @@ -22366,7 +22411,8 @@ public enum Operations { /// /// Lists repositories for the specified organization. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/get(repos/list-for-org)`. @@ -23340,7 +23386,8 @@ public enum Operations { public var name: Swift.String /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/POST/requestBody/json/target`. @frozen public enum targetPayload: String, Codable, Hashable, Sendable { @@ -23350,7 +23397,8 @@ public enum Operations { } /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/POST/requestBody/json/target`. public var target: Operations.repos_sol_create_hyphen_org_hyphen_ruleset.Input.Body.jsonPayload.targetPayload? @@ -23575,6 +23623,11 @@ public enum Operations { public var path: Operations.repos_sol_get_hyphen_org_hyphen_rule_hyphen_suites.Input.Path /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/rule-suites/GET/query`. public struct Query: Sendable, Hashable { + /// The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + /// + /// + /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/rule-suites/GET/query/ref`. + public var ref: Components.Parameters.ref_hyphen_in_hyphen_query? /// The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. /// /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/rule-suites/GET/query/repository_name`. @@ -23618,6 +23671,7 @@ public enum Operations { /// Creates a new `Query`. /// /// - Parameters: + /// - ref: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. /// - repository_name: The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. /// - time_period: The time period to filter by. /// - actor_name: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. @@ -23625,6 +23679,7 @@ public enum Operations { /// - per_page: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." /// - page: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." public init( + ref: Components.Parameters.ref_hyphen_in_hyphen_query? = nil, repository_name: Components.Parameters.repository_hyphen_name_hyphen_in_hyphen_query? = nil, time_period: Components.Parameters.time_hyphen_period? = nil, actor_name: Components.Parameters.actor_hyphen_name_hyphen_in_hyphen_query? = nil, @@ -23632,6 +23687,7 @@ public enum Operations { per_page: Components.Parameters.per_hyphen_page? = nil, page: Components.Parameters.page? = nil ) { + self.ref = ref self.repository_name = repository_name self.time_period = time_period self.actor_name = actor_name @@ -24231,7 +24287,8 @@ public enum Operations { public var name: Swift.String? /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/{ruleset_id}/PUT/requestBody/json/target`. @frozen public enum targetPayload: String, Codable, Hashable, Sendable { @@ -24241,7 +24298,8 @@ public enum Operations { } /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/orgs/{org}/rulesets/{ruleset_id}/PUT/requestBody/json/target`. public var target: Operations.repos_sol_update_hyphen_org_hyphen_ruleset.Input.Body.jsonPayload.targetPayload? @@ -24606,7 +24664,8 @@ public enum Operations { /// /// The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network. /// - /// **Note:** In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." + /// > [!NOTE] + /// > In order to see the `security_and_analysis` block for a repository you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/get(repos/get)`. @@ -28192,9 +28251,11 @@ public enum Operations { /// /// Protecting a branch requires admin or owner permissions to the repository. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// - /// **Note**: The list of users, apps, and teams in total is limited to 100 items. + /// > [!NOTE] + /// > The list of users, apps, and teams in total is limited to 100 items. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/put(repos/update-branch-protection)`. @@ -29507,7 +29568,8 @@ public enum Operations { /// /// Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled. /// - /// **Note**: Passing new arrays of `users` and `teams` replaces their previous values. + /// > [!NOTE] + /// > Passing new arrays of `users` and `teams` replaces their previous values. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews/patch(repos/update-pull-request-review-protection)`. @@ -29971,7 +30033,8 @@ public enum Operations { /// /// When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://docs.github.com/articles/signing-commits-with-gpg) in GitHub Help. /// - /// **Note**: You must enable branch protection to require signed commits. + /// > [!NOTE] + /// > You must enable branch protection to require signed commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/required_signatures/get(repos/get-commit-signature-protection)`. @@ -31959,7 +32022,8 @@ public enum Operations { /// /// Lists who has access to this protected branch. /// - /// **Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories. + /// > [!NOTE] + /// > Users, apps, and teams `restrictions` are only available for organization-owned repositories. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/get(repos/get-access-restrictions)`. @@ -34859,7 +34923,8 @@ public enum Operations { /// /// Renames a branch in a repository. /// - /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". + /// > [!NOTE] + /// > Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// @@ -35942,7 +36007,8 @@ public enum Operations { /// - If the user had their own fork of the repository, the fork will be deleted. /// - If the user still has read access to the repository, open pull requests by this user from a fork will be denied. /// - /// **Note**: A user can still have access to the repository through organization permissions like base repository permissions. + /// > [!NOTE] + /// > A user can still have access to the repository through organization permissions like base repository permissions. /// /// Although the API responds immediately, the additional permission updates might take some extra time to complete in the background. /// @@ -38262,7 +38328,8 @@ public enum Operations { /// /// Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. /// - /// **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + /// > [!NOTE] + /// > If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. /// /// 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)." Pagination query parameters are not supported for these media types. /// @@ -39824,7 +39891,8 @@ public enum Operations { /// /// Creates a new file or replaces an existing file in a repository. /// - /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. /// @@ -40240,7 +40308,8 @@ public enum Operations { /// /// You must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code. /// - /// **Note:** If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + /// > [!NOTE] + /// > If you use this endpoint and the "[Create or update file contents](https://docs.github.com/rest/repos/contents/#create-or-update-file-contents)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/delete(repos/delete-file)`. @@ -42170,7 +42239,10 @@ public enum Operations { /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/POST/requestBody/json/state`. public var state: Operations.repos_sol_create_hyphen_deployment_hyphen_status.Input.Body.jsonPayload.statePayload - /// The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + /// The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. + /// + /// > [!NOTE] + /// > It's recommended to use the `log_url` parameter, which replaces `target_url`. /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/POST/requestBody/json/target_url`. public var target_url: Swift.String? @@ -42198,7 +42270,7 @@ public enum Operations { /// /// - Parameters: /// - state: The state of the status. When you set a transient deployment to `inactive`, the deployment will be shown as `destroyed` in GitHub. - /// - target_url: The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`. + /// - target_url: The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. /// - log_url: The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `""` /// - description: A short description of the status. The maximum description length is 140 characters. /// - environment: Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. If not defined, the environment of the previous status on the deployment will be used, if it exists. Otherwise, the environment of the deployment will be used. @@ -42976,7 +43048,8 @@ public enum Operations { } /// Get an environment /// - /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." + /// > [!NOTE] + /// > To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// /// Anyone with read access to the repository can use this endpoint. /// @@ -43130,9 +43203,11 @@ public enum Operations { /// /// Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)." /// - /// **Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." + /// > [!NOTE] + /// > To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)." /// - /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." + /// > [!NOTE] + /// > To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// @@ -44705,7 +44780,9 @@ public enum Operations { } /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. + /// + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// @@ -45395,9 +45472,11 @@ public enum Operations { /// /// Create a fork for the authenticated user. /// - /// **Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). + /// > [!NOTE] + /// > Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api). /// - /// **Note**: Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. + /// > [!NOTE] + /// > Although this endpoint works with GitHub Apps, the GitHub App must be installed on the destination account with access to all repositories and on the source account with access to the source repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/forks/post(repos/create-fork)`. @@ -47936,7 +48015,8 @@ public enum Operations { /// /// This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated. /// - /// **Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test` + /// > [!NOTE] + /// > Previously `/repos/:owner/:repo/hooks/:hook_id/test` /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/hooks/{hook_id}/tests`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/tests/post(repos/test-push-webhook)`. @@ -55216,9 +55296,8 @@ public enum Operations { /// /// Gets a public release with the specified release ID. /// - /// **Note:** This returns an `upload_url` key corresponding to the endpoint - /// for uploading release assets. This key is a hypermedia resource. For more information, see - /// "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." + /// > [!NOTE] + /// > This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/releases/{release_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/releases/{release_id}/get(repos/get-release)`. @@ -56637,7 +56716,8 @@ public enum Operations { public var name: Swift.String /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/rulesets/POST/requestBody/json/target`. @frozen public enum targetPayload: String, Codable, Hashable, Sendable { @@ -56647,7 +56727,8 @@ public enum Operations { } /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/rulesets/POST/requestBody/json/target`. public var target: Operations.repos_sol_create_hyphen_repo_hyphen_ruleset.Input.Body.jsonPayload.targetPayload? @@ -56881,7 +56962,8 @@ public enum Operations { public var path: Operations.repos_sol_get_hyphen_repo_hyphen_rule_hyphen_suites.Input.Path /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/rulesets/rule-suites/GET/query`. public struct Query: Sendable, Hashable { - /// The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. + /// The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. + /// /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/rulesets/rule-suites/GET/query/ref`. public var ref: Components.Parameters.ref_hyphen_in_hyphen_query? @@ -56924,7 +57006,7 @@ public enum Operations { /// Creates a new `Query`. /// /// - Parameters: - /// - ref: The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. + /// - ref: The name of the ref. Cannot contain wildcard characters. Optionally prefix with `refs/heads/` to limit to branches or `refs/tags/` to limit to tags. Omit the prefix to search across all refs. When specified, only rule evaluations triggered for this ref will be returned. /// - time_period: The time period to filter by. /// - actor_name: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. /// - rule_suite_result: The rule results to filter on. When specified, only suites with this result will be returned. @@ -57576,7 +57658,8 @@ public enum Operations { public var name: Swift.String? /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/rulesets/{ruleset_id}/PUT/requestBody/json/target`. @frozen public enum targetPayload: String, Codable, Hashable, Sendable { @@ -57586,7 +57669,8 @@ public enum Operations { } /// The target of the ruleset /// - /// **Note**: The `push` target is in beta and is subject to change. + /// > [!NOTE] + /// > The `push` target is in beta and is subject to change. /// /// - Remark: Generated from `#/paths/repos/{owner}/{repo}/rulesets/{ruleset_id}/PUT/requestBody/json/target`. public var target: Operations.repos_sol_update_hyphen_repo_hyphen_ruleset.Input.Body.jsonPayload.targetPayload? @@ -57956,12 +58040,10 @@ public enum Operations { } /// Get the weekly commit activity /// - /// /// Returns a weekly aggregate of the number of additions and deletions pushed to a repository. /// - /// **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains - /// 10,000 or more commits, a 422 status code will be returned. - /// + /// > [!NOTE] + /// > This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains 10,000 or more commits, a 422 status code will be returned. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/code_frequency`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/code_frequency/get(repos/get-code-frequency-stats)`. @@ -58370,7 +58452,8 @@ public enum Operations { /// * `d` - Number of deletions /// * `c` - Number of commits /// - /// **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. + /// > [!NOTE] + /// > This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/stats/contributors`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/stats/contributors/get(repos/get-contributors-stats)`. @@ -59312,8 +59395,8 @@ public enum Operations { } /// Deprecated - List tag protection states for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#get-all-repository-rulesets)" endpoint instead. /// /// This returns the tag protection states of a repository. /// @@ -59504,8 +59587,8 @@ public enum Operations { } /// Deprecated - Create a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#create-a-repository-ruleset)" endpoint instead. /// /// This creates a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -59721,8 +59804,8 @@ public enum Operations { } /// Deprecated - Delete a tag protection state for a repository /// - /// **Note**: This operation is deprecated and will be removed after August 30th 2024 - /// Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. + /// > [!WARNING] + /// > **Deprecation notice:** This operation is deprecated and will be removed after August 30, 2024. Use the "[Repository Rulesets](https://docs.github.com/rest/repos/rules#delete-a-repository-ruleset)" endpoint instead. /// /// This deletes a tag protection state for a repository. /// This endpoint is only available to repository administrators. @@ -59898,7 +59981,9 @@ public enum Operations { /// Gets a redirect URL to download a tar archive for a repository. If you omit `:ref`, the repository’s default branch (usually /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. - /// **Note**: For private repositories, these links are temporary and expire after five minutes. + /// + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/tarball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/tarball/{ref}/get(repos/download-tarball-archive)`. @@ -61760,7 +61845,8 @@ public enum Operations { /// `main`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use /// the `Location` header to make a second `GET` request. /// - /// **Note**: For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. + /// > [!NOTE] + /// > For private repositories, these links are temporary and expire after five minutes. If the repository is empty, you will receive a 404 when you follow the redirect. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/zipball/{ref}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/zipball/{ref}/get(repos/download-zipball-archive)`. diff --git a/Sources/search/Client.swift b/Sources/search/Client.swift index 374c7890677..bf94bccf9ef 100644 --- a/Sources/search/Client.swift +++ b/Sources/search/Client.swift @@ -341,7 +341,8 @@ public struct Client: APIProtocol { /// /// This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. /// - /// **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + /// > [!NOTE] + /// > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." /// /// - Remark: HTTP `GET /search/issues`. /// - Remark: Generated from `#/paths//search/issues/get(search/issues-and-pull-requests)`. diff --git a/Sources/search/Types.swift b/Sources/search/Types.swift index 7fc0a2ed1d2..a250ef7acf4 100644 --- a/Sources/search/Types.swift +++ b/Sources/search/Types.swift @@ -64,7 +64,8 @@ public protocol APIProtocol: Sendable { /// /// This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. /// - /// **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + /// > [!NOTE] + /// > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." /// /// - Remark: HTTP `GET /search/issues`. /// - Remark: Generated from `#/paths//search/issues/get(search/issues-and-pull-requests)`. @@ -204,7 +205,8 @@ extension APIProtocol { /// /// This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. /// - /// **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + /// > [!NOTE] + /// > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." /// /// - Remark: HTTP `GET /search/issues`. /// - Remark: Generated from `#/paths//search/issues/get(search/issues-and-pull-requests)`. @@ -5388,7 +5390,8 @@ public enum Operations { /// /// This query searches for the keyword `windows`, within any open issue that is labeled as `bug`. The search runs across repositories whose primary language is Python. The results are sorted by creation date in ascending order, which means the oldest issues appear first in the search results. /// - /// **Note:** For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." + /// > [!NOTE] + /// > For requests made by GitHub Apps with a user access token, you can't retrieve a combination of issues and pull requests in a single query. Requests that don't include the `is:issue` or `is:pull-request` qualifier will receive an HTTP `422 Unprocessable Entity` response. To get results for both issues and pull requests, you must send separate queries for issues and pull requests. For more information about the `is` qualifier, see "[Searching only issues or pull requests](https://docs.github.com/github/searching-for-information-on-github/searching-issues-and-pull-requests#search-only-issues-or-pull-requests)." /// /// - Remark: HTTP `GET /search/issues`. /// - Remark: Generated from `#/paths//search/issues/get(search/issues-and-pull-requests)`. diff --git a/Sources/security-advisories/Client.swift b/Sources/security-advisories/Client.swift index d6956a89148..ce8962c0ec1 100644 --- a/Sources/security-advisories/Client.swift +++ b/Sources/security-advisories/Client.swift @@ -1392,7 +1392,8 @@ public struct Client: APIProtocol { /// /// Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. /// - /// **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + /// > [!NOTE] + /// > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks/post(security-advisories/create-fork)`. diff --git a/Sources/security-advisories/Types.swift b/Sources/security-advisories/Types.swift index 44c750f8be3..592af5e8309 100644 --- a/Sources/security-advisories/Types.swift +++ b/Sources/security-advisories/Types.swift @@ -111,7 +111,8 @@ public protocol APIProtocol: Sendable { /// /// Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. /// - /// **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + /// > [!NOTE] + /// > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks/post(security-advisories/create-fork)`. @@ -302,7 +303,8 @@ extension APIProtocol { /// /// Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. /// - /// **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + /// > [!NOTE] + /// > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks/post(security-advisories/create-fork)`. @@ -8493,7 +8495,8 @@ public enum Operations { /// /// Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. /// - /// **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + /// > [!NOTE] + /// > Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks/post(security-advisories/create-fork)`. diff --git a/Sources/teams/Client.swift b/Sources/teams/Client.swift index d0ede64edf4..50c05979d3d 100644 --- a/Sources/teams/Client.swift +++ b/Sources/teams/Client.swift @@ -269,7 +269,8 @@ public struct Client: APIProtocol { /// /// Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/get(teams/get-by-name)`. @@ -358,7 +359,8 @@ public struct Client: APIProtocol { /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/patch(teams/update-in-org)`. @@ -526,7 +528,8 @@ public struct Client: APIProtocol { /// /// If you are an organization owner, deleting a parent team will delete all of its child teams as well. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/delete(teams/delete-in-org)`. @@ -569,7 +572,8 @@ public struct Client: APIProtocol { /// /// List all discussions on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -676,7 +680,8 @@ public struct Client: APIProtocol { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -754,7 +759,8 @@ public struct Client: APIProtocol { /// /// Get a specific discussion on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -824,7 +830,8 @@ public struct Client: APIProtocol { /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -905,7 +912,8 @@ public struct Client: APIProtocol { /// /// Delete a discussion from a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -951,7 +959,8 @@ public struct Client: APIProtocol { /// /// List all comments on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -1052,7 +1061,8 @@ public struct Client: APIProtocol { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -1131,7 +1141,8 @@ public struct Client: APIProtocol { /// /// Get a specific comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -1202,7 +1213,8 @@ public struct Client: APIProtocol { /// /// Edits the body text of a discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -1282,7 +1294,8 @@ public struct Client: APIProtocol { /// /// Deletes a comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -1329,7 +1342,8 @@ public struct Client: APIProtocol { /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/invitations`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/invitations/get(teams/list-pending-invitations-in-org)`. @@ -1516,10 +1530,11 @@ public struct Client: APIProtocol { /// /// To get a user's membership with a team, the team must be visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// - /// **Note:** - /// The response contains the `state` of the membership and the member's `role`. + /// > [!NOTE] + /// > The response contains the `state` of the membership and the member's `role`. /// /// The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). /// @@ -1593,13 +1608,15 @@ public struct Client: APIProtocol { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. /// /// If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/put(teams/add-or-update-membership-for-user-in-org)`. @@ -1684,9 +1701,11 @@ public struct Client: APIProtocol { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/delete(teams/remove-membership-for-user-in-org)`. @@ -1732,7 +1751,8 @@ public struct Client: APIProtocol { /// /// Lists the organization projects for a team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/get(teams/list-projects-in-org)`. @@ -1821,7 +1841,8 @@ public struct Client: APIProtocol { /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/get(teams/check-permissions-for-project-in-org)`. @@ -1891,7 +1912,8 @@ public struct Client: APIProtocol { /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/put(teams/add-or-update-project-permissions-in-org)`. @@ -1972,7 +1994,8 @@ public struct Client: APIProtocol { /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/delete(teams/remove-project-in-org)`. @@ -2016,7 +2039,8 @@ public struct Client: APIProtocol { /// /// Lists a team's repositories visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/get(teams/list-repos-in-org)`. @@ -2111,7 +2135,8 @@ public struct Client: APIProtocol { /// /// If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/get(teams/check-permissions-for-repo-in-org)`. @@ -2184,7 +2209,8 @@ public struct Client: APIProtocol { /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". /// @@ -2242,7 +2268,8 @@ public struct Client: APIProtocol { /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/delete(teams/remove-repo-in-org)`. @@ -2287,7 +2314,8 @@ public struct Client: APIProtocol { /// /// Lists the child teams of the team specified by `{team_slug}`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/teams/get(teams/list-child-in-org)`. @@ -2374,7 +2402,8 @@ public struct Client: APIProtocol { } /// Get a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/get(teams/get-legacy)`. @@ -2461,11 +2490,13 @@ public struct Client: APIProtocol { } /// Update a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + /// > [!NOTE] + /// > With nested teams, the `privacy` for parent teams cannot be `secret`. /// /// - Remark: HTTP `PATCH /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/patch(teams/update-legacy)`. @@ -2627,7 +2658,8 @@ public struct Client: APIProtocol { } /// Delete a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. /// /// To delete a team, the authenticated user must be an organization owner or team maintainer. /// @@ -2720,7 +2752,8 @@ public struct Client: APIProtocol { } /// List discussions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// /// List all discussions on a team's page. /// @@ -2818,7 +2851,8 @@ public struct Client: APIProtocol { } /// Create a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// /// Creates a new discussion post on a team's page. /// @@ -2898,7 +2932,8 @@ public struct Client: APIProtocol { } /// Get a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// /// Get a specific discussion on a team's page. /// @@ -2968,7 +3003,8 @@ public struct Client: APIProtocol { } /// Update a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// @@ -3049,7 +3085,8 @@ public struct Client: APIProtocol { } /// Delete a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// /// Delete a discussion from a team's page. /// @@ -3095,7 +3132,8 @@ public struct Client: APIProtocol { } /// List discussion comments (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// /// List all comments on a team discussion. /// @@ -3194,7 +3232,8 @@ public struct Client: APIProtocol { } /// Create a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// /// Creates a new comment on a team discussion. /// @@ -3275,7 +3314,8 @@ public struct Client: APIProtocol { } /// Get a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// /// Get a specific comment on a team discussion. /// @@ -3346,7 +3386,8 @@ public struct Client: APIProtocol { } /// Update a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// /// Edits the body text of a discussion comment. /// @@ -3426,7 +3467,8 @@ public struct Client: APIProtocol { } /// Delete a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// /// Deletes a comment on a team discussion. /// @@ -3473,7 +3515,8 @@ public struct Client: APIProtocol { } /// List pending team invitations (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// @@ -3562,7 +3605,8 @@ public struct Client: APIProtocol { } /// List team members (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. /// /// Team members will include the members of child teams. /// @@ -3736,7 +3780,8 @@ public struct Client: APIProtocol { /// /// To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// @@ -3818,7 +3863,8 @@ public struct Client: APIProtocol { /// /// To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/members/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/members/{username}/delete(teams/remove-member-legacy)`. @@ -3862,7 +3908,8 @@ public struct Client: APIProtocol { } /// Get team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. /// /// Team members will include the members of child teams. /// @@ -3959,13 +4006,15 @@ public struct Client: APIProtocol { } /// Add or update team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. /// @@ -4072,13 +4121,15 @@ public struct Client: APIProtocol { } /// Remove team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/memberships/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/memberships/{username}/delete(teams/remove-membership-for-user-legacy)`. @@ -4122,7 +4173,8 @@ public struct Client: APIProtocol { } /// List team projects (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. /// /// Lists the organization projects for a team. /// @@ -4233,7 +4285,8 @@ public struct Client: APIProtocol { } /// Check team permissions for a project (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// @@ -4303,7 +4356,8 @@ public struct Client: APIProtocol { } /// Add or update team project permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// @@ -4428,7 +4482,8 @@ public struct Client: APIProtocol { } /// Remove a project from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. /// @@ -4520,7 +4575,8 @@ public struct Client: APIProtocol { } /// List team repositories (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/repos`. /// - Remark: Generated from `#/paths//teams/{team_id}/repos/get(teams/list-repos-legacy)`. @@ -4629,9 +4685,11 @@ public struct Client: APIProtocol { } /// Check team permissions for a repository (Legacy) /// - /// **Note**: Repositories inherited through a parent team will also be checked. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + /// > [!NOTE] + /// > Repositories inherited through a parent team will also be checked. /// /// You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: /// @@ -4704,7 +4762,8 @@ public struct Client: APIProtocol { } /// Add or update team repository permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. /// @@ -4810,7 +4869,8 @@ public struct Client: APIProtocol { } /// Remove a repository from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. /// @@ -4855,7 +4915,8 @@ public struct Client: APIProtocol { } /// List child teams (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/teams`. /// - Remark: Generated from `#/paths//teams/{team_id}/teams/get(teams/list-child-legacy)`. diff --git a/Sources/teams/Types.swift b/Sources/teams/Types.swift index 81bdd6ed5e7..af6a649d5cc 100644 --- a/Sources/teams/Types.swift +++ b/Sources/teams/Types.swift @@ -31,7 +31,8 @@ public protocol APIProtocol: Sendable { /// /// Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/get(teams/get-by-name)`. @@ -40,7 +41,8 @@ public protocol APIProtocol: Sendable { /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/patch(teams/update-in-org)`. @@ -51,7 +53,8 @@ public protocol APIProtocol: Sendable { /// /// If you are an organization owner, deleting a parent team will delete all of its child teams as well. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/delete(teams/delete-in-org)`. @@ -60,7 +63,8 @@ public protocol APIProtocol: Sendable { /// /// List all discussions on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -73,7 +77,8 @@ public protocol APIProtocol: Sendable { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -84,7 +89,8 @@ public protocol APIProtocol: Sendable { /// /// Get a specific discussion on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -95,7 +101,8 @@ public protocol APIProtocol: Sendable { /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -106,7 +113,8 @@ public protocol APIProtocol: Sendable { /// /// Delete a discussion from a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -117,7 +125,8 @@ public protocol APIProtocol: Sendable { /// /// List all comments on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -130,7 +139,8 @@ public protocol APIProtocol: Sendable { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -141,7 +151,8 @@ public protocol APIProtocol: Sendable { /// /// Get a specific comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -152,7 +163,8 @@ public protocol APIProtocol: Sendable { /// /// Edits the body text of a discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -163,7 +175,8 @@ public protocol APIProtocol: Sendable { /// /// Deletes a comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -174,7 +187,8 @@ public protocol APIProtocol: Sendable { /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/invitations`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/invitations/get(teams/list-pending-invitations-in-org)`. @@ -194,10 +208,11 @@ public protocol APIProtocol: Sendable { /// /// To get a user's membership with a team, the team must be visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// - /// **Note:** - /// The response contains the `state` of the membership and the member's `role`. + /// > [!NOTE] + /// > The response contains the `state` of the membership and the member's `role`. /// /// The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). /// @@ -210,13 +225,15 @@ public protocol APIProtocol: Sendable { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. /// /// If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/put(teams/add-or-update-membership-for-user-in-org)`. @@ -227,9 +244,11 @@ public protocol APIProtocol: Sendable { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/delete(teams/remove-membership-for-user-in-org)`. @@ -238,7 +257,8 @@ public protocol APIProtocol: Sendable { /// /// Lists the organization projects for a team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/get(teams/list-projects-in-org)`. @@ -247,7 +267,8 @@ public protocol APIProtocol: Sendable { /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/get(teams/check-permissions-for-project-in-org)`. @@ -256,7 +277,8 @@ public protocol APIProtocol: Sendable { /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/put(teams/add-or-update-project-permissions-in-org)`. @@ -265,7 +287,8 @@ public protocol APIProtocol: Sendable { /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/delete(teams/remove-project-in-org)`. @@ -274,7 +297,8 @@ public protocol APIProtocol: Sendable { /// /// Lists a team's repositories visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/get(teams/list-repos-in-org)`. @@ -289,7 +313,8 @@ public protocol APIProtocol: Sendable { /// /// If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/get(teams/check-permissions-for-repo-in-org)`. @@ -298,7 +323,8 @@ public protocol APIProtocol: Sendable { /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". /// @@ -309,7 +335,8 @@ public protocol APIProtocol: Sendable { /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/delete(teams/remove-repo-in-org)`. @@ -318,14 +345,16 @@ public protocol APIProtocol: Sendable { /// /// Lists the child teams of the team specified by `{team_slug}`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/teams/get(teams/list-child-in-org)`. func teams_sol_list_hyphen_child_hyphen_in_hyphen_org(_ input: Operations.teams_sol_list_hyphen_child_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_list_hyphen_child_hyphen_in_hyphen_org.Output /// Get a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/get(teams/get-legacy)`. @@ -333,11 +362,13 @@ public protocol APIProtocol: Sendable { func teams_sol_get_hyphen_legacy(_ input: Operations.teams_sol_get_hyphen_legacy.Input) async throws -> Operations.teams_sol_get_hyphen_legacy.Output /// Update a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + /// > [!NOTE] + /// > With nested teams, the `privacy` for parent teams cannot be `secret`. /// /// - Remark: HTTP `PATCH /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/patch(teams/update-legacy)`. @@ -345,7 +376,8 @@ public protocol APIProtocol: Sendable { func teams_sol_update_hyphen_legacy(_ input: Operations.teams_sol_update_hyphen_legacy.Input) async throws -> Operations.teams_sol_update_hyphen_legacy.Output /// Delete a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. /// /// To delete a team, the authenticated user must be an organization owner or team maintainer. /// @@ -357,7 +389,8 @@ public protocol APIProtocol: Sendable { func teams_sol_delete_hyphen_legacy(_ input: Operations.teams_sol_delete_hyphen_legacy.Input) async throws -> Operations.teams_sol_delete_hyphen_legacy.Output /// List discussions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// /// List all discussions on a team's page. /// @@ -369,7 +402,8 @@ public protocol APIProtocol: Sendable { func teams_sol_list_hyphen_discussions_hyphen_legacy(_ input: Operations.teams_sol_list_hyphen_discussions_hyphen_legacy.Input) async throws -> Operations.teams_sol_list_hyphen_discussions_hyphen_legacy.Output /// Create a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// /// Creates a new discussion post on a team's page. /// @@ -383,7 +417,8 @@ public protocol APIProtocol: Sendable { func teams_sol_create_hyphen_discussion_hyphen_legacy(_ input: Operations.teams_sol_create_hyphen_discussion_hyphen_legacy.Input) async throws -> Operations.teams_sol_create_hyphen_discussion_hyphen_legacy.Output /// Get a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// /// Get a specific discussion on a team's page. /// @@ -395,7 +430,8 @@ public protocol APIProtocol: Sendable { func teams_sol_get_hyphen_discussion_hyphen_legacy(_ input: Operations.teams_sol_get_hyphen_discussion_hyphen_legacy.Input) async throws -> Operations.teams_sol_get_hyphen_discussion_hyphen_legacy.Output /// Update a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// @@ -407,7 +443,8 @@ public protocol APIProtocol: Sendable { func teams_sol_update_hyphen_discussion_hyphen_legacy(_ input: Operations.teams_sol_update_hyphen_discussion_hyphen_legacy.Input) async throws -> Operations.teams_sol_update_hyphen_discussion_hyphen_legacy.Output /// Delete a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// /// Delete a discussion from a team's page. /// @@ -419,7 +456,8 @@ public protocol APIProtocol: Sendable { func teams_sol_delete_hyphen_discussion_hyphen_legacy(_ input: Operations.teams_sol_delete_hyphen_discussion_hyphen_legacy.Input) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_legacy.Output /// List discussion comments (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// /// List all comments on a team discussion. /// @@ -431,7 +469,8 @@ public protocol APIProtocol: Sendable { func teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_legacy(_ input: Operations.teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_legacy.Input) async throws -> Operations.teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_legacy.Output /// Create a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// /// Creates a new comment on a team discussion. /// @@ -445,7 +484,8 @@ public protocol APIProtocol: Sendable { func teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_legacy(_ input: Operations.teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_legacy.Input) async throws -> Operations.teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_legacy.Output /// Get a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// /// Get a specific comment on a team discussion. /// @@ -457,7 +497,8 @@ public protocol APIProtocol: Sendable { func teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_legacy(_ input: Operations.teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_legacy.Input) async throws -> Operations.teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_legacy.Output /// Update a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// /// Edits the body text of a discussion comment. /// @@ -469,7 +510,8 @@ public protocol APIProtocol: Sendable { func teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_legacy(_ input: Operations.teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_legacy.Input) async throws -> Operations.teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_legacy.Output /// Delete a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// /// Deletes a comment on a team discussion. /// @@ -481,7 +523,8 @@ public protocol APIProtocol: Sendable { func teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_legacy(_ input: Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_legacy.Input) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_legacy.Output /// List pending team invitations (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// @@ -491,7 +534,8 @@ public protocol APIProtocol: Sendable { func teams_sol_list_hyphen_pending_hyphen_invitations_hyphen_legacy(_ input: Operations.teams_sol_list_hyphen_pending_hyphen_invitations_hyphen_legacy.Input) async throws -> Operations.teams_sol_list_hyphen_pending_hyphen_invitations_hyphen_legacy.Output /// List team members (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. /// /// Team members will include the members of child teams. /// @@ -521,7 +565,8 @@ public protocol APIProtocol: Sendable { /// /// To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// @@ -539,7 +584,8 @@ public protocol APIProtocol: Sendable { /// /// To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/members/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/members/{username}/delete(teams/remove-member-legacy)`. @@ -547,7 +593,8 @@ public protocol APIProtocol: Sendable { func teams_sol_remove_hyphen_member_hyphen_legacy(_ input: Operations.teams_sol_remove_hyphen_member_hyphen_legacy.Input) async throws -> Operations.teams_sol_remove_hyphen_member_hyphen_legacy.Output /// Get team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. /// /// Team members will include the members of child teams. /// @@ -564,13 +611,15 @@ public protocol APIProtocol: Sendable { func teams_sol_get_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy(_ input: Operations.teams_sol_get_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy.Input) async throws -> Operations.teams_sol_get_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy.Output /// Add or update team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. /// @@ -582,13 +631,15 @@ public protocol APIProtocol: Sendable { func teams_sol_add_hyphen_or_hyphen_update_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy(_ input: Operations.teams_sol_add_hyphen_or_hyphen_update_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy.Input) async throws -> Operations.teams_sol_add_hyphen_or_hyphen_update_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy.Output /// Remove team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/memberships/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/memberships/{username}/delete(teams/remove-membership-for-user-legacy)`. @@ -596,7 +647,8 @@ public protocol APIProtocol: Sendable { func teams_sol_remove_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy(_ input: Operations.teams_sol_remove_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy.Input) async throws -> Operations.teams_sol_remove_hyphen_membership_hyphen_for_hyphen_user_hyphen_legacy.Output /// List team projects (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. /// /// Lists the organization projects for a team. /// @@ -606,7 +658,8 @@ public protocol APIProtocol: Sendable { func teams_sol_list_hyphen_projects_hyphen_legacy(_ input: Operations.teams_sol_list_hyphen_projects_hyphen_legacy.Input) async throws -> Operations.teams_sol_list_hyphen_projects_hyphen_legacy.Output /// Check team permissions for a project (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// @@ -616,7 +669,8 @@ public protocol APIProtocol: Sendable { func teams_sol_check_hyphen_permissions_hyphen_for_hyphen_project_hyphen_legacy(_ input: Operations.teams_sol_check_hyphen_permissions_hyphen_for_hyphen_project_hyphen_legacy.Input) async throws -> Operations.teams_sol_check_hyphen_permissions_hyphen_for_hyphen_project_hyphen_legacy.Output /// Add or update team project permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// @@ -626,7 +680,8 @@ public protocol APIProtocol: Sendable { func teams_sol_add_hyphen_or_hyphen_update_hyphen_project_hyphen_permissions_hyphen_legacy(_ input: Operations.teams_sol_add_hyphen_or_hyphen_update_hyphen_project_hyphen_permissions_hyphen_legacy.Input) async throws -> Operations.teams_sol_add_hyphen_or_hyphen_update_hyphen_project_hyphen_permissions_hyphen_legacy.Output /// Remove a project from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. /// @@ -636,7 +691,8 @@ public protocol APIProtocol: Sendable { func teams_sol_remove_hyphen_project_hyphen_legacy(_ input: Operations.teams_sol_remove_hyphen_project_hyphen_legacy.Input) async throws -> Operations.teams_sol_remove_hyphen_project_hyphen_legacy.Output /// List team repositories (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/repos`. /// - Remark: Generated from `#/paths//teams/{team_id}/repos/get(teams/list-repos-legacy)`. @@ -644,9 +700,11 @@ public protocol APIProtocol: Sendable { func teams_sol_list_hyphen_repos_hyphen_legacy(_ input: Operations.teams_sol_list_hyphen_repos_hyphen_legacy.Input) async throws -> Operations.teams_sol_list_hyphen_repos_hyphen_legacy.Output /// Check team permissions for a repository (Legacy) /// - /// **Note**: Repositories inherited through a parent team will also be checked. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + /// > [!NOTE] + /// > Repositories inherited through a parent team will also be checked. /// /// You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: /// @@ -656,7 +714,8 @@ public protocol APIProtocol: Sendable { func teams_sol_check_hyphen_permissions_hyphen_for_hyphen_repo_hyphen_legacy(_ input: Operations.teams_sol_check_hyphen_permissions_hyphen_for_hyphen_repo_hyphen_legacy.Input) async throws -> Operations.teams_sol_check_hyphen_permissions_hyphen_for_hyphen_repo_hyphen_legacy.Output /// Add or update team repository permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. /// @@ -668,7 +727,8 @@ public protocol APIProtocol: Sendable { func teams_sol_add_hyphen_or_hyphen_update_hyphen_repo_hyphen_permissions_hyphen_legacy(_ input: Operations.teams_sol_add_hyphen_or_hyphen_update_hyphen_repo_hyphen_permissions_hyphen_legacy.Input) async throws -> Operations.teams_sol_add_hyphen_or_hyphen_update_hyphen_repo_hyphen_permissions_hyphen_legacy.Output /// Remove a repository from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. /// @@ -678,7 +738,8 @@ public protocol APIProtocol: Sendable { func teams_sol_remove_hyphen_repo_hyphen_legacy(_ input: Operations.teams_sol_remove_hyphen_repo_hyphen_legacy.Input) async throws -> Operations.teams_sol_remove_hyphen_repo_hyphen_legacy.Output /// List child teams (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/teams`. /// - Remark: Generated from `#/paths//teams/{team_id}/teams/get(teams/list-child-legacy)`. @@ -740,7 +801,8 @@ extension APIProtocol { /// /// Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/get(teams/get-by-name)`. @@ -757,7 +819,8 @@ extension APIProtocol { /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/patch(teams/update-in-org)`. @@ -778,7 +841,8 @@ extension APIProtocol { /// /// If you are an organization owner, deleting a parent team will delete all of its child teams as well. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/delete(teams/delete-in-org)`. @@ -789,7 +853,8 @@ extension APIProtocol { /// /// List all discussions on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -812,7 +877,8 @@ extension APIProtocol { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -833,7 +899,8 @@ extension APIProtocol { /// /// Get a specific discussion on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -852,7 +919,8 @@ extension APIProtocol { /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -873,7 +941,8 @@ extension APIProtocol { /// /// Delete a discussion from a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -886,7 +955,8 @@ extension APIProtocol { /// /// List all comments on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -909,7 +979,8 @@ extension APIProtocol { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -930,7 +1001,8 @@ extension APIProtocol { /// /// Get a specific comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -949,7 +1021,8 @@ extension APIProtocol { /// /// Edits the body text of a discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -970,7 +1043,8 @@ extension APIProtocol { /// /// Deletes a comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -983,7 +1057,8 @@ extension APIProtocol { /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/invitations`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/invitations/get(teams/list-pending-invitations-in-org)`. @@ -1023,10 +1098,11 @@ extension APIProtocol { /// /// To get a user's membership with a team, the team must be visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// - /// **Note:** - /// The response contains the `state` of the membership and the member's `role`. + /// > [!NOTE] + /// > The response contains the `state` of the membership and the member's `role`. /// /// The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). /// @@ -1047,13 +1123,15 @@ extension APIProtocol { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. /// /// If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/put(teams/add-or-update-membership-for-user-in-org)`. @@ -1074,9 +1152,11 @@ extension APIProtocol { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/delete(teams/remove-membership-for-user-in-org)`. @@ -1087,7 +1167,8 @@ extension APIProtocol { /// /// Lists the organization projects for a team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/get(teams/list-projects-in-org)`. @@ -1106,7 +1187,8 @@ extension APIProtocol { /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/get(teams/check-permissions-for-project-in-org)`. @@ -1123,7 +1205,8 @@ extension APIProtocol { /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/put(teams/add-or-update-project-permissions-in-org)`. @@ -1142,7 +1225,8 @@ extension APIProtocol { /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/delete(teams/remove-project-in-org)`. @@ -1153,7 +1237,8 @@ extension APIProtocol { /// /// Lists a team's repositories visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/get(teams/list-repos-in-org)`. @@ -1178,7 +1263,8 @@ extension APIProtocol { /// /// If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/get(teams/check-permissions-for-repo-in-org)`. @@ -1195,7 +1281,8 @@ extension APIProtocol { /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". /// @@ -1214,7 +1301,8 @@ extension APIProtocol { /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/delete(teams/remove-repo-in-org)`. @@ -1225,7 +1313,8 @@ extension APIProtocol { /// /// Lists the child teams of the team specified by `{team_slug}`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/teams/get(teams/list-child-in-org)`. @@ -1242,7 +1331,8 @@ extension APIProtocol { } /// Get a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/get(teams/get-legacy)`. @@ -1258,11 +1348,13 @@ extension APIProtocol { } /// Update a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + /// > [!NOTE] + /// > With nested teams, the `privacy` for parent teams cannot be `secret`. /// /// - Remark: HTTP `PATCH /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/patch(teams/update-legacy)`. @@ -1280,7 +1372,8 @@ extension APIProtocol { } /// Delete a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. /// /// To delete a team, the authenticated user must be an organization owner or team maintainer. /// @@ -1300,7 +1393,8 @@ extension APIProtocol { } /// List discussions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// /// List all discussions on a team's page. /// @@ -1322,7 +1416,8 @@ extension APIProtocol { } /// Create a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// /// Creates a new discussion post on a team's page. /// @@ -1346,7 +1441,8 @@ extension APIProtocol { } /// Get a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// /// Get a specific discussion on a team's page. /// @@ -1366,7 +1462,8 @@ extension APIProtocol { } /// Update a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// @@ -1388,7 +1485,8 @@ extension APIProtocol { } /// Delete a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// /// Delete a discussion from a team's page. /// @@ -1402,7 +1500,8 @@ extension APIProtocol { } /// List discussion comments (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// /// List all comments on a team discussion. /// @@ -1424,7 +1523,8 @@ extension APIProtocol { } /// Create a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// /// Creates a new comment on a team discussion. /// @@ -1448,7 +1548,8 @@ extension APIProtocol { } /// Get a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// /// Get a specific comment on a team discussion. /// @@ -1468,7 +1569,8 @@ extension APIProtocol { } /// Update a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// /// Edits the body text of a discussion comment. /// @@ -1490,7 +1592,8 @@ extension APIProtocol { } /// Delete a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// /// Deletes a comment on a team discussion. /// @@ -1504,7 +1607,8 @@ extension APIProtocol { } /// List pending team invitations (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// @@ -1524,7 +1628,8 @@ extension APIProtocol { } /// List team members (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. /// /// Team members will include the members of child teams. /// @@ -1566,7 +1671,8 @@ extension APIProtocol { /// /// To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// @@ -1592,7 +1698,8 @@ extension APIProtocol { /// /// To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/members/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/members/{username}/delete(teams/remove-member-legacy)`. @@ -1602,7 +1709,8 @@ extension APIProtocol { } /// Get team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. /// /// Team members will include the members of child teams. /// @@ -1627,13 +1735,15 @@ extension APIProtocol { } /// Add or update team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. /// @@ -1655,13 +1765,15 @@ extension APIProtocol { } /// Remove team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/memberships/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/memberships/{username}/delete(teams/remove-membership-for-user-legacy)`. @@ -1671,7 +1783,8 @@ extension APIProtocol { } /// List team projects (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. /// /// Lists the organization projects for a team. /// @@ -1691,7 +1804,8 @@ extension APIProtocol { } /// Check team permissions for a project (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// @@ -1709,7 +1823,8 @@ extension APIProtocol { } /// Add or update team project permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// @@ -1729,7 +1844,8 @@ extension APIProtocol { } /// Remove a project from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. /// @@ -1747,7 +1863,8 @@ extension APIProtocol { } /// List team repositories (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/repos`. /// - Remark: Generated from `#/paths//teams/{team_id}/repos/get(teams/list-repos-legacy)`. @@ -1765,9 +1882,11 @@ extension APIProtocol { } /// Check team permissions for a repository (Legacy) /// - /// **Note**: Repositories inherited through a parent team will also be checked. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + /// > [!NOTE] + /// > Repositories inherited through a parent team will also be checked. /// /// You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: /// @@ -1785,7 +1904,8 @@ extension APIProtocol { } /// Add or update team repository permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. /// @@ -1807,7 +1927,8 @@ extension APIProtocol { } /// Remove a repository from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. /// @@ -1819,7 +1940,8 @@ extension APIProtocol { } /// List child teams (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/teams`. /// - Remark: Generated from `#/paths//teams/{team_id}/teams/get(teams/list-child-legacy)`. @@ -5789,7 +5911,8 @@ public enum Operations { /// /// Gets a team using the team's `slug`. To create the `slug`, GitHub replaces special characters in the `name` string, changes all words to lowercase, and replaces spaces with a `-` separator. For example, `"My TEam Näme"` would become `my-team-name`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/get(teams/get-by-name)`. @@ -5955,7 +6078,8 @@ public enum Operations { /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/patch(teams/update-in-org)`. @@ -6324,7 +6448,8 @@ public enum Operations { /// /// If you are an organization owner, deleting a parent team will delete all of its child teams as well. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/delete(teams/delete-in-org)`. @@ -6401,7 +6526,8 @@ public enum Operations { /// /// List all discussions on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -6613,7 +6739,8 @@ public enum Operations { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -6802,7 +6929,8 @@ public enum Operations { /// /// Get a specific discussion on a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -6954,7 +7082,8 @@ public enum Operations { /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -7142,7 +7271,8 @@ public enum Operations { /// /// Delete a discussion from a team's page. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -7228,7 +7358,8 @@ public enum Operations { /// /// List all comments on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -7440,7 +7571,8 @@ public enum Operations { /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -7618,7 +7750,8 @@ public enum Operations { /// /// Get a specific comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// @@ -7777,7 +7910,8 @@ public enum Operations { /// /// Edits the body text of a discussion comment. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -7962,7 +8096,8 @@ public enum Operations { /// /// Deletes a comment on a team discussion. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// @@ -8055,7 +8190,8 @@ public enum Operations { /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/invitations`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/invitations`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/invitations/get(teams/list-pending-invitations-in-org)`. @@ -8448,10 +8584,11 @@ public enum Operations { /// /// To get a user's membership with a team, the team must be visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// - /// **Note:** - /// The response contains the `state` of the membership and the member's `role`. + /// > [!NOTE] + /// > The response contains the `state` of the membership and the member's `role`. /// /// The `role` for organization owners is set to `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/rest/teams/teams#create-a-team). /// @@ -8632,13 +8769,15 @@ public enum Operations { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. /// /// If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/put(teams/add-or-update-membership-for-user-in-org)`. @@ -8877,9 +9016,11 @@ public enum Operations { /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/memberships/{username}/delete(teams/remove-membership-for-user-in-org)`. @@ -8990,7 +9131,8 @@ public enum Operations { /// /// Lists the organization projects for a team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/get(teams/list-projects-in-org)`. @@ -9179,7 +9321,8 @@ public enum Operations { /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/get(teams/check-permissions-for-project-in-org)`. @@ -9356,7 +9499,8 @@ public enum Operations { /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/put(teams/add-or-update-project-permissions-in-org)`. @@ -9590,7 +9734,8 @@ public enum Operations { /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/projects/{project_id}/delete(teams/remove-project-in-org)`. @@ -9674,7 +9819,8 @@ public enum Operations { /// /// Lists a team's repositories visible to the authenticated user. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/get(teams/list-repos-in-org)`. @@ -9869,7 +10015,8 @@ public enum Operations { /// /// If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/get(teams/check-permissions-for-repo-in-org)`. @@ -10080,7 +10227,8 @@ public enum Operations { /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". /// @@ -10201,7 +10349,8 @@ public enum Operations { /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}/delete(teams/remove-repo-in-org)`. @@ -10292,7 +10441,8 @@ public enum Operations { /// /// Lists the child teams of the team specified by `{team_slug}`. /// - /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. + /// > [!NOTE] + /// > You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`. /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/teams/get(teams/list-child-in-org)`. @@ -10479,7 +10629,8 @@ public enum Operations { } /// Get a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/get(teams/get-legacy)`. @@ -10634,11 +10785,13 @@ public enum Operations { } /// Update a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/rest/teams/teams#update-a-team) endpoint. /// /// To edit a team, the authenticated user must either be an organization owner or a team maintainer. /// - /// **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. + /// > [!NOTE] + /// > With nested teams, the `privacy` for parent teams cannot be `secret`. /// /// - Remark: HTTP `PATCH /teams/{team_id}`. /// - Remark: Generated from `#/paths//teams/{team_id}/patch(teams/update-legacy)`. @@ -10994,7 +11147,8 @@ public enum Operations { } /// Delete a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) endpoint. /// /// To delete a team, the authenticated user must be an organization owner or team maintainer. /// @@ -11152,7 +11306,8 @@ public enum Operations { } /// List discussions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// /// List all discussions on a team's page. /// @@ -11346,7 +11501,8 @@ public enum Operations { } /// Create a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// /// Creates a new discussion post on a team's page. /// @@ -11528,7 +11684,8 @@ public enum Operations { } /// Get a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// /// Get a specific discussion on a team's page. /// @@ -11673,7 +11830,8 @@ public enum Operations { } /// Update a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// @@ -11854,7 +12012,8 @@ public enum Operations { } /// Delete a discussion (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// /// Delete a discussion from a team's page. /// @@ -11933,7 +12092,8 @@ public enum Operations { } /// List discussion comments (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// /// List all comments on a team discussion. /// @@ -12136,7 +12296,8 @@ public enum Operations { } /// Create a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// /// Creates a new comment on a team discussion. /// @@ -12309,7 +12470,8 @@ public enum Operations { } /// Get a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// /// Get a specific comment on a team discussion. /// @@ -12461,7 +12623,8 @@ public enum Operations { } /// Update a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// /// Edits the body text of a discussion comment. /// @@ -12639,7 +12802,8 @@ public enum Operations { } /// Delete a discussion comment (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// /// Deletes a comment on a team discussion. /// @@ -12725,7 +12889,8 @@ public enum Operations { } /// List pending team invitations (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://docs.github.com/rest/teams/members#list-pending-team-invitations) endpoint. /// /// The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. /// @@ -12905,7 +13070,8 @@ public enum Operations { } /// List team members (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://docs.github.com/rest/teams/members#list-team-members) endpoint. /// /// Team members will include the members of child teams. /// @@ -13235,7 +13401,8 @@ public enum Operations { /// /// To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// @@ -13439,7 +13606,8 @@ public enum Operations { /// /// To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/members/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/members/{username}/delete(teams/remove-member-legacy)`. @@ -13541,7 +13709,8 @@ public enum Operations { } /// Get team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get team membership for a user](https://docs.github.com/rest/teams/members#get-team-membership-for-a-user) endpoint. /// /// Team members will include the members of child teams. /// @@ -13714,13 +13883,15 @@ public enum Operations { } /// Add or update team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. /// @@ -13975,13 +14146,15 @@ public enum Operations { } /// Remove team membership for a user (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove team membership for a user](https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user) endpoint. /// /// Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// /// To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. /// - /// **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." + /// > [!NOTE] + /// > When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." /// /// - Remark: HTTP `DELETE /teams/{team_id}/memberships/{username}`. /// - Remark: Generated from `#/paths//teams/{team_id}/memberships/{username}/delete(teams/remove-membership-for-user-legacy)`. @@ -14083,7 +14256,8 @@ public enum Operations { } /// List team projects (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://docs.github.com/rest/teams/teams#list-team-projects) endpoint. /// /// Lists the organization projects for a team. /// @@ -14286,7 +14460,8 @@ public enum Operations { } /// Check team permissions for a project (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a project](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project) endpoint. /// /// Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. /// @@ -14456,7 +14631,8 @@ public enum Operations { } /// Add or update team project permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions) endpoint. /// /// Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. /// @@ -14729,7 +14905,8 @@ public enum Operations { } /// Remove a project from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a project from a team](https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team) endpoint. /// /// Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. /// @@ -14894,7 +15071,8 @@ public enum Operations { } /// List team repositories (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List team repositories](https://docs.github.com/rest/teams/teams#list-team-repositories) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/repos`. /// - Remark: Generated from `#/paths//teams/{team_id}/repos/get(teams/list-repos-legacy)`. @@ -15095,9 +15273,11 @@ public enum Operations { } /// Check team permissions for a repository (Legacy) /// - /// **Note**: Repositories inherited through a parent team will also be checked. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Check team permissions for a repository](https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository) endpoint. + /// > [!NOTE] + /// > Repositories inherited through a parent team will also be checked. /// /// You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types/) via the `Accept` header: /// @@ -15301,7 +15481,8 @@ public enum Operations { } /// Add or update team repository permissions (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint. /// /// To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. /// @@ -15509,7 +15690,8 @@ public enum Operations { } /// Remove a repository from a team (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Remove a repository from a team](https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team) endpoint. /// /// If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. /// @@ -15593,7 +15775,8 @@ public enum Operations { } /// List child teams (Legacy) /// - /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. + /// > [!WARNING] + /// > **Deprecation notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://docs.github.com/rest/teams/teams#list-child-teams) endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/teams`. /// - Remark: Generated from `#/paths//teams/{team_id}/teams/get(teams/list-child-legacy)`. diff --git a/Submodule/github/rest-api-description b/Submodule/github/rest-api-description index 3e3e13801b9..9272e440b6a 160000 --- a/Submodule/github/rest-api-description +++ b/Submodule/github/rest-api-description @@ -1 +1 @@ -Subproject commit 3e3e13801b9b2cb62958385c2a70b15f2eae4b88 +Subproject commit 9272e440b6a4964e58ddeab80d6011333af3a04f