Chewing_Bever
/
vieter
forked from vieter-v/vieter
1
0
Fork 0
Code Issues Pull Requests Releases Activity

fix(docs): use versioned endpoints in HTTP API docs

v-0.3.1
Jef Roosens 2022-06-16 22:38:42 +02:00
parent 1b7c14e7dc
commit a8d647cca3
Signed by: Jef Roosens
GPG Key ID: B75D4F293C7052DB
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/api/source/includes/_logs.md
View File

@ -13,7 +13,7 @@ Endpoints for interacting with stored build logs.
```shell ```shell
curl \ curl \
-H 'X-Api-Key: secret' \ -H 'X-Api-Key: secret' \
https://example.com/api/logs?offset=10&limit=20 https://example.com/api/v1/logs?offset=10&limit=20
``` ```
> JSON output format > JSON output format
@ -38,7 +38,7 @@ Retrieve a list of build logs.
### HTTP Request ### HTTP Request
`GET /api/logs` `GET /api/v1/logs`
### Query Parameters ### Query Parameters
@ -58,7 +58,7 @@ exit_codes | Comma-separated list of exit codes to limit result to; using `!` as
```shell ```shell
curl \ curl \
-H 'X-Api-Key: secret' \ -H 'X-Api-Key: secret' \
https://example.com/api/logs/1 https://example.com/api/v1/logs/1
``` ```
> JSON output format > JSON output format
@ -81,7 +81,7 @@ Retrieve info about a specific build log.
### HTTP Request ### HTTP Request
`GET /api/logs/:id` `GET /api/v1/logs/:id`
### URL Parameters ### URL Parameters
@ -94,7 +94,7 @@ id | ID of requested log
```shell ```shell
curl \ curl \
-H 'X-Api-Key: secret' \ -H 'X-Api-Key: secret' \
https://example.com/api/logs/15/content https://example.com/api/v1/logs/15/content
``` ```
Retrieve the contents of a build log. The response is the build log in Retrieve the contents of a build log. The response is the build log in
@ -102,7 +102,7 @@ plaintext.
### HTTP Request ### HTTP Request
`GET /api/logs/:id/content` `GET /api/v1/logs/:id/content`
### URL Parameters ### URL Parameters
@ -123,7 +123,7 @@ Publish a new build log to the server.
### HTTP Request ### HTTP Request
`POST /api/logs` `POST /api/v1/logs`
### Query parameters ### Query parameters

14
docs/api/source/includes/_targets.md
View File

@ -13,7 +13,7 @@ Endpoints for interacting with the list of targets stored on the server.
```shell ```shell
curl \ curl \
-H 'X-Api-Key: secret' \ -H 'X-Api-Key: secret' \
https://example.com/api/targets?offset=10&limit=20 https://example.com/api/v1/targets?offset=10&limit=20
``` ```
> JSON output format > JSON output format
@ -44,7 +44,7 @@ Retrieve a list of targets.
### HTTP Request ### HTTP Request
`GET /api/targets` `GET /api/v1/targets`
### Query Parameters ### Query Parameters
@ -59,7 +59,7 @@ repo | Limit results to targets that publish to the given repo.
```shell ```shell
curl \ curl \
-H 'X-Api-Key: secret' \ -H 'X-Api-Key: secret' \
https://example.com/api/targets/1 https://example.com/api/v1/targets/1
``` ```
> JSON output format > JSON output format
@ -88,7 +88,7 @@ Get info about a specific target.
### HTTP Request ### HTTP Request
`GET /api/targets/:id` `GET /api/v1/targets/:id`
### URL Parameters ### URL Parameters
@ -102,7 +102,7 @@ Create a new target with the given data.
### HTTP Request ### HTTP Request
`POST /api/targets` `POST /api/v1/targets`
### Query Parameters ### Query Parameters
@ -120,7 +120,7 @@ Modify the data of an existing target.
### HTTP Request ### HTTP Request
`PATCH /api/targets/:id` `PATCH /api/v1/targets/:id`
### URL Parameters ### URL Parameters
@ -144,7 +144,7 @@ Remove a target from the server.
### HTTP Request ### HTTP Request
`DELETE /api/targets/:id` `DELETE /api/v1/targets/:id`
### URL Parameters ### URL Parameters