tenseleyflow/shithub / 044f739

Browse files

Document actions workflow route literals

Authored by mfwolffe <wolffemf@dukes.jmu.edu>
SHA
044f739606025e0f33f3c7f23eaa89d114a83b16
Parents
49234c8
Tree
7b9dc8f

1 changed file

StatusFile+-
M docs/public/api/actions-workflows.md 3 2
docs/public/api/actions-workflows.mdmodified
@@ -15,8 +15,8 @@ Scopes:
15
15
16
 ```
16
 ```
17
 GET  /api/v1/repos/{owner}/{repo}/actions/workflows                          list discovered workflows
17
 GET  /api/v1/repos/{owner}/{repo}/actions/workflows                          list discovered workflows
18
-GET  /api/v1/repos/{owner}/{repo}/actions/workflows/{id_or_file}             single workflow
18
+GET  /api/v1/repos/{owner}/{repo}/actions/workflows/{workflow}               single workflow
19
-POST /api/v1/repos/{owner}/{repo}/actions/workflows/{file}/dispatches        workflow_dispatch
19
+POST /api/v1/repos/{owner}/{repo}/actions/workflows/{workflow}/dispatches    workflow_dispatch
20
 ```
20
 ```
21
21
22
 ## Discovery model
22
 ## Discovery model
@@ -29,6 +29,7 @@ in the listing — with their basename as the name — so the listing
29
 reflects ground truth rather than silently dropping broken
29
 reflects ground truth rather than silently dropping broken
30
 workflows.
30
 workflows.
31
31
 
32
+The `{workflow}` path segment is the workflow id or file selector.
32
 The `id` field on each entry is a deterministic 64-bit hash of the
33
 The `id` field on each entry is a deterministic 64-bit hash of the
33
 file path so gh-shaped clients that pass `workflow_id` still work:
34
 file path so gh-shaped clients that pass `workflow_id` still work:
34
 both `ci.yml` (basename), `.shithub/workflows/ci.yml` (full path),
35
 both `ci.yml` (basename), `.shithub/workflows/ci.yml` (full path),