yao/pipe/doc.yml
Max efc84fbb97 feat(doc): add yao doc CLI commands and YAML documentation for all packages
Implement yao doc process list/inspect/validate and yao doc runtime
list/inspect/validate commands. Validate uses engine addressing logic
(process.Of) and checks dynamic-ID group registries (model, store, fs,
task, schedule) to verify resources actually exist.

- cmd/doc/: CLI command tree with process and runtime subcommands
- cmd/root.go: wire docCmd into rootCmd
- 27 process doc.yml + doc.go pairs across yao packages
- cmd/doc/doc_test.go: integration tests

Made-with: Cursor
2026-04-23 21:37:43 +08:00

96 lines
2.5 KiB
YAML

group: pipe
type: process
entries:
- name: run
desc: Run a loaded pipeline by its registered ID
args:
- name: pipeId
type: string
required: true
desc: Registered pipeline ID
- name: args
type: any
required: false
desc: "Variable arguments passed to the pipeline execution"
return:
type: any
desc: Pipeline execution result
- name: create
desc: Create a new pipeline from a DSL string and run it immediately
args:
- name: dsl
type: string
required: true
desc: Pipeline DSL definition as a YAML/JSON string
- name: args
type: any
required: false
desc: "Variable arguments passed to the pipeline execution"
return:
type: any
desc: Pipeline execution result
- name: createwith
desc: Create a new pipeline from DSL with global data and run it immediately
args:
- name: dsl
type: string
required: true
desc: Pipeline DSL definition as a YAML/JSON string
- name: global
type: object
required: true
desc: Global data map merged with process global context
- name: args
type: any
required: false
desc: "Variable arguments passed to the pipeline execution"
return:
type: any
desc: Pipeline execution result
- name: resume
desc: Resume a paused pipeline context by its context ID
args:
- name: contextId
type: string
required: true
desc: Pipeline context ID to resume
- name: args
type: any
required: false
desc: "Variable arguments passed to the resumed pipeline"
return:
type: any
desc: Resumed pipeline execution result
- name: resumewith
desc: Resume a paused pipeline context with additional global data
args:
- name: contextId
type: string
required: true
desc: Pipeline context ID to resume
- name: global
type: object
required: true
desc: Global data map merged with process global context
- name: args
type: any
required: false
desc: "Variable arguments passed to the resumed pipeline"
return:
type: any
desc: Resumed pipeline execution result
- name: close
desc: Close and clean up a pipeline context
args:
- name: contextId
type: string
required: true
desc: Pipeline context ID to close
return:
type: "null"
desc: Returns null on success