Azure Synapse Analytics - Pipeline API — Pipeline

naftiko: 1.0.0-alpha2
info:
  label: Azure Synapse Analytics - Pipeline API — Pipeline
  description: 'Azure Synapse Analytics - Pipeline API — Pipeline. 6 operations. Lead operation: Azure Synapse Analytics List
    pipelines. Self-contained Naftiko capability covering one Microsoft Azure Synapse Analytics business surface.'
  tags:
  - Microsoft Azure Synapse Analytics
  - Pipeline
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY: MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY
capability:
  consumes:
  - type: http
    namespace: azure-synapse-analytics-pipeline-pipeline
    baseUri: https://{workspaceName}.dev.azuresynapse.net
    description: Azure Synapse Analytics - Pipeline API — Pipeline business capability. Self-contained, no shared references.
    resources:
    - name: pipelines
      path: /pipelines
      operations:
      - name: pipelinegetpipelinesbyworkspace
        method: GET
        description: Azure Synapse Analytics List pipelines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: pipelines-pipelineName
      path: /pipelines/{pipelineName}
      operations:
      - name: pipelinegetpipeline
        method: GET
        description: Azure Synapse Analytics Get a pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-None-Match
          in: header
          type: string
          description: ETag of the pipeline entity. Should only be specified for get. If the ETag matches the existing entity
            tag, or if * was provided, then no content will be return
      - name: pipelinecreateorupdatepipeline
        method: PUT
        description: Azure Synapse Analytics Create or update a pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: If-Match
          in: header
          type: string
          description: ETag of the pipeline entity. Should only be specified for update, for which it should match existing
            entity or can be * for unconditional update.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: pipelinedeletepipeline
        method: DELETE
        description: Azure Synapse Analytics Delete a pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: pipelines-pipelineName-createRun
      path: /pipelines/{pipelineName}/createRun
      operations:
      - name: pipelinecreatepipelinerun
        method: POST
        description: Azure Synapse Analytics Create a pipeline run
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: referencePipelineRunId
          in: query
          type: string
          description: The pipeline run identifier. If specified, the new run will be grouped with the specified run.
        - name: isRecovery
          in: query
          type: boolean
          description: Recovery mode flag. If true, the specified referenced pipeline run will be used for recovery.
        - name: startActivityName
          in: query
          type: string
          description: In recovery mode, the rerun will start from this activity.
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: pipelines-pipelineName-rename
      path: /pipelines/{pipelineName}/rename
      operations:
      - name: pipelinerenamepipeline
        method: POST
        description: Azure Synapse Analytics Rename a pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.MICROSOFT_AZURE_SYNAPSE_ANALYTICS_API_KEY}}'
  exposes:
  - type: rest
    namespace: azure-synapse-analytics-pipeline-pipeline-rest
    port: 8080
    description: REST adapter for Azure Synapse Analytics - Pipeline API — Pipeline. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/pipelines
      name: pipelines
      description: REST surface for pipelines.
      operations:
      - method: GET
        name: pipelinegetpipelinesbyworkspace
        description: Azure Synapse Analytics List pipelines
        call: azure-synapse-analytics-pipeline-pipeline.pipelinegetpipelinesbyworkspace
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pipelines/{pipelinename}
      name: pipelines-pipelinename
      description: REST surface for pipelines-pipelineName.
      operations:
      - method: GET
        name: pipelinegetpipeline
        description: Azure Synapse Analytics Get a pipeline
        call: azure-synapse-analytics-pipeline-pipeline.pipelinegetpipeline
        with:
          If-None-Match: rest.If-None-Match
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: pipelinecreateorupdatepipeline
        description: Azure Synapse Analytics Create or update a pipeline
        call: azure-synapse-analytics-pipeline-pipeline.pipelinecreateorupdatepipeline
        with:
          If-Match: rest.If-Match
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: pipelinedeletepipeline
        description: Azure Synapse Analytics Delete a pipeline
        call: azure-synapse-analytics-pipeline-pipeline.pipelinedeletepipeline
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pipelines/{pipelinename}/createrun
      name: pipelines-pipelinename-createrun
      description: REST surface for pipelines-pipelineName-createRun.
      operations:
      - method: POST
        name: pipelinecreatepipelinerun
        description: Azure Synapse Analytics Create a pipeline run
        call: azure-synapse-analytics-pipeline-pipeline.pipelinecreatepipelinerun
        with:
          referencePipelineRunId: rest.referencePipelineRunId
          isRecovery: rest.isRecovery
          startActivityName: rest.startActivityName
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pipelines/{pipelinename}/rename
      name: pipelines-pipelinename-rename
      description: REST surface for pipelines-pipelineName-rename.
      operations:
      - method: POST
        name: pipelinerenamepipeline
        description: Azure Synapse Analytics Rename a pipeline
        call: azure-synapse-analytics-pipeline-pipeline.pipelinerenamepipeline
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: azure-synapse-analytics-pipeline-pipeline-mcp
    port: 9090
    transport: http
    description: MCP adapter for Azure Synapse Analytics - Pipeline API — Pipeline. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: azure-synapse-analytics-list-pipelines
      description: Azure Synapse Analytics List pipelines
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-pipeline-pipeline.pipelinegetpipelinesbyworkspace
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-get-pipeline
      description: Azure Synapse Analytics Get a pipeline
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-pipeline-pipeline.pipelinegetpipeline
      with:
        If-None-Match: tools.If-None-Match
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-create-update
      description: Azure Synapse Analytics Create or update a pipeline
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: azure-synapse-analytics-pipeline-pipeline.pipelinecreateorupdatepipeline
      with:
        If-Match: tools.If-Match
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-delete-pipeline
      description: Azure Synapse Analytics Delete a pipeline
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: azure-synapse-analytics-pipeline-pipeline.pipelinedeletepipeline
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-create-pipeline
      description: Azure Synapse Analytics Create a pipeline run
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-synapse-analytics-pipeline-pipeline.pipelinecreatepipelinerun
      with:
        referencePipelineRunId: tools.referencePipelineRunId
        isRecovery: tools.isRecovery
        startActivityName: tools.startActivityName
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: azure-synapse-analytics-rename-pipeline
      description: Azure Synapse Analytics Rename a pipeline
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: azure-synapse-analytics-pipeline-pipeline.pipelinerenamepipeline
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.