mammoth-cli 1.0.0__py3-none-any.whl

spec/manifests/commands/batch.yaml

@@ -0,0 +1,262 @@
+manifest_schema_version: 1
+commands:
+- command_id: batch.bulk-delete
+  command_path: batch bulk-delete
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - DeleteBatches
+  positionals:
+  - name: dataset_id
+    type: int
+    required: true
+    metavar: DATASET_ID
+    falls_back_to_field: null
+    help: ID of the dataset.
+  options: []
+  sdk_symbol: mammoth.api.batches.BatchesAPI.bulk_delete
+  sdk_conversion: Call mammoth.api.batches.BatchesAPI.bulk_delete with validated request fields.
+  request_model: BatchBulkDeleteRequest
+  result_model: BatchBulkDeleteResult
+  mutation_class: destructive
+  confirmation: prompt_or_yes
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-BATCH-BULK-DELETE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth batch bulk-delete DATASET_ID --help
+  agent_example: mammoth batch bulk-delete 123 --output json --no-input
+  unit_tests:
+  - UT-BATCH-BULK-DELETE
+  contract_tests:
+  - CT-BATCH-BULK-DELETE-HUMAN
+  - CT-BATCH-BULK-DELETE-JSON
+  - CT-BATCH-BULK-DELETE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: batch.create
+  command_path: batch create
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - CreateBatch
+  positionals:
+  - name: dataset_id
+    type: int
+    required: true
+    metavar: DATASET_ID
+    falls_back_to_field: null
+    help: ID of the dataset.
+  - name: source_id
+    type: int
+    required: true
+    metavar: SOURCE_ID
+    falls_back_to_field: null
+    help: ID of the source.
+  options: []
+  sdk_symbol: mammoth.api.batches.BatchesAPI.create
+  sdk_conversion: Call mammoth.api.batches.BatchesAPI.create with validated request fields.
+  request_model: BatchCreateRequest
+  result_model: BatchCreateResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: returns_job
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-BATCH-CREATE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth batch create DATASET_ID SOURCE_ID --help
+  agent_example: 'mammoth batch create 123 123 --input ''{"mapping": {"example": "example"}}'' --output
+    json --no-input'
+  unit_tests:
+  - UT-BATCH-CREATE
+  contract_tests:
+  - CT-BATCH-CREATE-HUMAN
+  - CT-BATCH-CREATE-JSON
+  - CT-BATCH-CREATE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: delete_source_ds=true changes the mutation class to destructive and requires confirmation.
+  reviewed_by: primary
+- command_id: batch.delete
+  command_path: batch delete
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - DeleteBatch
+  positionals:
+  - name: dataset_id
+    type: int
+    required: true
+    metavar: DATASET_ID
+    falls_back_to_field: null
+    help: ID of the dataset.
+  - name: batch_id
+    type: int
+    required: true
+    metavar: BATCH_ID
+    falls_back_to_field: null
+    help: ID of the batch.
+  options: []
+  sdk_symbol: mammoth.api.batches.BatchesAPI.delete
+  sdk_conversion: Call mammoth.api.batches.BatchesAPI.delete with validated request fields.
+  request_model: BatchDeleteRequest
+  result_model: BatchDeleteResult
+  mutation_class: destructive
+  confirmation: prompt_or_yes
+  wait_policy: returns_job
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-BATCH-DELETE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth batch delete DATASET_ID BATCH_ID --help
+  agent_example: mammoth batch delete 123 123 --output json --no-input
+  unit_tests:
+  - UT-BATCH-DELETE
+  contract_tests:
+  - CT-BATCH-DELETE-HUMAN
+  - CT-BATCH-DELETE-JSON
+  - CT-BATCH-DELETE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: Resolve the batch before confirmation.
+  reviewed_by: primary
+- command_id: batch.get
+  command_path: batch get
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - GetBatch
+  positionals:
+  - name: dataset_id
+    type: int
+    required: true
+    metavar: DATASET_ID
+    falls_back_to_field: null
+    help: ID of the dataset.
+  - name: batch_id
+    type: int
+    required: true
+    metavar: BATCH_ID
+    falls_back_to_field: null
+    help: ID of the batch.
+  options: []
+  sdk_symbol: mammoth.api.batches.BatchesAPI.get
+  sdk_conversion: Call mammoth.api.batches.BatchesAPI.get with validated request fields.
+  request_model: BatchGetRequest
+  result_model: BatchGetResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: none
+  acceptance_evidence: live_read_only
+  live_test: LT-BATCH-GET
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth batch get DATASET_ID BATCH_ID --help
+  agent_example: mammoth batch get 123 123 --output json --no-input
+  unit_tests:
+  - UT-BATCH-GET
+  contract_tests:
+  - CT-BATCH-GET-HUMAN
+  - CT-BATCH-GET-JSON
+  - CT-BATCH-GET-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: batch.list
+  command_path: batch list
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - GetBatches
+  positionals:
+  - name: dataset_id
+    type: int
+    required: true
+    metavar: DATASET_ID
+    falls_back_to_field: null
+    help: ID of the dataset.
+  options: []
+  sdk_symbol: mammoth.api.batches.BatchesAPI.list
+  sdk_conversion: Call mammoth.api.batches.BatchesAPI.list with validated request fields.
+  request_model: BatchListRequest
+  result_model: BatchListResult
+  mutation_class: read
+  confirmation: none
+  wait_policy: not_async
+  pagination_policy: offset
+  acceptance_evidence: live_read_only
+  live_test: LT-BATCH-LIST
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth batch list DATASET_ID --help
+  agent_example: mammoth batch list 123 --output json --no-input
+  unit_tests:
+  - UT-BATCH-LIST
+  contract_tests:
+  - CT-BATCH-LIST-HUMAN
+  - CT-BATCH-LIST-JSON
+  - CT-BATCH-LIST-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: null
+  reviewed_by: primary
+- command_id: batch.update
+  command_path: batch update
+  disposition: command
+  alias_of: null
+  operation_ids:
+  - UpdateBatches
+  positionals:
+  - name: dataset_id
+    type: int
+    required: true
+    metavar: DATASET_ID
+    falls_back_to_field: null
+    help: ID of the dataset.
+  options: []
+  sdk_symbol: mammoth.api.batches.BatchesAPI.update
+  sdk_conversion: Call mammoth.api.batches.BatchesAPI.update with validated request fields.
+  request_model: BatchUpdateRequest
+  result_model: BatchUpdateResult
+  mutation_class: benign_mutation
+  confirmation: none
+  wait_policy: returns_job
+  pagination_policy: none
+  acceptance_evidence: live_disposable_project
+  live_test: LT-BATCH-UPDATE
+  live_exemption_reason: null
+  contract_fixture: null
+  required_fixture_guard: null
+  secret_fields: []
+  human_example: mammoth batch update DATASET_ID --help
+  agent_example: 'mammoth batch update 123 --input ''{"patch": [{"example": "example"}]}'' --output json
+    --no-input'
+  unit_tests:
+  - UT-BATCH-UPDATE
+  contract_tests:
+  - CT-BATCH-UPDATE-HUMAN
+  - CT-BATCH-UPDATE-JSON
+  - CT-BATCH-UPDATE-ERROR
+  draft_test: null
+  undo_test: null
+  known_restrictions: Any remove operation in the discriminated patch changes the mutation class to destructive.
+  reviewed_by: primary