diff --git a/.github/workflows/default.yml b/.github/workflows/default.yml index 7ab92a8..104c0ec 100644 --- a/.github/workflows/default.yml +++ b/.github/workflows/default.yml @@ -91,7 +91,7 @@ jobs: command: test args: --features isahc,mercy,squirrel-girl,inertia,starfox,mock --target x86_64-unknown-linux-gnu - - name: Run cargo test ureq + - name: Run cargo test reqwest uses: actions-rs/cargo@v1 with: command: test diff --git a/Cargo.lock b/Cargo.lock index a13b81f..e7e411f 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -914,7 +914,7 @@ dependencies = [ [[package]] name = "roctogen" -version = "0.8.0" +version = "0.10.0" dependencies = [ "base64", "cfg-if 0.1.10", diff --git a/Cargo.toml b/Cargo.toml index 095b7d4..d82c7ad 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "roctogen" -version = "0.9.0" +version = "0.10.0" authors = [ "Roctogen contributors" ] description = "Github API and models generated from the official swagger OpenAPI specification" license = "Apache-2.0" diff --git a/src/endpoints/issues.rs b/src/endpoints/issues.rs index b744f2b..67ca5d8 100644 --- a/src/endpoints/issues.rs +++ b/src/endpoints/issues.rs @@ -2366,7 +2366,7 @@ impl<'api> Issues<'api> { /// /// Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create](https://docs.github.com/rest/reference/issues#create-an-issue) /// @@ -2411,7 +2411,7 @@ impl<'api> Issues<'api> { /// /// Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create](https://docs.github.com/rest/reference/issues#create-an-issue) /// @@ -2455,7 +2455,7 @@ impl<'api> Issues<'api> { /// /// # Create an issue comment /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment) /// @@ -2497,7 +2497,7 @@ impl<'api> Issues<'api> { /// /// # Create an issue comment /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment) /// diff --git a/src/endpoints/migrations.rs b/src/endpoints/migrations.rs index 273e604..9dae9d6 100644 --- a/src/endpoints/migrations.rs +++ b/src/endpoints/migrations.rs @@ -1303,7 +1303,7 @@ impl<'api> Migrations<'api> { /// If there are problems, you will see one of these in the `status` field: /// /// * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. - /// * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + /// * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=rest-api) for more information. /// * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. /// * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. /// * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. @@ -1375,7 +1375,7 @@ impl<'api> Migrations<'api> { /// If there are problems, you will see one of these in the `status` field: /// /// * `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. - /// * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information. + /// * `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=rest-api) for more information. /// * `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. /// * `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/reference/migrations#cancel-an-import) and [retry](https://docs.github.com/rest/reference/migrations#start-an-import) with the correct URL. /// * `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/reference/migrations#update-an-import) section. diff --git a/src/endpoints/orgs.rs b/src/endpoints/orgs.rs index 6f09ad0..47371c6 100644 --- a/src/endpoints/orgs.rs +++ b/src/endpoints/orgs.rs @@ -2078,7 +2078,7 @@ impl<'api> Orgs<'api> { /// /// Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_invitation](https://docs.github.com/rest/reference/orgs#create-an-organization-invitation) /// @@ -2120,7 +2120,7 @@ impl<'api> Orgs<'api> { /// /// Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_invitation](https://docs.github.com/rest/reference/orgs#create-an-organization-invitation) /// diff --git a/src/endpoints/packages.rs b/src/endpoints/packages.rs index 79157a6..77634f7 100644 --- a/src/endpoints/packages.rs +++ b/src/endpoints/packages.rs @@ -541,7 +541,7 @@ impl<'api> Packages<'api> { /// /// Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scope. + /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. /// If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for delete_package_for_authenticated_user](https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user) @@ -585,7 +585,7 @@ impl<'api> Packages<'api> { /// /// Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scope. + /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:delete` scopes. /// If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for delete_package_for_authenticated_user](https://docs.github.com/rest/reference/packages#delete-a-package-for-the-authenticated-user) @@ -630,7 +630,7 @@ impl<'api> Packages<'api> { /// /// Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. /// @@ -675,7 +675,7 @@ impl<'api> Packages<'api> { /// /// Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. /// @@ -721,7 +721,7 @@ impl<'api> Packages<'api> { /// /// Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. /// If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for delete_package_version_for_authenticated_user](https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user) @@ -765,7 +765,7 @@ impl<'api> Packages<'api> { /// /// Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. /// If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for delete_package_version_for_authenticated_user](https://docs.github.com/rest/reference/packages#delete-a-package-version-for-the-authenticated-user) @@ -810,7 +810,7 @@ impl<'api> Packages<'api> { /// /// Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. /// @@ -855,7 +855,7 @@ impl<'api> Packages<'api> { /// /// Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:delete` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container you want to delete. /// @@ -1688,7 +1688,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for restore_package_for_authenticated_user](https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user) /// @@ -1739,7 +1739,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for restore_package_for_authenticated_user](https://docs.github.com/rest/reference/packages#restore-a-package-for-the-authenticated-user) /// @@ -1792,7 +1792,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. /// @@ -1845,7 +1845,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. /// @@ -1900,7 +1900,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for restore_package_version_for_authenticated_user](https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user) /// @@ -1947,7 +1947,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scope. If `package_type` is not `container`, your token must also include the `repo` scope. + /// To use this endpoint, you must authenticate using an access token with the `packages:read` and `packages:write` scopes. If `package_type` is not `container`, your token must also include the `repo` scope. /// /// [GitHub API docs for restore_package_version_for_authenticated_user](https://docs.github.com/rest/reference/packages#restore-a-package-version-for-the-authenticated-user) /// @@ -1995,7 +1995,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. /// @@ -2044,7 +2044,7 @@ impl<'api> Packages<'api> { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scope. In addition: + /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `packages:read` and `packages:write` scopes. In addition: /// - If `package_type` is not `container`, your token must also include the `repo` scope. /// - If `package_type` is `container`, you must also have admin permissions to the container that you want to restore. /// diff --git a/src/endpoints/pulls.rs b/src/endpoints/pulls.rs index ad5e3db..bed243f 100644 --- a/src/endpoints/pulls.rs +++ b/src/endpoints/pulls.rs @@ -1153,7 +1153,7 @@ impl<'api> Pulls<'api> { /// /// You can create a new pull request. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. /// /// [GitHub API docs for create](https://docs.github.com/rest/reference/pulls#create-a-pull-request) /// @@ -1199,7 +1199,7 @@ impl<'api> Pulls<'api> { /// /// You can create a new pull request. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. /// /// [GitHub API docs for create](https://docs.github.com/rest/reference/pulls#create-a-pull-request) /// @@ -1242,7 +1242,7 @@ impl<'api> Pulls<'api> { /// /// Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_reply_for_review_comment](https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment) /// @@ -1283,7 +1283,7 @@ impl<'api> Pulls<'api> { /// /// Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_reply_for_review_comment](https://docs.github.com/rest/reference/pulls#create-a-reply-for-a-review-comment) /// @@ -1323,7 +1323,7 @@ impl<'api> Pulls<'api> { /// /// # Create a review for a pull request /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. /// @@ -1369,7 +1369,7 @@ impl<'api> Pulls<'api> { /// /// # Create a review for a pull request /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// Pull request reviews created in the `PENDING` state do not include the `submitted_at` property in the response. /// @@ -1423,7 +1423,7 @@ impl<'api> Pulls<'api> { /// /// **Note:** 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. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_review_comment](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request) /// @@ -1473,7 +1473,7 @@ impl<'api> Pulls<'api> { /// /// **Note:** 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. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_review_comment](https://docs.github.com/rest/reference/pulls#create-a-review-comment-for-a-pull-request) /// @@ -2743,7 +2743,7 @@ impl<'api> Pulls<'api> { /// /// # Merge a pull request /// - /// 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for merge](https://docs.github.com/rest/reference/pulls#merge-a-pull-request) /// @@ -2786,7 +2786,7 @@ impl<'api> Pulls<'api> { /// /// # Merge a pull request /// - /// 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for merge](https://docs.github.com/rest/reference/pulls#merge-a-pull-request) /// @@ -2905,7 +2905,7 @@ impl<'api> Pulls<'api> { /// /// # Request reviewers for a pull request /// - /// 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for request_reviewers](https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request) /// @@ -2945,7 +2945,7 @@ impl<'api> Pulls<'api> { /// /// # Request reviewers for a pull request /// - /// 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 abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-abuse-rate-limits)" for details. + /// 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. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for request_reviewers](https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request) /// diff --git a/src/endpoints/repos.rs b/src/endpoints/repos.rs index 0b0dfb8..183eca0 100644 --- a/src/endpoints/repos.rs +++ b/src/endpoints/repos.rs @@ -4982,7 +4982,7 @@ impl<'api> Repos<'api> { /// /// # Add a repository collaborator /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". /// @@ -4992,7 +4992,7 @@ impl<'api> Repos<'api> { /// /// **Rate limits** /// - /// To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + /// You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. /// /// [GitHub API docs for add_collaborator](https://docs.github.com/rest/reference/repos#add-a-repository-collaborator) /// @@ -5033,7 +5033,7 @@ impl<'api> Repos<'api> { /// /// # Add a repository collaborator /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// For more information the permission levels, see "[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)". /// @@ -5043,7 +5043,7 @@ impl<'api> Repos<'api> { /// /// **Rate limits** /// - /// To prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. + /// You are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository. /// /// [GitHub API docs for add_collaborator](https://docs.github.com/rest/reference/repos#add-a-repository-collaborator) /// @@ -5767,7 +5767,7 @@ impl<'api> Repos<'api> { /// /// Create a comment for a commit using its `:commit_sha`. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_commit_comment](https://docs.github.com/rest/reference/repos#create-a-commit-comment) /// @@ -5809,7 +5809,7 @@ impl<'api> Repos<'api> { /// /// Create a comment for a commit using its `:commit_sha`. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_commit_comment](https://docs.github.com/rest/reference/repos#create-a-commit-comment) /// @@ -6581,7 +6581,7 @@ impl<'api> Repos<'api> { /// /// 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) or [GitHub Premium Support](https://premium.githubsupport.com). + /// **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=rest-api). /// /// [GitHub API docs for create_fork](https://docs.github.com/rest/reference/repos#create-a-fork) /// @@ -6625,7 +6625,7 @@ impl<'api> Repos<'api> { /// /// 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) or [GitHub Premium Support](https://premium.githubsupport.com). + /// **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=rest-api). /// /// [GitHub API docs for create_fork](https://docs.github.com/rest/reference/repos#create-a-fork) /// @@ -7040,7 +7040,7 @@ impl<'api> Repos<'api> { /// /// Users with push access to the repository can create a release. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_release](https://docs.github.com/rest/reference/repos#create-a-release) /// @@ -7082,7 +7082,7 @@ impl<'api> Repos<'api> { /// /// Users with push access to the repository can create a release. /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_release](https://docs.github.com/rest/reference/repos#create-a-release) /// @@ -18494,7 +18494,7 @@ impl<'api> Repos<'api> { /// /// **Notes:** /// * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" - /// endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + /// endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=rest-api). /// * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. /// /// [GitHub API docs for upload_release_asset](https://docs.github.com/rest/reference/repos#upload-a-release-asset) @@ -18551,7 +18551,7 @@ impl<'api> Repos<'api> { /// /// **Notes:** /// * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://docs.github.com/rest/reference/repos#list-assets-for-a-release)" - /// endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact). + /// endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://support.github.com/contact?tags=rest-api). /// * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. /// /// [GitHub API docs for upload_release_asset](https://docs.github.com/rest/reference/repos#upload-a-release-asset) diff --git a/src/endpoints/secret_scanning.rs b/src/endpoints/secret_scanning.rs index 11724ae..b99cdc9 100644 --- a/src/endpoints/secret_scanning.rs +++ b/src/endpoints/secret_scanning.rs @@ -102,7 +102,7 @@ pub enum SecretScanningUpdateAlertError { pub struct SecretScanningListAlertsForRepoParams<'req> { /// Set to `open` or `resolved` to only list secret scanning alerts in a specific state. state: Option<&'req str>, - /// A comma separated list of secret types to return. By default all secret types are returned. + /// A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug). secret_type: Option<&'req str>, /// Page number of the results to fetch. page: Option, @@ -125,7 +125,7 @@ impl<'req> SecretScanningListAlertsForRepoParams<'req> { } } - /// A comma separated list of secret types to return. By default all secret types are returned. + /// A comma separated list of secret types to return. By default all secret types are returned. See \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\" for a complete list of secret types (API slug). pub fn secret_type(self, secret_type: &'req str) -> Self { Self { state: self.state, diff --git a/src/endpoints/teams.rs b/src/endpoints/teams.rs index 23f0253..f109277 100644 --- a/src/endpoints/teams.rs +++ b/src/endpoints/teams.rs @@ -3142,7 +3142,7 @@ impl<'api> Teams<'api> { /// /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// **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`. /// @@ -3187,7 +3187,7 @@ impl<'api> Teams<'api> { /// /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// **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`. /// @@ -3235,7 +3235,7 @@ impl<'api> Teams<'api> { /// /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_discussion_comment_legacy](https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy) /// @@ -3280,7 +3280,7 @@ impl<'api> Teams<'api> { /// /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_discussion_comment_legacy](https://docs.github.com/rest/reference/teams#create-a-discussion-comment-legacy) /// @@ -3324,7 +3324,7 @@ impl<'api> Teams<'api> { /// /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// @@ -3369,7 +3369,7 @@ impl<'api> Teams<'api> { /// /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// @@ -3417,7 +3417,7 @@ impl<'api> Teams<'api> { /// /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_discussion_legacy](https://docs.github.com/rest/reference/teams#create-a-discussion-legacy) /// @@ -3462,7 +3462,7 @@ impl<'api> Teams<'api> { /// /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). /// - /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)" for details. + /// This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See "[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)" and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. /// /// [GitHub API docs for create_discussion_legacy](https://docs.github.com/rest/reference/teams#create-a-discussion-legacy) /// diff --git a/src/lib.rs b/src/lib.rs index a538617..36a4a30 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -19,7 +19,7 @@ //! //! ```nocompile //! [dependencies] -//! roctogen = "0.9" +//! roctogen = "0.10" //! ``` //! //! # API diff --git a/src/models.rs b/src/models.rs index ad14c18..0a05477 100644 --- a/src/models.rs +++ b/src/models.rs @@ -1395,6 +1395,9 @@ pub struct AllOffullRepositoryTemplateRepository { /// Whether to allow squash merges for pull requests. #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, + /// Whether to allow Auto-merge to be used on pull requests. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Whether to delete head branches when pull requests are merged #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -2656,53 +2659,6 @@ pub struct AllOfmilestoneCreator { pub starred_at: Option, } -#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)] -pub struct AllOfminimalRepositoryOwner { - #[serde(skip_serializing_if="Option::is_none")] - pub name: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub email: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub login: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub id: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub node_id: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub avatar_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub gravatar_id: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub html_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub followers_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub following_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub gists_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub starred_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub subscriptions_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub organizations_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub repos_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub events_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub received_events_url: Option, - #[serde(rename = "type")] - #[serde(skip_serializing_if="Option::is_none")] - pub _type: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub site_admin: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub starred_at: Option, -} - #[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)] pub struct AllOfminimalRepositoryTemplateRepository { /// Unique identifier of the repository @@ -2879,6 +2835,9 @@ pub struct AllOfminimalRepositoryTemplateRepository { /// Whether to allow squash merges for pull requests. #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, + /// Whether to allow Auto-merge to be used on pull requests. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Whether to delete head branches when pull requests are merged #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -4088,53 +4047,6 @@ pub struct AllOfrepositoryOrganization { pub starred_at: Option, } -#[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)] -pub struct AllOfrepositoryOwner { - #[serde(skip_serializing_if="Option::is_none")] - pub name: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub email: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub login: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub id: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub node_id: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub avatar_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub gravatar_id: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub html_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub followers_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub following_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub gists_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub starred_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub subscriptions_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub organizations_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub repos_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub events_url: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub received_events_url: Option, - #[serde(rename = "type")] - #[serde(skip_serializing_if="Option::is_none")] - pub _type: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub site_admin: Option, - #[serde(skip_serializing_if="Option::is_none")] - pub starred_at: Option, -} - #[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)] pub struct AllOfreviewCommentUser { #[serde(skip_serializing_if="Option::is_none")] @@ -4632,6 +4544,9 @@ pub struct AllOfteamRepositoryTemplateRepository { /// Whether to allow squash merges for pull requests. #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, + /// Whether to allow Auto-merge to be used on pull requests. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Whether to delete head branches when pull requests are merged #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -6717,6 +6632,9 @@ pub struct PostReposCreateForAuthenticatedUser { /// Whether to allow rebase merges for pull requests. #[serde(skip_serializing_if="Option::is_none")] pub allow_rebase_merge: Option, + /// Whether to allow Auto-merge to be used on pull requests. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Whether to delete head branches when pull requests are merged #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -7063,6 +6981,9 @@ pub struct PostReposCreateInOrg { /// Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. #[serde(skip_serializing_if="Option::is_none")] pub allow_rebase_merge: Option, + /// Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -7341,6 +7262,9 @@ pub struct PatchReposUpdate { /// Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. #[serde(skip_serializing_if="Option::is_none")] pub allow_rebase_merge: Option, + /// Either `true` to allow auto-merge on pull requests, or `false` to disallow auto-merge. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion. #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -10425,6 +10349,8 @@ pub struct FullRepository { #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, + #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, #[serde(skip_serializing_if="Option::is_none")] pub allow_merge_commit: Option, @@ -13093,7 +13019,7 @@ pub struct MinimalRepository { #[serde(skip_serializing_if="Option::is_none")] pub full_name: Option, #[serde(skip_serializing_if="Option::is_none")] - pub owner: Option, + pub owner: Option, #[serde(skip_serializing_if="Option::is_none")] pub private: Option, #[serde(skip_serializing_if="Option::is_none")] @@ -15879,6 +15805,8 @@ pub struct RepoSearchResultItem { #[serde(skip_serializing_if="Option::is_none")] pub allow_rebase_merge: Option, #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, + #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, } @@ -15904,7 +15832,7 @@ pub struct Repository { #[serde(skip_serializing_if="Option::is_none")] pub permissions: Option, #[serde(skip_serializing_if="Option::is_none")] - pub owner: Option, + pub owner: Option, /// Whether the repository is private or public. #[serde(skip_serializing_if="Option::is_none")] pub private: Option, @@ -16059,6 +15987,9 @@ pub struct Repository { /// Whether to allow squash merges for pull requests. #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, + /// Whether to allow Auto-merge to be used on pull requests. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Whether to delete head branches when pull requests are merged #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, @@ -16305,6 +16236,8 @@ pub struct RepositoryTemplateRepository { #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, + #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, #[serde(skip_serializing_if="Option::is_none")] pub allow_merge_commit: Option, @@ -18174,6 +18107,9 @@ pub struct TeamRepository { /// Whether to allow squash merges for pull requests. #[serde(skip_serializing_if="Option::is_none")] pub allow_squash_merge: Option, + /// Whether to allow Auto-merge to be used on pull requests. + #[serde(skip_serializing_if="Option::is_none")] + pub allow_auto_merge: Option, /// Whether to delete head branches when pull requests are merged #[serde(skip_serializing_if="Option::is_none")] pub delete_branch_on_merge: Option, diff --git a/templates/lib.mustache b/templates/lib.mustache index 6f4161e..70b335a 100644 --- a/templates/lib.mustache +++ b/templates/lib.mustache @@ -19,7 +19,7 @@ //! //! ```nocompile //! [dependencies] -//! roctogen = "0.9" +//! roctogen = "0.10" //! ``` //! //! # API