Brainfish · Arazzo Workflow

Create and sync an API catalog

Version 1.0.0

Create a catalog, sync content into it, then read back its status.

1 workflow 1 source API 1 provider
View Spec View on GitHub CompanyAICustomer SupportKnowledge BaseHelp DeskAgentsSupport AutomationSaaSArazzoWorkflows

Provider

brainfish

Workflows

catalog-sync
Create a catalog, sync content, and verify.
3 steps inputs: catalogName, content outputs: catalogId
1
createCatalog
createCatalog
2
syncContent
syncCatalogContent
3
verify
getCatalog

Source API Descriptions

Arazzo Workflow Specification

Raw ↑
arazzo: 1.0.1
info:
  title: Create and sync an API catalog
  version: 1.0.0
  summary: Create a catalog, sync content into it, then read back its status.
sourceDescriptions:
  - name: brainfish
    url: ../openapi/brainfish-public-api-openapi-original.json
    type: openapi
workflows:
  - workflowId: catalog-sync
    summary: Create a catalog, sync content, and verify.
    inputs:
      type: object
      properties:
        catalogName: { type: string }
        content: { type: string }
    steps:
      - stepId: createCatalog
        operationId: createCatalog
        requestBody:
          contentType: application/json
          payload:
            name: $inputs.catalogName
        successCriteria:
          - condition: $statusCode == 200
        outputs:
          catalogId: $response.body#/id
      - stepId: syncContent
        operationId: syncCatalogContent
        parameters:
          - name: id
            in: path
            value: $steps.createCatalog.outputs.catalogId
        requestBody:
          contentType: application/json
          payload:
            content: $inputs.content
        successCriteria:
          - condition: $statusCode == 200
      - stepId: verify
        operationId: getCatalog
        parameters:
          - name: id
            in: path
            value: $steps.createCatalog.outputs.catalogId
        successCriteria:
          - condition: $statusCode == 200
    outputs:
      catalogId: $steps.createCatalog.outputs.catalogId