flow_framework.yaml

openapi: 3.1.0
info:
  title: OpenSearch Flow Framework API
  description: OpenSearch Flow Framework API.
  version: 1.0.0
paths:
  /_plugins/_flow_framework/workflow:
    post:
      operationId: flow_framework.create.0
      x-operation-group: flow_framework.create
      x-version-added: '2.12'
      description: Create a workflow.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/
      parameters:
        - $ref: '#/components/parameters/flow_framework.create::query.provision'
        - $ref: '#/components/parameters/flow_framework.create::query.reprovision'
        - $ref: '#/components/parameters/flow_framework.create::query.update_fields'
        - $ref: '#/components/parameters/flow_framework.create::query.use_case'
        - $ref: '#/components/parameters/flow_framework.create::query.validation'
      requestBody:
        $ref: '#/components/requestBodies/flow_framework.create'
      responses:
        '201':
          $ref: '#/components/responses/flow_framework.create@201'
        '403':
          $ref: '#/components/responses/flow_framework.create@403'
        '400':
          $ref: '#/components/responses/flow_framework.create@400'
  /_plugins/_flow_framework/workflow/{workflow_id}:
    get:
      operationId: flow_framework.get.0
      x-operation-group: flow_framework.get
      x-version-added: '2.12'
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow/
      description: Get a workflow.
      parameters:
        - $ref: '#/components/parameters/flow_framework.get::path.workflow_id'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.get@200'
        '404':
          $ref: '#/components/responses/flow_framework.get@404'
    put:
      operationId: flow_framework.update.0
      x-operation-group: flow_framework.update
      x-version-added: '2.12'
      description: Update a workflow. You can only update a complete workflow if it has not yet been provisioned.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/
      parameters:
        - $ref: '#/components/parameters/flow_framework.update::path.workflow_id'
        - $ref: '#/components/parameters/flow_framework.update::query.provision'
        - $ref: '#/components/parameters/flow_framework.update::query.reprovision'
        - $ref: '#/components/parameters/flow_framework.update::query.update_fields'
        - $ref: '#/components/parameters/flow_framework.update::query.use_case'
        - $ref: '#/components/parameters/flow_framework.update::query.validation'
      requestBody:
        $ref: '#/components/requestBodies/flow_framework.update'
      responses:
        '201':
          $ref: '#/components/responses/flow_framework.update@201'
          description: It returns the `workflow_id`.
        '404':
          $ref: '#/components/responses/flow_framework.update@404'
        '400':
          $ref: '#/components/responses/flow_framework.update@400'
    delete:
      operationId: flow_framework.delete.0
      x-operation-group: flow_framework.delete
      x-version-added: '2.12'
      description: Delete a workflow.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/delete-workflow/
      parameters:
        - $ref: '#/components/parameters/flow_framework.delete::path.workflow_id'
        - $ref: '#/components/parameters/flow_framework.delete::query.clear_status'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.delete@200'
        '400':
          $ref: '#/components/responses/flow_framework.delete@400'
        '403':
          $ref: '#/components/responses/flow_framework.delete@403'
  /_plugins/_flow_framework/workflow/_steps:
    get:
      operationId: flow_framework.get_steps.0
      x-operation-group: flow_framework.get_steps
      x-version-added: '2.12'
      description: Get a list of workflow steps.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-steps/
      parameters:
        - $ref: '#/components/parameters/flow_framework.get_steps::query.workflow_step'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.get_steps@200'
        '403':
          $ref: '#/components/responses/flow_framework.get_steps@403'
        '400':
          $ref: '#/components/responses/flow_framework.get_steps@400'
  /_plugins/_flow_framework/workflow/{workflow_id}/_status:
    get:
      operationId: flow_framework.get_status.0
      x-operation-group: flow_framework.get_status
      x-version-added: '2.12'
      description: Get the provisioning deployment status until it is complete.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/get-workflow-status/
      parameters:
        - $ref: '#/components/parameters/flow_framework.get_status::path.workflow_id'
        - $ref: '#/components/parameters/flow_framework.get_status::query.all'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.get_status@200'
        '403':
          $ref: '#/components/responses/flow_framework.get_status@403'
        '404':
          $ref: '#/components/responses/flow_framework.get_status@404'
  /_plugins/_flow_framework/workflow/{workflow_id}/_deprovision:
    post:
      operationId: flow_framework.deprovision.0
      x-operation-group: flow_framework.deprovision
      x-version-added: '2.12'
      description: Deprovision workflow's resources when you no longer need it.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/deprovision-workflow/
      parameters:
        - $ref: '#/components/parameters/flow_framework.deprovision::path.workflow_id'
        - $ref: '#/components/parameters/flow_framework.deprovision::query.allow_delete'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.deprovision@200'
        '202':
          $ref: '#/components/responses/flow_framework.deprovision@202'
        '403':
          $ref: '#/components/responses/flow_framework.deprovision@403'
        '404':
          $ref: '#/components/responses/flow_framework.deprovision@404'
  /_plugins/_flow_framework/workflow/{workflow_id}/_provision:
    post:
      operationId: flow_framework.provision.0
      x-operation-group: flow_framework.provision
      x-version-added: '2.12'
      description: Provisioning a workflow. This API is also executed when the Create or Update Workflow API is called with the provision parameter set to true.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/
      parameters:
        - $ref: '#/components/parameters/flow_framework.provision::path.workflow_id'
      requestBody:
        description: |-
          Pass dynamic substitution expressions as key-value pairs, either as query parameters or in the request body.
          For example, if you specified a credential field in the template as `openai_key: '$'`,
          you can pass `openai_key` as a query parameter or in the request body.
        $ref: '#/components/requestBodies/flow_framework.provision'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.provision@200'
        '403':
          $ref: '#/components/responses/flow_framework.provision@403'
        '400':
          $ref: '#/components/responses/flow_framework.provision@400'
  /_plugins/_flow_framework/workflow/_search:
    get:
      operationId: flow_framework.search.1
      x-operation-group: flow_framework.search
      x-version-added: '2.12'
      description: Search for workflows by using a query matching a field.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/
      requestBody:
        $ref: '#/components/requestBodies/flow_framework.search'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.search@200'
        '403':
          $ref: '#/components/responses/flow_framework.search@403'
        '408':
          $ref: '#/components/responses/flow_framework.search@408'
        '400':
          $ref: '#/components/responses/flow_framework.search@400'
    post:
      operationId: flow_framework.search.0
      x-operation-group: flow_framework.search
      x-version-added: '2.12'
      description: Search for workflows by using a query matching a field.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/provision-workflow/
      requestBody:
        $ref: '#/components/requestBodies/flow_framework.search'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.search@200'
        '403':
          $ref: '#/components/responses/flow_framework.search@403'
        '408':
          $ref: '#/components/responses/flow_framework.search@408'
        '400':
          $ref: '#/components/responses/flow_framework.search@400'
  /_plugins/_flow_framework/workflow/state/_search:
    get:
      operationId: flow_framework.search_state.1
      x-operation-group: flow_framework.search_state
      x-version-added: '2.12'
      description: Search for workflows by using a query matching a field.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/
      requestBody:
        $ref: '#/components/requestBodies/flow_framework.search_state'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.search_state@200'
        '403':
          $ref: '#/components/responses/flow_framework.search_state@403'
        '408':
          $ref: '#/components/responses/flow_framework.search_state@408'
        '400':
          $ref: '#/components/responses/flow_framework.search_state@400'
    post:
      operationId: flow_framework.search_state.0
      x-operation-group: flow_framework.search_state
      x-version-added: '2.12'
      description: Search for workflows by using a query matching a field.
      externalDocs:
        url: https://opensearch.org/docs/latest/automating-configurations/api/search-workflow-state/
      requestBody:
        $ref: '#/components/requestBodies/flow_framework.search_state'
      responses:
        '200':
          $ref: '#/components/responses/flow_framework.search_state@200'
        '403':
          $ref: '#/components/responses/flow_framework.search_state@403'
        '408':
          $ref: '#/components/responses/flow_framework.search_state@408'
        '400':
          $ref: '#/components/responses/flow_framework.search_state@400'
components:
  parameters:
    flow_framework.get::path.workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowID'
    flow_framework.get_status::path.workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowID'
    flow_framework.deprovision::path.workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowID'
    flow_framework.provision::path.workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowID'
    flow_framework.update::path.workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowID'
    flow_framework.delete::path.workflow_id:
      name: workflow_id
      in: path
      required: true
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowID'
    flow_framework.create::query.provision:
      in: query
      name: provision
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Provision'
    flow_framework.update::query.provision:
      in: query
      name: provision
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Provision'
    flow_framework.create::query.reprovision:
      x-version-added: '2.17'
      in: query
      name: reprovision
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Reprovision'
    flow_framework.deprovision::query.allow_delete:
      in: query
      name: allow_delete
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/AllowDelete'
    flow_framework.update::query.reprovision:
      x-version-added: '2.17'
      in: query
      name: reprovision
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Reprovision'
    flow_framework.create::query.use_case:
      description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow.
      in: query
      name: use_case
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/UseCase'
    flow_framework.get_status::query.all:
      description: The all parameter specifies whether the response should return all fields.
      in: query
      name: all
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/All'
    flow_framework.update::query.use_case:
      description: To use a workflow template, specify it in the `use_case` query parameter when creating a workflow.
      in: query
      name: use_case
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/UseCase'
    flow_framework.create::query.validation:
      in: query
      name: validation
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Validation'
    flow_framework.update::query.validation:
      in: query
      name: validation
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/Validation'
    flow_framework.update::query.update_fields:
      in: query
      name: update_fields
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/UpdateFields'
    flow_framework.create::query.update_fields:
      in: query
      name: update_fields
      schema:
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/UpdateFields'
    flow_framework.delete::query.clear_status:
      in: query
      name: clear_status
      schema:
        description: Delete the workflow state (without deprovisioning resources) after deleting the template. OpenSearch deletes the workflow state only if the provisioning status is not IN_PROGRESS. Default is false.
        type: boolean
        default: false
    flow_framework.get_steps::query.workflow_step:
      in: query
      name: workflow_step
      required: false
      schema:
        description: The name of the step to retrieve.
        $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowStepName'
  requestBodies:
    flow_framework.create:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/FlowFrameworkCreate'
    flow_framework.update:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/FlowFrameworkUpdate'
    flow_framework.provision:
      required: false
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/UserProvidedSubstitutionExpressions'
    flow_framework.search:
      required: true
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/SearchWorkflowRequest'
    flow_framework.search_state:
      required: true
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/SearchWorkflowRequest'
  responses:
    flow_framework.create@201:
      content:
        application/json:
          schema:
            type: object
            properties:
              workflow_id:
                type: string
                description: The ID of the workflow to be updated. Required for the PUT method.
            required:
              - workflow_id
    flow_framework.create@403:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.create@400:
      description: Bad Request - Multiple possible reasons
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidParameterError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/ConflictError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/MissingParameterError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/ParameterConflictError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/MaxWorkflowsLimitError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowSaveError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowParsingError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/UnsupportedFieldUpdateError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidTemplateVersionError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNameRequiredError'
    flow_framework.update@400:
      description: Bad Request - Multiple possible reasons
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidParameterError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/ConflictError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/MissingParameterError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/ParameterConflictError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/MaxWorkflowsLimitError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowSaveError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidTemplateVersionError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/UnsupportedFieldUpdateError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowParsingError'
    flow_framework.update@201:
      content:
        application/json:
          schema:
            type: object
            properties:
              workflow_id:
                type: string
                description: The ID of the workflow to be updated. Required for the PUT method.
            required:
              - workflow_id
    flow_framework.delete@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/FlowFrameworkDeleteResponse'
    flow_framework.get@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/FlowFrameworkGetResponse'
    flow_framework.update@404:
      description: Template Not Found Error
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNotFoundError'
    flow_framework.delete@400:
      description: Work Flow Id Null Error
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkFlowIdNullError'
    flow_framework.delete@403:
      description: Flow Framework API Disabled Error
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.get@404:
      description: Template Not Found Error
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNotFoundError'
    flow_framework.get_steps@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowSteps'
    flow_framework.get_steps@403:
      description: Flow Framework API Disabled Error
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.get_steps@400:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkflowStepsRetrieveError'
    flow_framework.get_status@403:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.get_status@404:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNotFoundError'
    flow_framework.get_status@200:
      content:
        application/json:
          schema:
            anyOf:
              - $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkFlowStatusFullResponse'
              - $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkFlowStatusDefaultResponse'
    flow_framework.deprovision@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowIDResponse'
    flow_framework.provision@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowIDResponse'
    flow_framework.deprovision@202:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/DeprovisioningError'
    flow_framework.deprovision@403:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/DeprovisioningForbiddenError'
    flow_framework.deprovision@404:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/TemplateNotFoundError'
    flow_framework.provision@403:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.provision@400:
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/WorkFlowIdNullError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/RequestBodyParsingFailedError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/InvalidRequestBodyFieldError'
              - $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/DuplicateKeyError'
    flow_framework.search@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowSearchResponse'
    flow_framework.search@403:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.search@408:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/RequestTimeoutError'
    flow_framework.search@400:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/BadRequestError'
    flow_framework.search_state@200:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.common.yaml#/components/schemas/WorkflowSearchStateResponse'
    flow_framework.search_state@403:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/FlowFrameworkAPIDisabledError'
    flow_framework.search_state@408:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/RequestTimeoutError'
    flow_framework.search_state@400:
      content:
        application/json:
          schema:
            $ref: '../schemas/flow_framework.errors.yaml#/components/schemas/BadRequestError'