mammoth-cli 1.0.0__py3-none-any.whl

spec/manifests/commands/workflow.yaml

@@ -0,0 +1,622 @@
+manifest_schema_version: 1
+commands:
+- command_id: workflow.block.add
+  command_path: workflow block add
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - AddSkeletonBlock
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.block_add
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.block_add with validated request fields.
+  request_model: WorkflowBlockAddRequest
+  result_model: WorkflowBlockAddResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-BLOCK-ADD
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow block add WORKFLOW_ID --help
+  agent_example: 'mammoth workflow block add 123 --input ''{"block_type": "example"}'' --output json --no-input'
+  unit_tests:
+  - UT-WORKFLOW-BLOCK-ADD
+  contract_tests:
+  - CT-WORKFLOW-BLOCK-ADD-HUMAN
+  - CT-WORKFLOW-BLOCK-ADD-JSON
+  - CT-WORKFLOW-BLOCK-ADD-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.block.auth
+  command_path: workflow block auth
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - PatchBlockAuth
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  - name: block_id
+    type: int
+    required: true
+    metavar: BLOCK_ID
+    falls_back_to_field: null
+    help: ID of the block.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.block_auth
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.block_auth with validated request fields.
+  request_model: WorkflowBlockAuthRequest
+  result_model: WorkflowBlockAuthResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-BLOCK-AUTH
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow block auth WORKFLOW_ID BLOCK_ID --help
+  agent_example: 'mammoth workflow block auth 123 123 --input ''{"auth_data": {"example": "example"}}''
+    --output json --no-input'
+  unit_tests:
+  - UT-WORKFLOW-BLOCK-AUTH
+  contract_tests:
+  - CT-WORKFLOW-BLOCK-AUTH-HUMAN
+  - CT-WORKFLOW-BLOCK-AUTH-JSON
+  - CT-WORKFLOW-BLOCK-AUTH-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.block.config
+  command_path: workflow block config
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - PromoteSkeletonBlock
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  - name: block_id
+    type: int
+    required: true
+    metavar: BLOCK_ID
+    falls_back_to_field: null
+    help: ID of the block.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.block_config
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.block_config with validated request fields.
+  request_model: WorkflowBlockConfigRequest
+  result_model: WorkflowBlockConfigResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-BLOCK-CONFIG
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow block config WORKFLOW_ID BLOCK_ID --help
+  agent_example: mammoth workflow block config 123 123 --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-BLOCK-CONFIG
+  contract_tests:
+  - CT-WORKFLOW-BLOCK-CONFIG-HUMAN
+  - CT-WORKFLOW-BLOCK-CONFIG-JSON
+  - CT-WORKFLOW-BLOCK-CONFIG-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.block.type
+  command_path: workflow block type
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - PatchBlockType
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  - name: block_id
+    type: int
+    required: true
+    metavar: BLOCK_ID
+    falls_back_to_field: null
+    help: ID of the block.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.block_type
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.block_type with validated request fields.
+  request_model: WorkflowBlockTypeRequest
+  result_model: WorkflowBlockTypeResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-BLOCK-TYPE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow block type WORKFLOW_ID BLOCK_ID --help
+  agent_example: 'mammoth workflow block type 123 123 --input ''{"connection_type": "example"}'' --output
+    json --no-input'
+  unit_tests:
+  - UT-WORKFLOW-BLOCK-TYPE
+  contract_tests:
+  - CT-WORKFLOW-BLOCK-TYPE-HUMAN
+  - CT-WORKFLOW-BLOCK-TYPE-JSON
+  - CT-WORKFLOW-BLOCK-TYPE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.canvas
+  command_path: workflow canvas
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - UpdateCanvasState
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.canvas
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.canvas with validated request fields.
+  request_model: WorkflowCanvasRequest
+  result_model: WorkflowCanvasResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-CANVAS
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow canvas WORKFLOW_ID --help
+  agent_example: 'mammoth workflow canvas 123 --input ''{"canvas_state": {"example": "example"}}'' --output
+    json --no-input'
+  unit_tests:
+  - UT-WORKFLOW-CANVAS
+  contract_tests:
+  - CT-WORKFLOW-CANVAS-HUMAN
+  - CT-WORKFLOW-CANVAS-JSON
+  - CT-WORKFLOW-CANVAS-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.cleanup
+  command_path: workflow cleanup
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - CleanupGhostWorkflows
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.cleanup
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.cleanup with validated request fields.
+  request_model: WorkflowCleanupRequest
+  result_model: WorkflowCleanupResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-CLEANUP
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow cleanup --help
+  agent_example: mammoth workflow cleanup --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-CLEANUP
+  contract_tests:
+  - CT-WORKFLOW-CLEANUP-HUMAN
+  - CT-WORKFLOW-CLEANUP-JSON
+  - CT-WORKFLOW-CLEANUP-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.create
+  command_path: workflow create
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - CreateWorkflow
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.create
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.create with validated request fields.
+  request_model: WorkflowCreateRequest
+  result_model: WorkflowCreateResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-CREATE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow create --help
+  agent_example: 'mammoth workflow create --input ''{"name": "example"}'' --output json --no-input'
+  unit_tests:
+  - UT-WORKFLOW-CREATE
+  contract_tests:
+  - CT-WORKFLOW-CREATE-HUMAN
+  - CT-WORKFLOW-CREATE-JSON
+  - CT-WORKFLOW-CREATE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.delete
+  command_path: workflow delete
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - DeleteWorkflow
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.delete
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.delete with validated request fields.
+  request_model: WorkflowDeleteRequest
+  result_model: WorkflowDeleteResult
+  mutation_class: destructive
+  confirmation: prompt_or_yes
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-DELETE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow delete WORKFLOW_ID --help
+  agent_example: mammoth workflow delete 123 --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-DELETE
+  contract_tests:
+  - CT-WORKFLOW-DELETE-HUMAN
+  - CT-WORKFLOW-DELETE-JSON
+  - CT-WORKFLOW-DELETE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.from-template
+  command_path: workflow from-template
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - InstantiateFromTemplate
+  positionals:
+  - name: template_id
+    type: int
+    required: true
+    metavar: TEMPLATE_ID
+    falls_back_to_field: null
+    help: ID of the template.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.from_template
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.from_template with validated request fields.
+  request_model: WorkflowFromTemplateRequest
+  result_model: WorkflowFromTemplateResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-FROM-TEMPLATE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow from-template TEMPLATE_ID --help
+  agent_example: 'mammoth workflow from-template 123 --input ''{"workflow_name": "example"}'' --output
+    json --no-input'
+  unit_tests:
+  - UT-WORKFLOW-FROM-TEMPLATE
+  contract_tests:
+  - CT-WORKFLOW-FROM-TEMPLATE-HUMAN
+  - CT-WORKFLOW-FROM-TEMPLATE-JSON
+  - CT-WORKFLOW-FROM-TEMPLATE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.get
+  command_path: workflow get
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - GetWorkflow
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.get
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.get with validated request fields.
+  request_model: WorkflowGetRequest
+  result_model: WorkflowGetResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_read_only
+  live_test: LT-WORKFLOW-GET
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow get WORKFLOW_ID --help
+  agent_example: mammoth workflow get 123 --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-GET
+  contract_tests:
+  - CT-WORKFLOW-GET-HUMAN
+  - CT-WORKFLOW-GET-JSON
+  - CT-WORKFLOW-GET-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.graph
+  command_path: workflow graph
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - GetProjectWorkflowGraph
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.graph
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.graph with validated request fields.
+  request_model: WorkflowGraphRequest
+  result_model: WorkflowGraphResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_read_only
+  live_test: LT-WORKFLOW-GRAPH
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow graph --help
+  agent_example: mammoth workflow graph --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-GRAPH
+  contract_tests:
+  - CT-WORKFLOW-GRAPH-HUMAN
+  - CT-WORKFLOW-GRAPH-JSON
+  - CT-WORKFLOW-GRAPH-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.list
+  command_path: workflow list
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - ListWorkflows
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.list
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.list with validated request fields.
+  request_model: WorkflowListRequest
+  result_model: WorkflowListResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: single_page
+  acceptance_evidence: live_read_only
+  live_test: LT-WORKFLOW-LIST
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow list --help
+  agent_example: mammoth workflow list --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-LIST
+  contract_tests:
+  - CT-WORKFLOW-LIST-HUMAN
+  - CT-WORKFLOW-LIST-JSON
+  - CT-WORKFLOW-LIST-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.update
+  command_path: workflow update
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - UpdateWorkflow
+  positionals:
+  - name: workflow_id
+    type: int
+    required: true
+    metavar: WORKFLOW_ID
+    falls_back_to_field: null
+    help: ID of the workflow.
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.update
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.update with validated request fields.
+  request_model: WorkflowUpdateRequest
+  result_model: WorkflowUpdateResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-WORKFLOW-UPDATE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow update WORKFLOW_ID --help
+  agent_example: mammoth workflow update 123 --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-UPDATE
+  contract_tests:
+  - CT-WORKFLOW-UPDATE-HUMAN
+  - CT-WORKFLOW-UPDATE-JSON
+  - CT-WORKFLOW-UPDATE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.workspace-datasets
+  command_path: workflow workspace-datasets
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - ListWorkspaceDatasets
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.workspace_datasets
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.workspace_datasets with validated request fields.
+  request_model: WorkflowWorkspaceDatasetsRequest
+  result_model: WorkflowWorkspaceDatasetsResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_read_only
+  live_test: LT-WORKFLOW-WORKSPACE-DATASETS
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow workspace-datasets --help
+  agent_example: mammoth workflow workspace-datasets --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-WORKSPACE-DATASETS
+  contract_tests:
+  - CT-WORKFLOW-WORKSPACE-DATASETS-HUMAN
+  - CT-WORKFLOW-WORKSPACE-DATASETS-JSON
+  - CT-WORKFLOW-WORKSPACE-DATASETS-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.workspace-exports
+  command_path: workflow workspace-exports
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - ListWorkspaceExports
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.workspace_exports
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.workspace_exports with validated request fields.
+  request_model: WorkflowWorkspaceExportsRequest
+  result_model: WorkflowWorkspaceExportsResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_read_only
+  live_test: LT-WORKFLOW-WORKSPACE-EXPORTS
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow workspace-exports --help
+  agent_example: mammoth workflow workspace-exports --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-WORKSPACE-EXPORTS
+  contract_tests:
+  - CT-WORKFLOW-WORKSPACE-EXPORTS-HUMAN
+  - CT-WORKFLOW-WORKSPACE-EXPORTS-JSON
+  - CT-WORKFLOW-WORKSPACE-EXPORTS-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: workflow.workspace-sources
+  command_path: workflow workspace-sources
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - ListWorkspaceSources
+  positionals: []
+  options: []
+  sdk_symbol: mammoth.api.workflows.WorkflowsAPI.workspace_sources
+  sdk_conversion: Call mammoth.api.workflows.WorkflowsAPI.workspace_sources with validated request fields.
+  request_model: WorkflowWorkspaceSourcesRequest
+  result_model: WorkflowWorkspaceSourcesResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_read_only
+  live_test: LT-WORKFLOW-WORKSPACE-SOURCES
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth workflow workspace-sources --help
+  agent_example: mammoth workflow workspace-sources --output json --no-input
+  unit_tests:
+  - UT-WORKFLOW-WORKSPACE-SOURCES
+  contract_tests:
+  - CT-WORKFLOW-WORKSPACE-SOURCES-HUMAN
+  - CT-WORKFLOW-WORKSPACE-SOURCES-JSON
+  - CT-WORKFLOW-WORKSPACE-SOURCES-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary