openapi.yaml

components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
info:
  title: cloudmesh-cc
  version: 4.4.1
openapi: 3.0.2
paths:
  /workflow/run/{workflow_name}:
    get:
      description: 'Run a specified workflow according to provided run type.


        Parameters:


        - **workflow_name**: (str) name of workflow to run

        - **run_type**: (str) how to run workflow. only topo is implemented

        (topological sort of jobs)

        - **redirect**: (str) where to redirect after initializing the run.

        only graph is implemented for web interface. None will disable redirect

        - **show**: (bool) whether to show the graph as the workflow is run'
      operationId: run_workflow_workflow_run__workflow_name__get
      parameters:
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      - in: query
        name: run_type
        required: false
        schema:
          default: topo
          title: Run Type
          type: string
      - in: query
        name: redirect
        required: false
        schema:
          title: Redirect
          type: string
      - in: query
        name: show
        required: false
        schema:
          default: false
          title: Show
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Run Workflow
      tags:
      - workflow
  /workflow/{workflow_name}:
    delete:
      description: 'Delete a workflow by name.


        deletes an entire workflow. if the job is specified, then deletes

        just the job in the workflow.


        Parameters:


        - **workflow_name**: (str) name of workflow to delete

        - **job**: (str) name of job to delete in a workflow, if specified'
      operationId: delete_workflow_workflow__workflow_name__delete
      parameters:
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      - in: query
        name: job
        required: false
        schema:
          title: Job
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Delete Workflow
      tags:
      - workflow
    get:
      description: 'Get a workflow.


        retrieves a workflow by its name. if the job is specified, retrieves

        just the job in the specified workflow


        Parameters:


        - **workflow_name**: (str) name of workflow to retrieve

        - **output**: (str) how to print workflow, which can be

        html, graph, json, table, or csv. if not specified, then returned as dict

        - **initialized**: (bool) indicates whether workflow has already been

        loaded for the first time. should be True when switching views'
      operationId: get_workflow_workflow__workflow_name__get
      parameters:
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      - in: query
        name: output
        required: false
        schema:
          title: Output
          type: string
      - in: query
        name: initialized
        required: false
        schema:
          default: false
          title: Initialized
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Workflow
      tags:
      - workflow
    post:
      description: 'Upload a workflow.


        Upload a workflow to the ~/.cloudmesh/workflow directory for running

        or editing.


        Parameters:


        - **directory**: (str) path to directory with workflow files

        - **archive**: (str) path to archive file, which can be tgx, xz, tar.gz,

        or tar, that contains workflow files

        - **yaml**: (str) path to yaml file that specifies workflow configuration

        - **workflow_name**: (str) name of workflow to be uploaded'
      operationId: upload_workflow_workflow__workflow_name__post
      parameters:
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      - description: path to workflow dir that contains scripts and yaml file
        in: query
        name: directory
        required: false
        schema:
          description: path to workflow dir that contains scripts and yaml file
          title: Directory
          type: string
      - description: path to archive file that can be tgx, xz, tar.gz, or tar
        in: query
        name: archive
        required: false
        schema:
          description: path to archive file that can be tgx, xz, tar.gz, or tar
          title: Archive
          type: string
      - description: path to yaml file for workflow
        in: query
        name: yaml
        required: false
        schema:
          description: path to yaml file for workflow
          title: Yaml
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Upload Workflow
      tags:
      - workflow
  /workflow/{workflow_name}/job/{job_name}:
    delete:
      description: 'Removes a job from a workflow.


        Parameters:


        - **job_name**: (str) the name of job to add

        - **workflow_name**: (str) the name of the workflow to add the job to'
      operationId: remove_job_workflow__workflow_name__job__job_name__delete
      parameters:
      - in: path
        name: job_name
        required: true
        schema:
          title: Job Name
          type: string
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Remove Job
      tags:
      - workflow
    get:
      description: 'Get a job that is inside a workflow.


        Retrieves a job by its name and its workflow''s name.


        Parameters:


        - **workflow_name**: (str) name of workflow that job resides in

        - **job_name**: (str) name of job to retrieve

        - **output**: (str) how to print workflow, which can be

        json or none. if not specified, then returned as dict'
      operationId: get_job_workflow__workflow_name__job__job_name__get
      parameters:
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      - in: path
        name: job_name
        required: true
        schema:
          title: Job Name
          type: string
      - in: query
        name: output
        required: false
        schema:
          title: Output
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Get Job
      tags:
      - workflow
    post:
      description: 'Adds a job to a workflow.


        A check

        is returned and the user is alerted if arguments are missing

        arguments are passed in ATTRIBUTE=VALUE fashion.

        if the name of the workflow is omitted, the default workflow is used.

        If no job name is specified, an automated number that is kept in the

        config.yaml file will be used and the name will be job-n


        Parameters:


        - **job_name**: (str) the name of job to add

        - **workflow_name**: (str) the name of the workflow to add the job to

        - **user**: (str) name of user of the job

        - **host**: (str) name of the host of the job

        - **kind**: (str) the kind of job, like ssh, slurm, local,

        - **status**: (str) the status of the job, such as ready,

        - **script**: (str) the name of the script to be run,

        including file extension

        - **exec**: (str) command(s) to execute

        - **progress**: (str) value of job progress from 0 to 100

        - **label**: (str) text to be shown on node in the graph

        - **parent**: (str) parent job'
      operationId: add_job_workflow__workflow_name__job__job_name__post
      parameters:
      - in: path
        name: job_name
        required: true
        schema:
          title: Job Name
          type: string
      - in: path
        name: workflow_name
        required: true
        schema:
          title: Workflow Name
          type: string
      - in: query
        name: user
        required: false
        schema:
          title: User
          type: string
      - in: query
        name: host
        required: false
        schema:
          title: Host
          type: string
      - in: query
        name: kind
        required: false
        schema:
          title: Kind
          type: string
      - in: query
        name: status
        required: false
        schema:
          title: Status
          type: string
      - in: query
        name: script
        required: false
        schema:
          title: Script
          type: string
      - in: query
        name: exec
        required: false
        schema:
          title: Exec
          type: string
      - in: query
        name: progress
        required: false
        schema:
          title: Progress
          type: string
      - in: query
        name: label
        required: false
        schema:
          title: Label
          type: string
      - in: query
        name: parent
        required: false
        schema:
          title: Parent
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: Add Job
      tags:
      - workflow
  /workflows:
    get:
      description: 'Return a list of all workflows found on local computer.


        Parameters:


        - **output**: (str) format to print available workflows, which can be

        json, csv, or none which prints it as dict


        :param output: format to print available workflows, which can be

        json, csv, or none which prints it as dict

        :type output: str

        :return: list of workflow names'
      operationId: list_workflows_workflows_get
      parameters:
      - in: query
        name: output
        required: false
        schema:
          title: Output
          type: string
      responses:
        '200':
          content:
            application/json:
              schema: {}
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      summary: List Workflows
      tags:
      - workflow