jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Combine product name variables for REST and GraphQL API base URLs (#50521)

Browse Source
This commit is contained in:
Laura Coursen
2024-05-10 09:20:12 -05:00
committed by GitHub
parent aef6bc2468
commit e977bce6d8
40 changed files with 99 additions and 107 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
content/rest/guides/scripting-with-the-rest-api-and-javascript.md
View File

@@ -46,7 +46,7 @@ First, import `Octokit` from `octokit`. Then, pass your {% data variables.produc
import { Octokit } from "octokit";
const octokit = new Octokit({ {% ifversion ghes %}
baseUrl: "{% data variables.product.api_url_code %}",{% endif %}
baseUrl: "{% data variables.product.rest_url %}",{% endif %}
auth: 'YOUR-TOKEN',
});
```
@@ -64,7 +64,7 @@ const app = new App({
appId: APP_ID,
privateKey: PRIVATE_KEY,{% ifversion ghes %}
Octokit: Octokit.defaults({
baseUrl: "{% data variables.product.api_url_code %}",
baseUrl: "{% data variables.product.rest_url %}",
}),{% endif %}
});
@@ -95,20 +95,20 @@ The script that the workflow runs uses `process.env.TOKEN` to authenticate:
import { Octokit } from "octokit";
const octokit = new Octokit({ {% ifversion ghes %}
baseUrl: "{% data variables.product.api_url_code %}",{% endif %}
baseUrl: "{% data variables.product.rest_url %}",{% endif %}
auth: process.env.TOKEN,
});
```
### Instantiating without authentication
You can use the REST API without authentication, although you will have a lower rate limit and will not be able to use some endpoints. To create an instance of `Octokit` without authenticating, do not pass the `auth` argument.{% ifversion ghes %} Set the base URL to `{% data variables.product.api_url_code %}`. Replace `[hostname]` with the name of {% data variables.location.product_location %}.{% endif %}
You can use the REST API without authentication, although you will have a lower rate limit and will not be able to use some endpoints. To create an instance of `Octokit` without authenticating, do not pass the `auth` argument.{% ifversion ghes %} Set the base URL to `{% data variables.product.rest_url %}`. Replace `[hostname]` with the name of {% data variables.location.product_location %}.{% endif %}
```javascript copy
import { Octokit } from "octokit";
const octokit = new Octokit({ {% ifversion ghes %}
baseUrl: "{% data variables.product.api_url_code %}",
baseUrl: "{% data variables.product.rest_url %}",
{% endif %}});
```
@@ -364,7 +364,7 @@ The `getChangedFiles` function gets all of the files changed for a pull request.
import { Octokit } from "octokit";
const octokit = new Octokit({ {% ifversion ghes %}
baseUrl: "{% data variables.product.api_url_code %}",{% endif %}
baseUrl: "{% data variables.product.rest_url %}",{% endif %}
auth: 'YOUR-TOKEN',
});