Microsoft Purview Workflow API — Workflow

naftiko: 1.0.0-alpha2
info:
  label: Microsoft Purview Workflow API — Workflow
  description: 'Microsoft Purview Workflow API — Workflow. 4 operations. Lead operation: Microsoft Purview Create or replace
    a workflow. Self-contained Naftiko capability covering one Microsoft Purview business surface.'
  tags:
  - Microsoft Purview
  - Workflow
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_PURVIEW_API_KEY: MICROSOFT_PURVIEW_API_KEY
capability:
  consumes:
  - type: http
    namespace: workflow-workflow
    baseUri: https://{accountName}.purview.azure.com/workflow
    description: Microsoft Purview Workflow API — Workflow business capability. Self-contained, no shared references.
    resources:
    - name: workflows-workflowId
      path: /workflows/{workflowId}
      operations:
      - name: createorreplaceworkflow
        method: PUT
        description: Microsoft Purview Create or replace a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          description: The workflow identifier
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getworkflow
        method: GET
        description: Microsoft Purview Get a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
      - name: deleteworkflow
        method: DELETE
        description: Microsoft Purview Delete a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
    - name: workflows-workflowId-validate
      path: /workflows/{workflowId}/validate
      operations:
      - name: validateworkflow
        method: POST
        description: Microsoft Purview Validate a workflow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workflowId
          in: path
          type: string
          required: true
        - name: api-version
          in: query
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_PURVIEW_API_KEY}}'
  exposes:
  - type: rest
    namespace: workflow-workflow-rest
    port: 8080
    description: REST adapter for Microsoft Purview Workflow API — Workflow. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/workflows/{workflowid}
      name: workflows-workflowid
      description: REST surface for workflows-workflowId.
      operations:
      - method: PUT
        name: createorreplaceworkflow
        description: Microsoft Purview Create or replace a workflow
        call: workflow-workflow.createorreplaceworkflow
        with:
          workflowId: rest.workflowId
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getworkflow
        description: Microsoft Purview Get a workflow
        call: workflow-workflow.getworkflow
        with:
          workflowId: rest.workflowId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteworkflow
        description: Microsoft Purview Delete a workflow
        call: workflow-workflow.deleteworkflow
        with:
          workflowId: rest.workflowId
          api-version: rest.api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workflows/{workflowid}/validate
      name: workflows-workflowid-validate
      description: REST surface for workflows-workflowId-validate.
      operations:
      - method: POST
        name: validateworkflow
        description: Microsoft Purview Validate a workflow
        call: workflow-workflow.validateworkflow
        with:
          workflowId: rest.workflowId
          api-version: rest.api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: workflow-workflow-mcp
    port: 9090
    transport: http
    description: MCP adapter for Microsoft Purview Workflow API — Workflow. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: microsoft-purview-create-replace-workflow
      description: Microsoft Purview Create or replace a workflow
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: workflow-workflow.createorreplaceworkflow
      with:
        workflowId: tools.workflowId
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-get-workflow
      description: Microsoft Purview Get a workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: workflow-workflow.getworkflow
      with:
        workflowId: tools.workflowId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-delete-workflow
      description: Microsoft Purview Delete a workflow
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: workflow-workflow.deleteworkflow
      with:
        workflowId: tools.workflowId
        api-version: tools.api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: microsoft-purview-validate-workflow
      description: Microsoft Purview Validate a workflow
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: workflow-workflow.validateworkflow
      with:
        workflowId: tools.workflowId
        api-version: tools.api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.