RubyGems - aspera-cli - Versions diffs - 4.27.3 → 4.27.5 - Mend

aspera-cli 4.27.3 → 4.27.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (79) hide show

checksums.yaml +4 -4
checksums.yaml.gz.sig +0 -0
data/CHANGELOG.md +118 -0
data/CONTRIBUTING.md +5 -2
data/bin/ascli +1 -0
data/docs/README.md +224 -42
data/lib/aspera/agent/base.rb +7 -2
data/lib/aspera/agent/connect.rb +0 -4
data/lib/aspera/agent/desktop.rb +0 -4
data/lib/aspera/agent/direct.rb +49 -21
data/lib/aspera/agent/node.rb +6 -5
data/lib/aspera/agent/transferd.rb +2 -2
data/lib/aspera/api/faspex.rb +2 -0
data/lib/aspera/api/httpgw.rb +1 -2
data/lib/aspera/api/node.rb +3 -3
data/lib/aspera/ascp/installation.rb +1 -1
data/lib/aspera/cli/async_transfer_store.rb +10 -9
data/lib/aspera/cli/bootstrapper.rb +3 -1
data/lib/aspera/cli/command_registry.rb +69 -7
data/lib/aspera/cli/command_spec.rb +1 -1
data/lib/aspera/cli/extended_value.rb +4 -3
data/lib/aspera/cli/formatter.rb +10 -8
data/lib/aspera/cli/http.rb +8 -20
data/lib/aspera/cli/option_types.rb +3 -1
data/lib/aspera/cli/option_value.rb +16 -19
data/lib/aspera/cli/options.schema.yaml +86 -10
data/lib/aspera/cli/parser.rb +30 -18
data/lib/aspera/cli/plugins/aoc.rb +133 -156
data/lib/aspera/cli/plugins/ats.rb +1 -7
data/lib/aspera/cli/plugins/base.rb +40 -34
data/lib/aspera/cli/plugins/config.rb +24 -11
data/lib/aspera/cli/plugins/console.rb +1 -1
data/lib/aspera/cli/plugins/faspex5.rb +30 -11
data/lib/aspera/cli/plugins/faspio.rb +1 -1
data/lib/aspera/cli/plugins/node.rb +26 -19
data/lib/aspera/cli/plugins/orchestrator.rb +73 -44
data/lib/aspera/cli/plugins/preview.rb +21 -19
data/lib/aspera/cli/plugins/server.rb +3 -4
data/lib/aspera/cli/plugins/shares.rb +21 -24
data/lib/aspera/cli/preset_actions.rb +28 -18
data/lib/aspera/cli/preset_manager.rb +34 -19
data/lib/aspera/cli/prompt.rb +2 -1
data/lib/aspera/cli/result.rb +33 -22
data/lib/aspera/cli/runner.rb +1 -5
data/lib/aspera/cli/sync_actions.rb +17 -16
data/lib/aspera/cli/transfer_actions.rb +14 -3
data/lib/aspera/cli/transfer_agent.rb +6 -4
data/lib/aspera/cli/transfer_progress.rb +290 -55
data/lib/aspera/cli/version.rb +1 -1
data/lib/aspera/cli/wizard.rb +1 -1
data/lib/aspera/coverage.rb +0 -1
data/lib/aspera/environment.rb +29 -5
data/lib/aspera/keychain/encrypted_hash.rb +1 -1
data/lib/aspera/keychain/factory.rb +2 -1
data/lib/aspera/log.rb +25 -2
data/lib/aspera/node_emulator.rb +759 -0
data/lib/aspera/oauth/base.rb +2 -1
data/lib/aspera/oauth/factory.rb +6 -3
data/lib/aspera/oauth/json_credentials.rb +34 -0
data/lib/aspera/oauth/jwt.rb +3 -4
data/lib/aspera/oauth.rb +1 -0
data/lib/aspera/persistency_folder.rb +1 -3
data/lib/aspera/preview/generator.rb +4 -1
data/lib/aspera/preview/options.schema.yaml +119 -0
data/lib/aspera/rest/aspera_errors.rb +12 -0
data/lib/aspera/rest/client.rb +28 -19
data/lib/aspera/rest/list.rb +14 -8
data/lib/aspera/rest/parameters.rb +2 -2
data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +0 -20
data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +1784 -0
data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +1230 -137
data/lib/aspera/schema/IBM_Aspera_Shares.yaml +14 -13
data/lib/aspera/schema/reader.rb +12 -18
data/lib/aspera/schema/registry.rb +6 -1
data.tar.gz.sig +0 -0
metadata +5 -3
metadata.gz.sig +0 -0
data/lib/aspera/node_simulator.rb +0 -345
data/lib/aspera/preview/options.rb +0 -45

data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml ADDED Viewed

@@ -0,0 +1,1784 @@
+# DO NOT EDIT THIS FILE MANUALLY
+# This file is automatically downloaded from:
+# https://raw.githubusercontent.com/laurent-martin/aspera-api-examples/refs/heads/main/openapi/IBM%20Aspera%20Orchestrator%20API-v1.yaml
+# Use 'rake tools:openapi' to update this file
+openapi: 3.0.1
+info:
+  title: Aspera Orchestrator API
+  version: v1
+  description: |
+    API documentation for Aspera Orchestrator.
+    ## Authentication
+    The API supports two authentication modes:
+    ### JWT Authentication (Recommended)
+    When JWT authentication is enabled (default):
+    1. Obtain a JWT token by calling POST /api/login with your credentials
+    2. Include the token in subsequent requests using the Authorization header:
+       `Authorization: Bearer <your_token>`
+    ### Basic Authentication (When JWT is Disabled)
+    If JWT authentication is disabled in your Orchestrator configuration:
+    - Add query parameters to every API request: `?login=username&password=password`
+    - Example: `/api/workflows_list?login=admin&password=mypassword&format=json`
+    **Note:** Check your Orchestrator configuration to determine which authentication mode is active.
+    ## API Endpoints
+    The Orchestrator API provides comprehensive workflow management capabilities including:
+    - Workflow management and execution
+    - Work order tracking and control
+    - Monitor management
+    - Queue & Task management
+    - Plugin and resource management
+servers:
+- url: https://159.8.70.244/aspera/orchestrator
+  description: 'Configured host: 159.8.70.244'
+- url: https://fsff/aspera/orchestrator
+  description: 'Configured host: fsff'
+- url: https://orchestrator.aspera-emea.com/aspera/orchestrator
+  description: 'Configured host: orchestrator.aspera-emea.com'
+paths:
+  "/api/login":
+    post:
+      summary: Authenticate and obtain JWT token
+      tags:
+      - Authentication
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - username
+              - password
+              properties:
+                username:
+                  type: string
+                  description: User login name
+                password:
+                  type: string
+                  format: password
+                  description: User password
+      responses:
+        '200':
+          description: Successfully authenticated
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Logged in successfully
+                  user:
+                    type: object
+                    properties:
+                      id:
+                        type: integer
+                      login:
+                        type: string
+                      email:
+                        type: string
+                  token:
+                    type: string
+                    description: JWT token for subsequent API calls
+        '401':
+          description: Invalid credentials
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    example: Invalid credentials
+        '403':
+          description: Secure API auth disabled
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    example: Secure API authentication is disabled
+  "/api/workflows_list":
+    get:
+      summary: List all workflows
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+        description: Response format (xml or json)
+        example: json
+      responses:
+        '200':
+          description: List of workflows
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      example: 123
+                    name:
+                      type: string
+                      example: Video Transcoding Workflow
+                    status:
+                      type: string
+                      example: active
+                    description:
+                      type: string
+                      example: Converts video files to multiple formats
+            application/xml:
+              schema:
+                type: string
+                example: |
+                  <?xml version="1.0"?>
+                  <workflows>
+                    <workflow>
+                      <id>123</id>
+                      <name>Video Transcoding Workflow</name>
+                    </workflow>
+                  </workflows>
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/workflows_status":
+    get:
+      summary: Get workflow status
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Workflow ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Workflow status information
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Workflow not found
+  "/api/workflow_details":
+    get:
+      summary: Get detailed workflow information
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Workflow ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Detailed workflow information
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Workflow not found
+  "/api/workflow_inputs_spec":
+    get:
+      summary: Get workflow input specifications
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Workflow ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Workflow input specifications
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/workflow_outputs_spec":
+    get:
+      summary: Get workflow output specifications
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Workflow ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Workflow output specifications
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/import_workflow":
+    post:
+      summary: Import a workflow
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/xml:
+            schema:
+              type: string
+              description: Workflow definition in XML format
+              example: |
+                <?xml version="1.0"?>
+                <workflow>
+                  <name>My Workflow</name>
+                  <description>Workflow description</description>
+                </workflow>
+          application/json:
+            schema:
+              type: object
+              required:
+              - name
+              properties:
+                name:
+                  type: string
+                  description: Workflow name
+                  example: My Workflow
+                description:
+                  type: string
+                  description: Workflow description
+                  example: This is a sample workflow
+                workflow_data:
+                  type: object
+                  description: Complete workflow definition
+      responses:
+        '200':
+          description: Workflow imported successfully
+        '400':
+          description: Invalid workflow data
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/find_constraints":
+    get:
+      summary: Find workflow import constraints
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      responses:
+        '200':
+          description: List of constraints found
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/import_with_constraints":
+    post:
+      summary: Import workflow with constraint resolution
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - workflow_data
+              - constraints
+              properties:
+                workflow_data:
+                  type: object
+                  description: Complete workflow definition to import
+                  example:
+                    name: My Workflow
+                    description: Workflow with constraints
+                constraints:
+                  type: object
+                  description: Constraint resolution mappings for conflicting resources
+                  example:
+                    resource_pools: {}
+                    queues: {}
+                    monitors: {}
+      responses:
+        '200':
+          description: Workflow imported successfully
+        '400':
+          description: Invalid workflow data or constraints
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/publish_workflow":
+    post:
+      summary: Publish a workflow
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - workflow_id
+              properties:
+                workflow_id:
+                  type: integer
+                  description: ID of the workflow to publish
+                  example: 123
+      responses:
+        '200':
+          description: Workflow published successfully
+        '400':
+          description: Invalid workflow ID
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Workflow not found
+  "/api/work_orders_list":
+    get:
+      summary: List work orders
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: workflow_id
+        in: query
+        schema:
+          type: integer
+        description: Filter by workflow ID
+        example: 123
+      - name: status
+        in: query
+        schema:
+          type: string
+          enum:
+          - queued
+          - running
+          - completed
+          - failed
+          - cancelled
+        description: Filter by work order status
+        example: running
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+        description: Response format
+        example: json
+      responses:
+        '200':
+          description: List of work orders
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                      example: 456
+                    workflow_id:
+                      type: integer
+                      example: 123
+                    status:
+                      type: string
+                      example: running
+                    created_at:
+                      type: string
+                      format: date-time
+                      example: '2026-06-11T10:30:00Z'
+                    progress:
+                      type: integer
+                      example: 75
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/work_order_status":
+    get:
+      summary: Get work order status
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work order ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Work order status
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Work order not found
+  "/api/work_order_output":
+    get:
+      summary: Get work order output
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work order ID
+      responses:
+        '200':
+          description: Work order output data
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/work_order_cancel":
+    get:
+      summary: Cancel a work order
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work order ID
+      responses:
+        '200':
+          description: Work order cancelled successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Work order not found
+  "/api/work_order_reset":
+    get:
+      summary: Reset a work order
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work order ID
+      responses:
+        '200':
+          description: Work order reset successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Work order not found
+  "/api/work_order_destroy":
+    get:
+      summary: Destroy a work order
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work order ID
+      responses:
+        '200':
+          description: Work order destroyed successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/initiate":
+    post:
+      summary: Initiate a new work order
+      description: |
+        Starts a new work order for the specified workflow.
+        **Important:** The `parameters` object should contain workflow-specific input values.
+        To discover what parameters a workflow accepts, call `/api/workflow_inputs_spec?id={workflow_id}` first.
+      tags:
+      - Work Orders
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - workflow_id
+              properties:
+                workflow_id:
+                  type: integer
+                  description: ID of the workflow to execute
+                  example: 123
+                parameters:
+                  type: object
+                  description: |
+                    Input parameters for the workflow (key-value pairs).
+                    Valid keys are defined by the workflow's input specification.
+                    Use `/api/workflow_inputs_spec?id={workflow_id}` to discover required parameters.
+                  additionalProperties: true
+                  example:
+                    input_file: "/path/to/source/video.mp4"
+                    output_format: mp4
+                    quality: high
+                    bitrate: 5000k
+      responses:
+        '200':
+          description: Work order initiated successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  work_order_id:
+                    type: integer
+                    description: ID of the newly created work order
+                    example: 456
+                  status:
+                    type: string
+                    description: Initial status of the work order
+                    example: queued
+                    enum:
+                    - queued
+                    - running
+              example:
+                work_order_id: 456
+                status: queued
+        '400':
+          description: Invalid request or missing required workflow parameters
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    example: 'Missing required parameter: input_file'
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Workflow not found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    example: Workflow with ID 123 not found
+  "/api/work_step_status":
+    get:
+      summary: Get work step status
+      tags:
+      - Work Steps
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work step ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Work step status
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/work_step_cancel":
+    get:
+      summary: Cancel a work step
+      tags:
+      - Work Steps
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work step ID
+      responses:
+        '200':
+          description: Work step cancelled successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/workstep_reset":
+    get:
+      summary: Reset a work step
+      tags:
+      - Work Steps
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Work step ID
+      responses:
+        '200':
+          description: Work step reset successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/queued_items":
+    get:
+      summary: List queued items
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: queue_id
+        in: query
+        schema:
+          type: integer
+        description: Filter by queue ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: List of queued items
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/queues_list":
+    get:
+      summary: List all queues
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: List of queues
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/queue_item":
+    get:
+      summary: Add item to queue
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: queue_id
+        in: query
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Item queued successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/lookup_queued_item":
+    get:
+      summary: Lookup a specific queued item
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Queued item ID
+      responses:
+        '200':
+          description: Queued item details
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/reorder_queued_item":
+    get:
+      summary: Reorder a queued item
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Queued item ID
+      - name: position
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: New position in queue
+      responses:
+        '200':
+          description: Item reordered successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/bulk_reorder_queue":
+    get:
+      summary: Bulk reorder queue items
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: queue_id
+        in: query
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Queue reordered successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/delete_queued_item":
+    get:
+      summary: Delete a queued item
+      tags:
+      - Queues
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Queued item ID
+      responses:
+        '200':
+          description: Item deleted successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/monitor_snapshot":
+    get:
+      summary: Get monitor snapshot
+      tags:
+      - Monitors
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Monitor ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Monitor snapshot data
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Monitor not found
+  "/api/list_monitors":
+    get:
+      summary: List all monitors
+      tags:
+      - Monitors
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: List of monitors
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/activate_monitor":
+    get:
+      summary: Activate a monitor
+      tags:
+      - Monitors
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Monitor ID
+      responses:
+        '200':
+          description: Monitor activated successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Monitor not found
+  "/api/deactivate_monitor":
+    get:
+      summary: Deactivate a monitor
+      tags:
+      - Monitors
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Monitor ID
+      responses:
+        '200':
+          description: Monitor deactivated successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Monitor not found
+  "/api/list_tasks":
+    get:
+      summary: List available tasks
+      tags:
+      - Tasks
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: List of tasks
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/task_details":
+    get:
+      summary: Get task details
+      tags:
+      - Tasks
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Task ID
+      responses:
+        '200':
+          description: Task details
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/submit_task":
+    get:
+      summary: Submit a task for execution
+      tags:
+      - Tasks
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: task_id
+        in: query
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Task submitted successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/search_tasks":
+    get:
+      summary: Search for tasks
+      tags:
+      - Tasks
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: query
+        in: query
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: Search results
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/plugin_version":
+    get:
+      summary: Get plugin version information
+      tags:
+      - Plugins
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: plugin_name
+        in: query
+        required: true
+        schema:
+          type: string
+        description: Plugin name
+      responses:
+        '200':
+          description: Plugin version information
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Plugin not found
+  "/api/reload_plugin":
+    get:
+      summary: Reload a plugin
+      tags:
+      - Plugins
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: plugin_name
+        in: query
+        required: true
+        schema:
+          type: string
+        description: Plugin name
+      responses:
+        '200':
+          description: Plugin reloaded successfully
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Plugin not found
+  "/api/reload_plugin_set":
+    post:
+      summary: Reload a set of plugins
+      tags:
+      - Plugins
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - plugin_names
+              properties:
+                plugin_names:
+                  type: array
+                  description: List of plugin names to reload
+                  items:
+                    type: string
+                  example:
+                  - soap_requests
+                  - frameio_operations
+      responses:
+        '200':
+          description: Plugins reloaded successfully
+        '400':
+          description: Invalid plugin names
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/enable_plugin":
+    post:
+      summary: Enable a plugin
+      tags:
+      - Plugins
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - plugin_name
+              properties:
+                plugin_name:
+                  type: string
+                  description: Name of the plugin to enable
+                  example: soap_requests
+      responses:
+        '200':
+          description: Plugin enabled successfully
+        '400':
+          description: Invalid plugin name
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Plugin not found
+  "/api/import_plugin":
+    post:
+      summary: Import a plugin
+      tags:
+      - Plugins
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required:
+              - plugin_file
+              properties:
+                plugin_file:
+                  type: string
+                  format: binary
+                  description: Plugin archive file (zip or tar.gz)
+      responses:
+        '200':
+          description: Plugin imported successfully
+        '400':
+          description: Invalid plugin file
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/portlet_version":
+    get:
+      summary: Get portlet version information
+      tags:
+      - Portlets
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: portlet_name
+        in: query
+        required: true
+        schema:
+          type: string
+        description: Portlet name
+      responses:
+        '200':
+          description: Portlet version information
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/processes_status":
+    get:
+      summary: Get process status information
+      tags:
+      - System
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+      responses:
+        '200':
+          description: Process status information
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/control_process":
+    get:
+      summary: Control orchestrator processes
+      tags:
+      - System
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: action
+        in: query
+        required: true
+        schema:
+          type: string
+          enum:
+          - start
+          - stop
+          - restart
+          - status
+      responses:
+        '200':
+          description: Process control command executed
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/custom_api_call":
+    get:
+      summary: Execute custom API call
+      tags:
+      - System
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: call_name
+        in: query
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          description: Custom call executed
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/execution_queue_stats":
+    get:
+      summary: Get execution queue statistics
+      tags:
+      - System
+      security:
+      - bearerAuth: []
+      responses:
+        '200':
+          description: Queue statistics
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/alerts":
+    get:
+      summary: Get system alerts
+      tags:
+      - System
+      security:
+      - bearerAuth: []
+      responses:
+        '200':
+          description: List of alerts
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/remote_node_ping":
+    get:
+      summary: Ping a remote node
+      tags:
+      - Remote Nodes
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Remote node ID
+      responses:
+        '200':
+          description: Ping successful
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Remote node not found
+  "/api/test_step":
+    get:
+      summary: Test a workflow step
+      tags:
+      - Testing
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: step_id
+        in: query
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Test initiated
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/test_step_status":
+    get:
+      summary: Get test step status
+      tags:
+      - Testing
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: test_id
+        in: query
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Test status
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/work_order_stats":
+    get:
+      summary: Get work order statistics
+      tags:
+      - Statistics
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: workflow_id
+        in: query
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Work order statistics
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/work_step_stats":
+    get:
+      summary: Get work step statistics
+      tags:
+      - Statistics
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: workflow_id
+        in: query
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Work step statistics
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/journal_files":
+    get:
+      summary: Get journal files
+      tags:
+      - Journals
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: work_order_id
+        in: query
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: List of journal files
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/add_resource":
+    post:
+      summary: Add a managed resource
+      tags:
+      - Resources
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - pool_id
+              - resource_name
+              - capacity
+              properties:
+                pool_id:
+                  type: integer
+                  description: ID of the resource pool
+                  example: 1
+                resource_name:
+                  type: string
+                  description: Name of the resource to add
+                  example: encoder-01
+                capacity:
+                  type: integer
+                  description: Resource capacity (number of concurrent jobs)
+                  example: 5
+                  minimum: 0
+      responses:
+        '200':
+          description: Resource added successfully
+        '400':
+          description: Invalid resource data
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Resource pool not found
+  "/api/edit_resource_capacity":
+    post:
+      summary: Edit resource capacity
+      tags:
+      - Resources
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - resource_id
+              - capacity
+              properties:
+                resource_id:
+                  type: integer
+                  description: ID of the resource to modify
+                  example: 42
+                capacity:
+                  type: integer
+                  description: New capacity value
+                  example: 10
+                  minimum: 0
+      responses:
+        '200':
+          description: Resource capacity updated
+        '400':
+          description: Invalid capacity value
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Resource not found
+  "/api/edit_pool_capacity":
+    post:
+      summary: Edit resource pool capacity
+      tags:
+      - Resources
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - pool_id
+              - capacity
+              properties:
+                pool_id:
+                  type: integer
+                  description: ID of the resource pool to modify
+                  example: 1
+                capacity:
+                  type: integer
+                  description: New pool capacity value
+                  example: 20
+                  minimum: 0
+      responses:
+        '200':
+          description: Pool capacity updated
+        '400':
+          description: Invalid capacity value
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Resource pool not found
+  "/api/resource_online":
+    post:
+      summary: Bring resource online
+      tags:
+      - Resources
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - resource_id
+              properties:
+                resource_id:
+                  type: integer
+                  description: ID of the resource to bring online
+                  example: 42
+      responses:
+        '200':
+          description: Resource brought online
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Resource not found
+  "/api/resource_offline":
+    post:
+      summary: Take resource offline
+      tags:
+      - Resources
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - resource_id
+              properties:
+                resource_id:
+                  type: integer
+                  description: ID of the resource to take offline
+                  example: 42
+      responses:
+        '200':
+          description: Resource taken offline
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Resource not found
+  "/api/pool_status":
+    get:
+      summary: Get resource pool status
+      tags:
+      - Resources
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: pool_id
+        in: query
+        required: true
+        schema:
+          type: integer
+      responses:
+        '200':
+          description: Pool status information
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/export_workflow":
+    get:
+      summary: Export a workflow
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Workflow ID to export
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          - yaml
+          default: json
+        description: Export format
+      responses:
+        '200':
+          description: Workflow exported successfully
+          content:
+            application/xml:
+              schema:
+                type: string
+            application/json:
+              schema:
+                type: object
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+        '404':
+          description: Workflow not found
+  "/api/list_by_subworkflow":
+    get:
+      summary: List workflows by subworkflow
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: id
+        in: query
+        required: true
+        schema:
+          type: integer
+        description: Subworkflow ID
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+        description: Response format
+      responses:
+        '200':
+          description: List of parent workflows containing the subworkflow
+          content:
+            application/xml:
+              schema:
+                type: string
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    id:
+                      type: integer
+                    name:
+                      type: string
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/retrieve_steps":
+    get:
+      summary: Retrieve steps by type
+      tags:
+      - Workflows
+      security:
+      - bearerAuth: []
+      parameters:
+      - name: type
+        in: query
+        required: true
+        schema:
+          type: string
+        description: Step type to retrieve
+      - name: format
+        in: query
+        schema:
+          type: string
+          enum:
+          - xml
+          - json
+          default: json
+        description: Response format
+      responses:
+        '200':
+          description: List of steps matching the type
+          content:
+            application/xml:
+              schema:
+                type: string
+            application/json:
+              schema:
+                type: array
+                items:
+                  type: object
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+  "/api/create_user":
+    post:
+      summary: Create a new user
+      tags:
+      - Users
+      security:
+      - bearerAuth: []
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required:
+              - username
+              - password
+              - email
+              properties:
+                username:
+                  type: string
+                  description: Unique username for login
+                  example: john.doe
+                  minLength: 3
+                  maxLength: 50
+                password:
+                  type: string
+                  format: password
+                  description: User password (must meet security requirements)
+                  example: "*********"
+                  minLength: 8
+                email:
+                  type: string
+                  format: email
+                  description: User email address
+                  example: john.doe@example.com
+                full_name:
+                  type: string
+                  description: Full name of the user
+                  example: John Doe
+                  maxLength: 100
+      responses:
+        '200':
+          description: User created successfully
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  user_id:
+                    type: integer
+                    example: 789
+                  message:
+                    type: string
+                    example: User created successfully
+        '400':
+          description: Invalid user data or username already exists
+        '401':
+          "$ref": "#/components/responses/UnauthorizedError"
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+      description: JWT token obtained from /api/login endpoint
+  responses:
+    UnauthorizedError:
+      description: Authentication required or token invalid
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+                example: Unauthorized
+tags:
+- name: Authentication
+  description: Obtain JWT tokens for API access. All other endpoints require authentication.
+- name: Workflows
+  description: Create, import, export, and manage workflow definitions. Workflows define the automation logic.
+- name: Work Orders
+  description: Initiate and track workflow executions. Each work order represents a single workflow run.
+- name: Work Steps
+  description: Monitor and control individual steps within work orders. Steps are the atomic units of workflow execution.
+- name: Queues
+  description: Manage execution queues and prioritize work items. Control the order and timing of workflow execution.
+- name: Monitors
+  description: Configure and control workflow monitors. Monitors automatically trigger workflows based on events or schedules.
+- name: Tasks
+  description: Submit and track one-off tasks. Tasks are standalone operations not tied to workflows.
+- name: Plugins
+  description: Install, enable, and reload action plugins. Plugins extend Orchestrator with new capabilities.
+- name: Portlets
+  description: Query portlet version information. Portlets provide UI components for the Orchestrator interface.
+- name: System
+  description: Monitor system health, control processes, and access system-wide information.
+- name: Remote Nodes
+  description: Test connectivity and manage remote Orchestrator nodes in distributed deployments.
+- name: Testing
+  description: Test workflow steps in isolation before deploying to production workflows.
+- name: Statistics
+  description: Retrieve execution statistics and performance metrics for workflows and work orders.
+- name: Journals
+  description: Access detailed execution logs and journal files for troubleshooting and auditing.
+- name: Resources
+  description: Manage resource pools and capacity allocation for workflow execution. Control concurrency limits.
+- name: Users
+  description: Create and manage user accounts for Orchestrator access.