Skip to content

Commit 1661cab

Browse files
committed
minor edits
1 parent 19b5cfa commit 1661cab

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

guides/api.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@ state: alpha
77
To help you integrate Coder into your automated workflows, we've documented our
88
API.
99

10+
## Documentation
11+
12+
Please note that the API is under active development; expect breaking changes as
13+
we finalize the endpoints.
14+
15+
<a href="https://apidocs.coder.com">
16+
<button> Swagger Docs </button>
17+
</a>
18+
1019
## Authentication
1120

1221
Use of the API requires authentication with a session token. You can generate
@@ -24,15 +33,6 @@ one using the [Coder CLI](../cli/index.md):
2433
-H "Session-Token: Bk...nt"
2534
```
2635

27-
## Documentation
28-
29-
Please note that the API is under active development; expect breaking changes as
30-
we finalize the endpoints.
31-
32-
<a href="https://apidocs.coder.com">
33-
<button> Swagger Docs </button>
34-
</a>
35-
3636
## Examples
3737

3838
These are example Coder API calls for common tasks. Note that the site-manager
@@ -41,8 +41,6 @@ be limited to a user's member role.
4141

4242
> Assign your Access URL, Session-Token and other resources like images and
4343
> workspaces to variables for easier substitution in the curl commands.
44-
>
45-
> For example:
4644
4745
```sh
4846
export ACCESS_URL "https://coder.acme.com"
@@ -53,7 +51,7 @@ export IMAGE_ID="622b3f6e-dd6fd08-----ba38c73c9639"
5351

5452
### Example: get active users in 1 month increments from Jan to March 2022
5553

56-
> other intervals include 1 week, 1 year, 90 day
54+
> Other intervals include 1 week, 1 year, 90 day
5755
5856
```sh
5957
curl --request GET \

0 commit comments

Comments
 (0)