yao/widgets/chart/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

62 lines
1.6 KiB
YAML

group: yao.chart
type: process
entries:
- name: setting
desc: Get the setting configuration of a chart widget
args:
- name: chartId
type: string
required: true
desc: Chart widget ID
return:
type: any
desc: Chart setting from the configured action handler
- name: xgen
desc: Get the Xgen UI configuration for a chart widget with permission filtering
args:
- name: chartId
type: string
required: true
desc: Chart widget ID
- name: data
type: object
required: false
desc: Additional data for generating the configuration
return:
type: object
desc: Xgen configuration object with permission-based field exclusions
- name: component
desc: Execute a cloud component query within a chart widget
args:
- name: chartId
type: string
required: true
desc: Chart widget ID
- name: xpath
type: string
required: true
desc: Component XPath (URL-encoded)
- name: method
type: string
required: true
desc: Component method name (URL-encoded)
- name: query
type: object
required: false
desc: Query parameters for the component
return:
type: any
desc: Component query execution result
- name: data
desc: Get the data for a chart widget
args:
- name: chartId
type: string
required: true
desc: Chart widget ID
return:
type: any
desc: Chart data from the configured action handler