tenseleyflow/shithub / 16c7125

Browse files

Document actions REST route literals

Authored by mfwolffe <wolffemf@dukes.jmu.edu>
SHA
16c7125f29bb32acc241221d91af53daeda2943f
Parents
044f739
Tree
59c2e97

3 changed files

StatusFile+-
M docs/public/api/actions-caches.md 6 3
M docs/public/api/actions-lifecycle.md 8 8
M docs/public/api/actions-secrets.md 10 10
docs/public/api/actions-caches.mdmodified
@@ -16,11 +16,14 @@ Scopes:
1616
 ## Endpoints
1717
1818
 ```
19
-GET    /api/v1/repos/{o}/{r}/actions/caches[?key=&ref=&page=&per_page=]
20
-DELETE /api/v1/repos/{o}/{r}/actions/caches?key=...[&ref=...]
21
-DELETE /api/v1/repos/{o}/{r}/actions/caches/{cache_id}
19
+GET    /api/v1/repos/{owner}/{repo}/actions/caches
20
+DELETE /api/v1/repos/{owner}/{repo}/actions/caches
21
+DELETE /api/v1/repos/{owner}/{repo}/actions/caches/{cache_id}
2222
 ```
2323
24
+`GET` accepts `?key=&ref=&page=&per_page=`. `DELETE` without a
25
+`{cache_id}` deletes by `?key=...` and optional `&ref=...`.
26
+
2427
 ## List response
2528
2629
 ```json
docs/public/api/actions-lifecycle.mdmodified
@@ -14,14 +14,14 @@ Scopes:
1414
 ## Endpoints
1515
1616
 ```
17
-PUT    /api/v1/repos/{o}/{r}/actions/workflows/{file}/enable
18
-PUT    /api/v1/repos/{o}/{r}/actions/workflows/{file}/disable
19
-DELETE /api/v1/repos/{o}/{r}/actions/runs/{run_id}
20
-GET    /api/v1/repos/{o}/{r}/actions/runs/{run_id}/artifacts
21
-GET    /api/v1/repos/{o}/{r}/actions/artifacts/{artifact_id}
22
-GET    /api/v1/repos/{o}/{r}/actions/artifacts/{artifact_id}/zip
23
-DELETE /api/v1/repos/{o}/{r}/actions/artifacts/{artifact_id}
24
-GET    /api/v1/repos/{o}/{r}/actions/jobs/{job_id}/logs
17
+PUT    /api/v1/repos/{owner}/{repo}/actions/workflows/{workflow}/enable
18
+PUT    /api/v1/repos/{owner}/{repo}/actions/workflows/{workflow}/disable
19
+DELETE /api/v1/repos/{owner}/{repo}/actions/runs/{run_id}
20
+GET    /api/v1/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts
21
+GET    /api/v1/repos/{owner}/{repo}/actions/artifacts/{artifact_id}
22
+GET    /api/v1/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/zip
23
+DELETE /api/v1/repos/{owner}/{repo}/actions/artifacts/{artifact_id}
24
+GET    /api/v1/repos/{owner}/{repo}/actions/jobs/{job_id}/logs
2525
 ```
2626
2727
 ## Enable / disable a workflow
docs/public/api/actions-secrets.mdmodified
@@ -53,11 +53,11 @@ ct, _ := box.SealAnonymous(nil, []byte("my-secret-value"), &pub, rand.Reader)
5353
 ## Secrets endpoints
5454
5555
 ```
56
-GET    /api/v1/repos/{o}/{r}/actions/secrets/public-key
57
-GET    /api/v1/repos/{o}/{r}/actions/secrets
58
-GET    /api/v1/repos/{o}/{r}/actions/secrets/{name}
59
-PUT    /api/v1/repos/{o}/{r}/actions/secrets/{name}
60
-DELETE /api/v1/repos/{o}/{r}/actions/secrets/{name}
56
+GET    /api/v1/repos/{owner}/{repo}/actions/secrets/public-key
57
+GET    /api/v1/repos/{owner}/{repo}/actions/secrets
58
+GET    /api/v1/repos/{owner}/{repo}/actions/secrets/{name}
59
+PUT    /api/v1/repos/{owner}/{repo}/actions/secrets/{name}
60
+DELETE /api/v1/repos/{owner}/{repo}/actions/secrets/{name}
6161
6262
 GET    /api/v1/orgs/{org}/actions/secrets/public-key
6363
 GET    /api/v1/orgs/{org}/actions/secrets
@@ -117,11 +117,11 @@ list/get endpoints return values directly. The runner exposes them
117117
 via `${{ vars.NAME }}`.
118118
119119
 ```
120
-GET    /api/v1/repos/{o}/{r}/actions/variables
121
-POST   /api/v1/repos/{o}/{r}/actions/variables
122
-GET    /api/v1/repos/{o}/{r}/actions/variables/{name}
123
-PATCH  /api/v1/repos/{o}/{r}/actions/variables/{name}
124
-DELETE /api/v1/repos/{o}/{r}/actions/variables/{name}
120
+GET    /api/v1/repos/{owner}/{repo}/actions/variables
121
+POST   /api/v1/repos/{owner}/{repo}/actions/variables
122
+GET    /api/v1/repos/{owner}/{repo}/actions/variables/{name}
123
+PATCH  /api/v1/repos/{owner}/{repo}/actions/variables/{name}
124
+DELETE /api/v1/repos/{owner}/{repo}/actions/variables/{name}
125125
126126
 GET    /api/v1/orgs/{org}/actions/variables
127127
 POST   /api/v1/orgs/{org}/actions/variables