Link to article instead of landing page in REST & Apps docs (#48913)

This commit is contained in:
Jess Hosman 2024-02-13 08:58:33 -07:00 коммит произвёл GitHub
Родитель e4ca809d78
Коммит 774479cd7e
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
6 изменённых файлов: 10 добавлений и 11 удалений

Просмотреть файл

@ -34,7 +34,7 @@ To publish apps with free plans, you only need to meet the general requirements
### New to apps?
If you're interested in creating an app for {% data variables.product.prodname_marketplace %}, but you're new to {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, see "[AUTOTITLE](/apps/creating-github-apps)" or "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps)."
If you're interested in creating an app for {% data variables.product.prodname_marketplace %}, but you're new to {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, see "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)" or "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps)."
### {% data variables.product.prodname_github_apps %} vs. {% data variables.product.prodname_oauth_apps %}

Просмотреть файл

@ -174,7 +174,7 @@ You must complete this step of the GitHub App Manifest flow within one hour.
{% note %}
**Note:** This endpoint is rate limited. See [Rate limits](/rest/rate-limit) to learn how to get your current rate limit status.
**Note:** This endpoint is rate limited. See [Rate limits](/rest/rate-limit/rate-limit) to learn how to get your current rate limit status.
{% endnote %}

Просмотреть файл

@ -54,7 +54,7 @@ If you are using the {% data variables.product.prodname_codeql_cli %}, you will
## Generating a token for authentication with {% data variables.product.product_name %}
Each CI server needs a {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} to use to upload results to {% data variables.product.product_name %}, whether you are using the {% data variables.product.prodname_codeql_cli %}, the REST API, or another method. You must use an access token or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. If CI servers already use a token with this scope to checkout repositories from {% data variables.product.product_name %}, you could potentially use the same token. Otherwise, you should create a new token with the `security_events` write permission and add this to the CI system's secret store. For information, see "[AUTOTITLE](/apps/creating-github-apps)" and "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
Each CI server needs a {% data variables.product.prodname_github_app %} or {% data variables.product.pat_generic %} to use to upload results to {% data variables.product.product_name %}, whether you are using the {% data variables.product.prodname_codeql_cli %}, the REST API, or another method. You must use an access token or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. If CI servers already use a token with this scope to checkout repositories from {% data variables.product.product_name %}, you could potentially use the same token. Otherwise, you should create a new token with the `security_events` write permission and add this to the CI system's secret store. For information, see "[AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps)" and "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
For more information on the different methods for uploading results to {% data variables.product.product_name %}, see "[AUTOTITLE](/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)."

Просмотреть файл

@ -19,13 +19,13 @@ autogenerated: rest
You can check your current rate limit status at any time. For more information about rate limit rules, see "[AUTOTITLE](/rest/overview/rate-limits-for-the-rest-api)."
The REST API for searching items has a custom rate limit that is separate from the rate limit governing the other REST API endpoints. For more information, see "[AUTOTITLE](/rest/search)." The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API. For more information, see "[AUTOTITLE](/graphql/overview/resource-limitations#rate-limit)." For these reasons, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
The REST API for searching items has a custom rate limit that is separate from the rate limit governing the other REST API endpoints. For more information, see "[AUTOTITLE](/rest/search/search)." The GraphQL API also has a custom rate limit that is separate from and calculated differently than rate limits in the REST API. For more information, see "[AUTOTITLE](/graphql/overview/resource-limitations#rate-limit)." For these reasons, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories:
- The `core` object provides your rate limit status for all non-search-related resources in the REST API.
- The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[AUTOTITLE](/rest/search)."
- The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[AUTOTITLE](/rest/search/search)."
- The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[AUTOTITLE](/rest/search#search-code)."
- The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[AUTOTITLE](/rest/search/search#search-code)."
- The `graphql` object provides your rate limit status for the GraphQL API.

Просмотреть файл

@ -21,7 +21,7 @@ autogenerated: rest
You can use the REST API to search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the {% data variables.product.product_name %} REST API provides **up to 1,000 results for each search**.
You can narrow your search using queries. To learn more about the search query syntax, see "[AUTOTITLE](/rest/search#constructing-a-search-query)."
You can narrow your search using queries. To learn more about the search query syntax, see "[AUTOTITLE](/rest/search/search#constructing-a-search-query)."
### Ranking search results
@ -32,10 +32,9 @@ Unless another sort option is provided as a query parameter, results are sorted
{% data reusables.enterprise.rate_limit %}
The REST API has a custom rate limit for searching. For authenticated requests, you can make up to
30 requests per minute{% ifversion fpt or ghec %} for all search endpoints except for the "[Search code](/rest/search#search-code)" endpoint. The "[Search code](/rest/search#search-code)" endpoint requires you to authenticate and limits you to 10 requests per minute{% endif %}. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.
30 requests per minute{% ifversion fpt or ghec %} for all search endpoints except for the "[Search code](/rest/search/search#search-code)" endpoint. The "[Search code](/rest/search/search#search-code)" endpoint requires you to authenticate and limits you to 10 requests per minute{% endif %}. For unauthenticated requests, the rate limit allows you to make up to 10 requests per minute.
See the [rate limit documentation](/rest/rate-limit) for details on
determining your current rate limit status.
For information about how to determine your current rate limit status, see "[Rate Limit](/rest/rate-limit/rate-limit)."
### Constructing a search query

Просмотреть файл

@ -18,7 +18,7 @@ topics:
{% ifversion code-search-code-view %}
{% note %}
**Note:** This article covers the syntax for legacy code search, which you should only need to use for the [REST API endpoint for searching code](/rest/search#search-code).
**Note:** This article covers the syntax for legacy code search, which you should only need to use for the [REST API endpoint for searching code](/rest/search/search#search-code).
For information on the code search syntax that you can use on {% data variables.product.prodname_dotcom_the_website %}, see "[AUTOTITLE](/search-github/github-code-search/understanding-github-code-search-syntax)."