Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9cbd8a3

Browse files
committed
reran script
1 parent f606d47 commit 9cbd8a3

8 files changed

Lines changed: 22 additions & 22 deletions

content/developers/apps/creating-ci-tests-with-the-checks-api.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ versions:
1212

1313
### Introduction
1414

15-
This guide will introduce you to [Github Apps](/apps/) and the [Checks API](/restreference/checks), which you'll use to build a continuous integration (CI) server that runs tests.
15+
This guide will introduce you to [Github Apps](/apps/) and the [Checks API](/rest/reference/checks), which you'll use to build a continuous integration (CI) server that runs tests.
1616

1717
CI is a software practice that requires frequently committing code to a shared repository. Committing code more often raises errors sooner and reduces the amount of code a developer needs to debug when finding the source of an error. Frequent code updates also make it easier to merge changes from different members of a software development team. This is great for developers, who can spend more time writing code and less time debugging errors or resolving merge conflicts. 🙌
1818

@@ -49,7 +49,7 @@ To get an idea of what your Checks API CI server will do when you've completed t
4949

5050
### Prerequisites
5151

52-
Before you get started, you may want to familiarize yourself with [Github Apps](/apps/), [Webhooks](/webhooks), and the [Checks API](/rest/reference/checks), if you're not already. You'll find more APIs in the [REST API docs](/rest/). The Checks API is also available to use in [GraphQL](/graphql), but this quickstart focuses on REST. See the GraphQL [Checks Suite](/graphql/reference/objects#checksuite) and [Check Run](/graphql/reference/objects#checkrun) objects for more details.
52+
Before you get started, you may want to familiarize yourself with [Github Apps](/apps/), [Webhooks](/webhooks), and the [Checks API](/rest/reference/checks), if you're not already. You'll find more APIs in the [REST API docs](/rest). The Checks API is also available to use in [GraphQL](/graphql), but this quickstart focuses on REST. See the GraphQL [Checks Suite](/graphql/reference/objects#checksuite) and [Check Run](/graphql/reference/objects#checkrun) objects for more details.
5353

5454
You'll use the [Ruby programming language](https://www.ruby-lang.org/en/), the [Smee](https://smee.io/) webhook payload delivery service, the [Octokit.rb Ruby library](http://octokit.github.io/octokit.rb/) for the GitHub REST API, and the [Sinatra web framework](http://sinatrarb.com/) to create your Checks API CI server app.
5555

@@ -140,7 +140,7 @@ You'll add this new method as a [Sinatra helper](https://github.com/sinatra/sina
140140
def create_check_run
141141
# # At the time of writing, Octokit does not support the Checks API yet, but
142142
# it does provide generic HTTP methods you can use:
143-
# /rest/reference/checks#create-a-check-run
143+
# /v3/checks/runs/#create-a-check-run
144144
check_run = @installation_client.post(
145145
"repos/#{@payload['repository']['full_name']}/check-runs",
146146
{
@@ -159,7 +159,7 @@ end
159159
def create_check_run
160160
# # At the time of writing, Octokit does not support the Checks API yet, but
161161
# it does provide generic HTTP methods you can use:
162-
# /rest/reference/checks#create-a-check-run
162+
# /v3/checks/runs/#create-a-check-run
163163
check_run = @installation_client.post(
164164
"repos/#{@payload['repository']['full_name']}/check-runs",
165165
{
@@ -175,7 +175,7 @@ end
175175
```
176176
{% endif %}
177177

178-
This code calls the "[Create a check run](/v3/checks/runs/#create-a-check-run)" endpoint using the generic [HTTP `POST` method](http://octokit.github.io/octokit.rb/Octokit/Connection.html#post-instance_method). This method takes two parameters: the URL of the endpoint and the input parameters to the method.
178+
This code calls the "[Create a check run](/rest/reference/checks#create-a-check-run)" endpoint using the generic [HTTP `POST` method](http://octokit.github.io/octokit.rb/Octokit/Connection.html#post-instance_method). This method takes two parameters: the URL of the endpoint and the input parameters to the method.
179179

180180
To create a check run, only two input parameters are required: `name` and `head_sha`. We will use [Rubocop](https://rubocop.readthedocs.io/en/latest/) to implement the CI test later in this quickstart, which is why the name "Octo Rubocop" is used here, but you can choose any name you'd like for the check run.
181181

@@ -240,7 +240,7 @@ def initiate_check_run
240240

241241
# Octokit doesn't yet support the Checks API, but it does provide generic
242242
# HTTP methods you can use:
243-
# /rest/reference/checks#update-a-check-run
243+
# /v3/checks/runs/#update-a-check-run
244244
updated_check_run = @installation_client.patch(
245245
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}",
246246
{
@@ -276,7 +276,7 @@ def initiate_check_run
276276

277277
# Octokit doesn't yet support the Checks API, but it does provide generic
278278
# HTTP methods you can use:
279-
# /rest/reference/checks#update-a-check-run
279+
# /v3/checks/runs/#update-a-check-run
280280
updated_check_run = @installation_client.patch(
281281
"repos/#{@payload['repository']['full_name']}/check-runs/#{@payload['check_run']['id']}",
282282
{
@@ -435,7 +435,7 @@ The code above gets the full repository name and the head SHA of the commit from
435435

436436
### Step 2.3. Running RuboCop
437437

438-
Great! You're cloning the repository and creating check runs using your CI server. Now you'll get into the nitty gritty details of the [RuboCop linter](https://rubocop.readthedocs.io/en/latest/basic_usage/#rubocop-as-a-code-style-checker) and [Checks API annotations](/v3/checks/runs/#create-a-check-run).
438+
Great! You're cloning the repository and creating check runs using your CI server. Now you'll get into the nitty gritty details of the [RuboCop linter](https://rubocop.readthedocs.io/en/latest/basic_usage/#rubocop-as-a-code-style-checker) and [Checks API annotations](/rest/reference/checks#create-a-check-run).
439439

440440
The following code runs RuboCop and saves the style code errors in JSON format. Add this code below the call to `clone_repository` you added in the [previous step](#step-22-cloning-the-repository) and above the code that updates the check run to complete.
441441

@@ -525,7 +525,7 @@ The `@output` variable contains the parsed JSON results of the RuboCop report. A
525525

526526
The Checks API allows you to create annotations for specific lines of code. When you create or update a check run, you can add annotations. In this quickstart you are [updating the check run](/rest/reference/checks#update-a-check-run) with annotations.
527527

528-
The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](/v3/checks/runs/#update-a-check-run) endpoint. For example, to create 105 annotations you'd need to call the [Update a check run](/v3/checks/runs/#update-a-check-run) endpoint three times. The first two requests would each have 50 annotations, and the third request would include the five remaining annotations. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run.
528+
The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](/rest/reference/checks#update-a-check-run) endpoint. For example, to create 105 annotations you'd need to call the [Update a check run](/rest/reference/checks#update-a-check-run) endpoint three times. The first two requests would each have 50 annotations, and the third request would include the five remaining annotations. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run.
529529

530530
A check run expects annotations as an array of objects. Each annotation object must include the `path`, `start_line`, `end_line`, `annotation_level`, and `message`. RuboCop provides the `start_column` and `end_column` too, so you can include those optional parameters in the annotation. Annotations only support `start_column` and `end_column` on the same line. See the [`annotations` object](/rest/reference/checks#annotations-object-1) reference documentation for details.
531531

content/developers/apps/identifying-and-authorizing-users-for-github-apps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ You can also check which repositories are accessible to a user for an installati
154154
Authorization: token OAUTH-TOKEN
155155
GET /user/installations/:installation_id/repositories
156156

157-
More details can be found in: [List app installations accessible to the user access token](/restreference/apps#list-app-installations-accessible-to-the-user-access-token) and [List repositories accessible to the user access token](/rest/reference/apps#list-repositories-accessible-to-the-user-access-token).
157+
More details can be found in: [List app installations accessible to the user access token](/rest/reference/apps#list-app-installations-accessible-to-the-user-access-token) and [List repositories accessible to the user access token](/rest/reference/apps#list-repositories-accessible-to-the-user-access-token).
158158

159159
### Handling a revoked GitHub App authorization
160160

@@ -172,7 +172,7 @@ Because user-level permissions are granted on an individual user basis, you can
172172

173173
### User-to-server requests
174174

175-
While most of your API interaction should occur using your server-to-server installation access tokens, certain endpoints allow you to perform actions via the API using a user access token. Your app can make the following requests using [GraphQL v4](/graphql) or [REST v3](/rest/) endpoints.
175+
While most of your API interaction should occur using your server-to-server installation access tokens, certain endpoints allow you to perform actions via the API using a user access token. Your app can make the following requests using [GraphQL v4](/graphql) or [REST v3](/rest) endpoints.
176176

177177
#### Supported endpoints
178178

content/developers/apps/migrating-oauth-apps-to-github-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This article provides guidelines for existing integrators who are considering mi
2323
- Built-in support for OAuth is still available to GitHub Apps using [user-to-server endpoints](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/).
2424
- Dedicated [API rate limits](/apps/building-github-apps/understanding-rate-limits-for-github-apps/) for bot accounts scale with your integration.
2525
- Repository owners can [install GitHub Apps](/apps/differences-between-apps/#who-can-install-github-apps-and-authorize-oauth-apps) on organization repositories. If a GitHub App's configuration has permissions that request an organization's resources, the org owner must approve the installation.
26-
- Open Source community support is available through [Octokit libraries](/restoverview/libraries) and other frameworks such as [Probot](https://probot.github.io/).
26+
- Open Source community support is available through [Octokit libraries](/rest/overview/libraries) and other frameworks such as [Probot](https://probot.github.io/).
2727
- Integrators building GitHub Apps have opportunities to adopt earlier access to APIs.
2828

2929
### Converting an OAuth App to a GitHub App

content/graphql/guides/managing-enterprise-accounts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ With the Audit Log API, you can monitor when someone:
2424
- Promotes users to admin.
2525
- Changes permissions of a GitHub App.
2626

27-
The Audit Log API enables you to keep copies of your audit log data. For queries made with the Audit Log API, the GraphQL response can include data for up to 90 to 120 days. For a list of the fields available with the Audit Log API, see the "[AuditEntry interface](/graphqlreference/interfaces#auditentry/)."
27+
The Audit Log API enables you to keep copies of your audit log data. For queries made with the Audit Log API, the GraphQL response can include data for up to 90 to 120 days. For a list of the fields available with the Audit Log API, see the "[AuditEntry interface](/graphql/reference/interfaces#auditentry/)."
2828

2929
With the Enterprise Accounts API, you can:
3030
- List and review all of the organizations and repositories that belong to your enterprise account.
@@ -33,7 +33,7 @@ With the Enterprise Accounts API, you can:
3333
- Invite administrators to your enterprise account.
3434
- Create new organizations in your enterprise account.
3535

36-
For a list of the fields available with the Enterprise Accounts API, see "[GraphQL fields and types for the Enterprise account API](/graphql/guidesmanaging-enterprise-accounts#graphql-fields-and-types-for-the-enterprise-accounts-api)."
36+
For a list of the fields available with the Enterprise Accounts API, see "[GraphQL fields and types for the Enterprise account API](/graphql/guides/managing-enterprise-accounts#graphql-fields-and-types-for-the-enterprise-accounts-api)."
3737

3838
### Getting started using GraphQL for enterprise accounts
3939

@@ -205,7 +205,7 @@ For more information about getting started with GraphQL, see "[Introduction to G
205205

206206
Here's an overview of the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API.
207207

208-
For more details about the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API, see the sidebar with detailed GraphQL definitions from any [GraphQL reference page](/graphql/).
208+
For more details about the new queries, mutations, and schema defined types available for use with the Enterprise Accounts API, see the sidebar with detailed GraphQL definitions from any [GraphQL reference page](/graphql).
209209

210210
You can access the reference docs from within the GraphQL explorer on GitHub. For more information, see "[Using the explorer](/graphql/guides/using-the-explorer#accessing-the-sidebar-docs)."
211211
For other information, such as authentication and rate limit details, check out the [guides](/graphql/guides).

content/graphql/guides/using-the-explorer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ versions:
1313

1414
{% if currentVersion == "free-pro-team@latest" %}
1515

16-
[GraphQL Explorer](/graphqloverview/explorer) is an instance of [GraphiQL](https://github.com/graphql/graphiql), which is a "graphical interactive in-browser GraphQL IDE."
16+
[GraphQL Explorer](/graphql/overview/explorer) is an instance of [GraphiQL](https://github.com/graphql/graphiql), which is a "graphical interactive in-browser GraphQL IDE."
1717

1818
{% note %}
1919

@@ -67,7 +67,7 @@ All types in a GraphQL schema include a `description` field compiled into docume
6767

6868
{% note %}
6969

70-
The **Docs** sidebar contains the same content that is automatically generated from the schema under "[Reference](/graphql/)," though it is formatted differently in places.
70+
The **Docs** sidebar contains the same content that is automatically generated from the schema under "[Reference](/graphql)," though it is formatted differently in places.
7171

7272
{% endnote %}
7373

content/graphql/overview/about-the-graphql-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ versions:
1111

1212
Here are some quick links to get you up and running with the GraphQL API v4:
1313

14-
* [Authentication](/graphql/guidesforming-calls-with-graphql#authenticating-with-graphql)
14+
* [Authentication](/graphql/guides/forming-calls-with-graphql#authenticating-with-graphql)
1515
* [Root endpoint](/graphql/guides/forming-calls-with-graphql#the-graphql-endpoint)
1616
* [Schema introspection](/graphql/guides/introduction-to-graphql#discovering-the-graphql-api)
1717
* [Rate limits](/graphql/overview/resource-limitations)

content/graphql/overview/resource-limitations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ versions:
1111

1212
## Node limit
1313

14-
To pass [schema](/graphqlguides/introduction-to-graphql#schema) validation, all GraphQL API v4 [calls](/graphql/guides/forming-calls-with-graphql) must meet these standards:
14+
To pass [schema](/graphql/guides/introduction-to-graphql#schema) validation, all GraphQL API v4 [calls](/graphql/guides/forming-calls-with-graphql) must meet these standards:
1515

1616
* Clients must supply a `first` or `last` argument on any [connection](/graphql/guides/introduction-to-graphql#connection).
1717
* Values of `first` and `last` must be within 1-100.
@@ -129,7 +129,7 @@ These two examples show how to calculate the total nodes in a call.
129129

130130
The GraphQL API v4 limit is different from the REST API v3's [rate limits](/rest/overview/resources-in-the-rest-api#rate-limiting).
131131

132-
Why are the API rate limits different? With [GraphQL](/graphql/), one GraphQL call can replace [multiple REST calls](/graphql/guides/migrating-from-rest-to-graphql). A single complex GraphQL call could be the equivalent of thousands of REST requests. While a single GraphQL call would fall well below the REST API rate limit, the query might be just as expensive for GitHub's servers to compute.
132+
Why are the API rate limits different? With [GraphQL](/graphql), one GraphQL call can replace [multiple REST calls](/graphql/guides/migrating-from-rest-to-graphql). A single complex GraphQL call could be the equivalent of thousands of REST requests. While a single GraphQL call would fall well below the REST API rate limit, the query might be just as expensive for GitHub's servers to compute.
133133

134134
To accurately represent the server cost of a query, the GraphQL API v4 calculates a call's **rate limit score** based on a normalized scale of points. A query's score factors in first and last arguments on a parent connection and its children.
135135

content/rest/reference/rate-limit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The REST API overview documentation describes the [rate limit rules](/rest/overv
1313

1414
### Understanding your rate limit status
1515

16-
The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](/graphqloverview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API.
16+
The Search API has a [custom rate limit](/rest/reference/search#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](/graphql/overview/resource-limitations#rate-limit) that is separate from and calculated differently than rate limits in the REST API.
1717

1818
For these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four
1919
objects:
@@ -22,7 +22,7 @@ objects:
2222

2323
* The `search` object provides your rate limit status for the [Search API](/rest/reference/search).
2424

25-
* The `graphql` object provides your rate limit status for the [GraphQL API](/graphql/).
25+
* The `graphql` object provides your rate limit status for the [GraphQL API](/graphql).
2626

2727
* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint.
2828

0 commit comments

Comments
 (0)