Skip to content

Commit af6c17d

Browse files
authored
Merge pull request #2706 from buildkite/quick-docs-fixes
Minor wording tweaks to REST API authentication section.
2 parents b9fec9b + 06517d4 commit af6c17d

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

pages/apis/rest_api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,16 +48,16 @@ The data encoding is assumed to be `application/json`. Unless explicitly stated
4848

4949
You can authenticate with the Buildkite API using access tokens, represented by the value `$TOKEN` throughout this documentation.
5050

51-
API access tokens allow to call the API without using your username and password. They can be created on your <a href="<%= url_helpers.user_access_tokens_url %>" rel="nofollow">API access tokens</a> page, limited to individual organizations and permissions, and revoked at any time from the web interface [or the REST API](/docs/apis/rest-api/access-token#revoke-the-current-token).
51+
API access tokens authenticate calls to the API and can be created from the <a href="<%= url_helpers.user_access_tokens_url %>" rel="nofollow">API access tokens</a> page. When configuring API access tokens, you can limit their access to individual organizations and permissions, and these tokens can be revoked at any time from the web interface [or the REST API](/docs/apis/rest-api/access-token#revoke-the-current-token).
5252

53-
To authenticate using a token, set the <code>Authorization</code> HTTP header to the word <code>Bearer</code>, followed by a space, followed by the access token. For example:
53+
To authenticate an API call using an access token, set the <code>Authorization</code> HTTP header to the word <code>Bearer</code>, followed by a space, followed by the access token. For example:
5454

5555
```bash
5656
curl -H "Authorization: Bearer $TOKEN" \
5757
-X GET "https://api.buildkite.com/v2/user"
5858
```
5959

60-
Access using basic HTTP authentication is not supported.
60+
API access using basic HTTP authentication is not supported.
6161

6262
## Pagination
6363

styleguides/writing-style.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,14 +196,14 @@ Refer to [UI elements in the Markdown syntax style guide](markdown-syntax-style.
196196

197197
### Lists (bullet lists and numbered steps)
198198

199-
Capitalize the first word—no full stops at the end if it's not a full sentence. If it's a full sentence, give it a full stop/period.
200-
201199
In general:
202200

203201
- Use bullet lists when presenting an unordered list of individual items.
204202
- Use numbered steps when presenting a sequence of instructions/steps that need to be followed.
205203

206-
See also what [Google](https://developers.google.com/style/lists#capitalization-and-end-punctuation) and [Microsoft](https://learn.microsoft.com/en-us/style-guide/scannable-content/lists#punctuation) say about lists.
204+
See also what [Google](https://developers.google.com/style/lists) and [Microsoft](https://learn.microsoft.com/en-us/style-guide/scannable-content/lists) say about lists.
205+
206+
Capitalize the first word—no full stops at the end if it's not a full sentence. If it's a full sentence, give it a full stop/period. See also what [Google](https://developers.google.com/style/lists#capitalization-and-end-punctuation) and [Microsoft](https://learn.microsoft.com/en-us/style-guide/scannable-content/lists#punctuation) say about punctuation in list items.
207207

208208
Refer to [Lists in the Markdown syntax style guide](markdown-syntax-style.md#lists) for details on how to write and present lists in the Buildkite docs.
209209

0 commit comments

Comments
 (0)