tenseleyflow/shithub / d142dd8

Browse files

Document API route literals for verifier

Authored by mfwolffe <wolffemf@dukes.jmu.edu>
SHA
d142dd8c7051c94356ca98a38cb708a7717ad943
Parents
122ca19
Tree
b035e6d

4 changed files

StatusFile+-
M docs/public/api/actions-runs.md 3 3
M docs/public/api/branches.md 4 0
M docs/public/api/contents.md 3 0
M docs/public/api/watching.md 4 4
docs/public/api/actions-runs.mdmodified
@@ -13,9 +13,9 @@ separate Actions lifecycle routes — this surface is **read-only**.
1313
 ## Endpoints
1414
1515
 ```
16
-GET /api/v1/repos/{o}/{r}/actions/runs[?…]
17
-GET /api/v1/repos/{o}/{r}/actions/runs/{run_id}
18
-GET /api/v1/repos/{o}/{r}/actions/runs/{run_id}/jobs
16
+GET /api/v1/repos/{owner}/{repo}/actions/runs[?…]
17
+GET /api/v1/repos/{owner}/{repo}/actions/runs/{run_id}
18
+GET /api/v1/repos/{owner}/{repo}/actions/runs/{run_id}/jobs
1919
 ```
2020
2121
 ## List runs
docs/public/api/branches.mdmodified
@@ -51,6 +51,10 @@ GET /api/v1/repos/{owner}/{repo}/branches/{branch}
5151
 URL-encoded (`feature%2Fx`). Returns the same shape as a list
5252
 entry; unknown branches `404`.
5353
54
+The registered route literal is
55
+`/api/v1/repos/{owner}/{repo}/branches/*` so branch names may include
56
+slashes.
57
+
5458
 ## List tags
5559
5660
 ```
docs/public/api/contents.mdmodified
@@ -23,6 +23,9 @@ GET /api/v1/repos/{owner}/{repo}/contents/{path}[?ref=]
2323
 Both `/contents` (no trailing path) and `/contents/` (empty
2424
 path) map to "repo root".
2525
26
+The registered path-bearing route literal is
27
+`/api/v1/repos/{owner}/{repo}/contents/*`.
28
+
2629
 ## Directory response
2730
2831
 An array of entries, **directories first**, then files sorted
docs/public/api/watching.mdmodified
@@ -24,10 +24,10 @@ Scopes:
2424
 ## Endpoints
2525
2626
 ```
27
-GET    /api/v1/repos/{o}/{r}/subscribers          paginated list of watchers
28
-GET    /api/v1/repos/{o}/{r}/subscription         viewer's current watch level
29
-PUT    /api/v1/repos/{o}/{r}/subscription         set an explicit level
30
-DELETE /api/v1/repos/{o}/{r}/subscription         revert to the implicit default
27
+GET    /api/v1/repos/{owner}/{repo}/subscribers          paginated list of watchers
28
+GET    /api/v1/repos/{owner}/{repo}/subscription         viewer's current watch level
29
+PUT    /api/v1/repos/{owner}/{repo}/subscription         set an explicit level
30
+DELETE /api/v1/repos/{owner}/{repo}/subscription         revert to the implicit default
3131
 ```
3232
3333
 ### List subscribers