Skip to content

Commit cd63449

Browse files
dependabot[bot]dependabot[bot]
committed
Commit via running ake Sources/dependabot
1 parent 0b8fe4d commit cd63449

File tree

2 files changed

+244
-136
lines changed

2 files changed

+244
-136
lines changed

‎Sources/dependabot/Client.swift‎

Lines changed: 61 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,13 @@ public struct Client: APIProtocol {
4141
/// List Dependabot alerts for an enterprise
4242
///
4343
/// Lists Dependabot alerts for repositories that are owned by the specified enterprise.
44-
/// To use this endpoint, you must be a member of the enterprise, and you must use an
45-
/// access token with the `repo` scope or `security_events` scope.
44+
///
45+
/// The authenticated user must be a member of the enterprise to use this endpoint.
46+
///
4647
/// Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)."
4748
///
49+
/// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint.
50+
///
4851
/// - Remark: HTTP `GET /enterprises/{enterprise}/dependabot/alerts`.
4952
/// - Remark: Generated from `#/paths//enterprises/{enterprise}/dependabot/alerts/get(dependabot/list-alerts-for-enterprise)`.
5053
public func dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise(_ input: Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise.Input) async throws -> Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise.Output {
@@ -261,11 +264,9 @@ public struct Client: APIProtocol {
261264
///
262265
/// Lists Dependabot alerts for an organization.
263266
///
264-
/// To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
265-
///
266-
/// For public repositories, you may instead use the `public_repo` scope.
267+
/// The authenticated user must be an owner or security manager for the organization to use this endpoint.
267268
///
268-
/// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
269+
/// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
269270
///
270271
/// - Remark: HTTP `GET /orgs/{org}/dependabot/alerts`.
271272
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/alerts/get(dependabot/list-alerts-for-org)`.
@@ -512,7 +513,10 @@ public struct Client: APIProtocol {
512513
}
513514
/// List organization secrets
514515
///
515-
/// Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
516+
/// Lists all secrets available in an organization without revealing their
517+
/// encrypted values.
518+
///
519+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
516520
///
517521
/// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets`.
518522
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/get(dependabot/list-org-secrets)`.
@@ -598,7 +602,10 @@ public struct Client: APIProtocol {
598602
}
599603
/// Get an organization public key
600604
///
601-
/// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
605+
/// Gets your public key, which you need to encrypt secrets. You need to
606+
/// encrypt a secret before you can create or update secrets.
607+
///
608+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
602609
///
603610
/// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/public-key`.
604611
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/public-key/get(dependabot/get-org-public-key)`.
@@ -662,7 +669,9 @@ public struct Client: APIProtocol {
662669
}
663670
/// Get an organization secret
664671
///
665-
/// Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
672+
/// Gets a single organization secret without revealing its encrypted value.
673+
///
674+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
666675
///
667676
/// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}`.
668677
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/get(dependabot/get-org-secret)`.
@@ -730,9 +739,7 @@ public struct Client: APIProtocol {
730739
/// Creates or updates an organization secret with an encrypted value. Encrypt your secret using
731740
/// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
732741
///
733-
/// You must authenticate using an access
734-
/// token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization
735-
/// permission to use this endpoint.
742+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
736743
///
737744
/// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}`.
738745
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-org-secret)`.
@@ -808,7 +815,9 @@ public struct Client: APIProtocol {
808815
}
809816
/// Delete an organization secret
810817
///
811-
/// Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
818+
/// Deletes a secret in an organization using the secret name.
819+
///
820+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
812821
///
813822
/// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}`.
814823
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/delete(dependabot/delete-org-secret)`.
@@ -849,7 +858,10 @@ public struct Client: APIProtocol {
849858
}
850859
/// List selected repositories for an organization secret
851860
///
852-
/// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
861+
/// Lists all repositories that have been selected when the `visibility`
862+
/// for repository access to a secret is set to `selected`.
863+
///
864+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
853865
///
854866
/// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories`.
855867
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/get(dependabot/list-selected-repos-for-org-secret)`.
@@ -928,7 +940,11 @@ public struct Client: APIProtocol {
928940
}
929941
/// Set selected repositories for an organization secret
930942
///
931-
/// Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
943+
/// Replaces all repositories for an organization secret when the `visibility`
944+
/// for repository access is set to `selected`. The visibility is set when you [Create
945+
/// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
946+
///
947+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
932948
///
933949
/// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories`.
934950
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/put(dependabot/set-selected-repos-for-org-secret)`.
@@ -978,7 +994,11 @@ public struct Client: APIProtocol {
978994
}
979995
/// Add selected repository to an organization secret
980996
///
981-
/// Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
997+
/// Adds a repository to an organization secret when the `visibility` for
998+
/// repository access is set to `selected`. The visibility is set when you [Create or
999+
/// update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
1000+
///
1001+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
9821002
///
9831003
/// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`.
9841004
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/put(dependabot/add-selected-repo-to-org-secret)`.
@@ -1022,7 +1042,11 @@ public struct Client: APIProtocol {
10221042
}
10231043
/// Remove selected repository from an organization secret
10241044
///
1025-
/// Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint.
1045+
/// Removes a repository from an organization secret when the `visibility`
1046+
/// for repository access is set to `selected`. The visibility is set when you [Create
1047+
/// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret).
1048+
///
1049+
/// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.
10261050
///
10271051
/// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`.
10281052
/// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/delete(dependabot/remove-selected-repo-from-org-secret)`.
@@ -1066,9 +1090,7 @@ public struct Client: APIProtocol {
10661090
}
10671091
/// List Dependabot alerts for a repository
10681092
///
1069-
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories.
1070-
/// You can also use tokens with the `public_repo` scope for public repositories only.
1071-
/// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
1093+
/// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
10721094
///
10731095
/// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts`.
10741096
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/get(dependabot/list-alerts-for-repo)`.
@@ -1330,9 +1352,7 @@ public struct Client: APIProtocol {
13301352
}
13311353
/// Get a Dependabot alert
13321354
///
1333-
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories.
1334-
/// You can also use tokens with the `public_repo` scope for public repositories only.
1335-
/// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint.
1355+
/// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
13361356
///
13371357
/// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`.
13381358
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/get(dependabot/get-alert)`.
@@ -1444,11 +1464,9 @@ public struct Client: APIProtocol {
14441464
}
14451465
/// Update a Dependabot alert
14461466
///
1447-
/// You must use an access token with the `security_events` scope to use this endpoint with private repositories.
1448-
/// You can also use tokens with the `public_repo` scope for public repositories only.
1449-
/// GitHub Apps must have **Dependabot alerts** write permission to use this endpoint.
1467+
/// The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
14501468
///
1451-
/// To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
1469+
/// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.
14521470
///
14531471
/// - Remark: HTTP `PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`.
14541472
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/patch(dependabot/update-alert)`.
@@ -1642,7 +1660,10 @@ public struct Client: APIProtocol {
16421660
}
16431661
/// List repository secrets
16441662
///
1645-
/// Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
1663+
/// Lists all secrets available in a repository without revealing their encrypted
1664+
/// values.
1665+
///
1666+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
16461667
///
16471668
/// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets`.
16481669
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/get(dependabot/list-repo-secrets)`.
@@ -1729,7 +1750,11 @@ public struct Client: APIProtocol {
17291750
}
17301751
/// Get a repository public key
17311752
///
1732-
/// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
1753+
/// Gets your public key, which you need to encrypt secrets. You need to
1754+
/// encrypt a secret before you can create or update secrets. Anyone with read access
1755+
/// to the repository can use this endpoint.
1756+
///
1757+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private.
17331758
///
17341759
/// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/public-key`.
17351760
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/public-key/get(dependabot/get-repo-public-key)`.
@@ -1794,7 +1819,9 @@ public struct Client: APIProtocol {
17941819
}
17951820
/// Get a repository secret
17961821
///
1797-
/// Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
1822+
/// Gets a single repository secret without revealing its encrypted value.
1823+
///
1824+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
17981825
///
17991826
/// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`.
18001827
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/get(dependabot/get-repo-secret)`.
@@ -1863,9 +1890,7 @@ public struct Client: APIProtocol {
18631890
/// Creates or updates a repository secret with an encrypted value. Encrypt your secret using
18641891
/// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."
18651892
///
1866-
/// You must authenticate using an access
1867-
/// token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository
1868-
/// permission to use this endpoint.
1893+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
18691894
///
18701895
/// - Remark: HTTP `PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`.
18711896
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-repo-secret)`.
@@ -1942,7 +1967,9 @@ public struct Client: APIProtocol {
19421967
}
19431968
/// Delete a repository secret
19441969
///
1945-
/// Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint.
1970+
/// Deletes a secret in a repository using the secret name.
1971+
///
1972+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
19461973
///
19471974
/// - Remark: HTTP `DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`.
19481975
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/delete(dependabot/delete-repo-secret)`.

0 commit comments

Comments
 (0)