alice.pds.demo.boltless.dev
This repository has no description
1{
2 "lexicon": 1,
3 "id": "sh.tangled.ci.describeWorkflowDefinition",
4 "defs": {
5 "main": {
6 "type": "query",
7 "description": "Resolve the workflow definition a pipeline would use at a given commit and return a fingerprint of it.",
8 "parameters": {
9 "type": "params",
10 "required": ["repo", "sha"],
11 "properties": {
12 "repo": {
13 "type": "string",
14 "format": "did",
15 "description": "Target repository DID the workflow definition belongs to."
16 },
17 "sha": {
18 "type": "string",
19 "minLength": 40,
20 "maxLength": 40,
21 "description": "Commit SHA to resolve the workflow definition at"
22 },
23 "sourceRepo": {
24 "type": "string",
25 "format": "did",
26 "description": "Repository DID to resolve workflow definitions from, if different from the target repo"
27 }
28 }
29 },
30 "output": {
31 "encoding": "application/json",
32 "schema": {
33 "type": "object",
34 "required": ["derived"],
35 "properties": {
36 "derived": {
37 "type": "boolean",
38 "description": "Whether the workflow definition is derived from this repository at all. When false, no commit-to-commit comparison is meaningful (e.g. definitions managed externally), and callers should not surface change warnings."
39 },
40 "hash": {
41 "type": "string",
42 "description": "Fingerprint of the workflow definition as resolved by the spindle. Absent when derived is false."
43 },
44 "workflows": {
45 "type": "array",
46 "items": {
47 "type": "string"
48 },
49 "description": "Names or paths of the effective workflow files that produced the hash."
50 }
51 }
52 }
53 },
54 "errors": [
55 {
56 "name": "InvalidRequest",
57 "description": "Invalid request parameters"
58 }
59 ]
60 }
61 }
62}