ZenML OSS REST API — Pipelines

naftiko: 1.0.0-alpha2
info:
  label: ZenML OSS REST API — Pipelines
  description: 'ZenML OSS REST API — Pipelines. 4 operations. Lead operation: List Pipelines. Self-contained Naftiko capability
    covering one Zenml business surface.'
  tags:
  - Zenml
  - Pipelines
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZENML_API_KEY: ZENML_API_KEY
capability:
  consumes:
  - type: http
    namespace: zenml-pipelines
    baseUri: https://your-zenml-server.example.com/api/v1
    description: ZenML OSS REST API — Pipelines business capability. Self-contained, no shared references.
    resources:
    - name: pipelines
      path: /pipelines
      operations:
      - name: listpipelines
        method: GET
        description: List Pipelines
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
        - name: project_id
          in: query
          type: string
      - name: createpipeline
        method: POST
        description: Create Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: pipelines-pipeline_id
      path: /pipelines/{pipeline_id}
      operations:
      - name: getpipeline
        method: GET
        description: Get Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletepipeline
        method: DELETE
        description: Delete Pipeline
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ZENML_API_KEY}}'
  exposes:
  - type: rest
    namespace: zenml-pipelines-rest
    port: 8080
    description: REST adapter for ZenML OSS REST API — Pipelines. 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: listpipelines
        description: List Pipelines
        call: zenml-pipelines.listpipelines
        with:
          name: rest.name
          project_id: rest.project_id
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpipeline
        description: Create Pipeline
        call: zenml-pipelines.createpipeline
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pipelines/{pipeline-id}
      name: pipelines-pipeline-id
      description: REST surface for pipelines-pipeline_id.
      operations:
      - method: GET
        name: getpipeline
        description: Get Pipeline
        call: zenml-pipelines.getpipeline
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletepipeline
        description: Delete Pipeline
        call: zenml-pipelines.deletepipeline
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: zenml-pipelines-mcp
    port: 9090
    transport: http
    description: MCP adapter for ZenML OSS REST API — Pipelines. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-pipelines
      description: List Pipelines
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zenml-pipelines.listpipelines
      with:
        name: tools.name
        project_id: tools.project_id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-pipeline
      description: Create Pipeline
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: zenml-pipelines.createpipeline
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-pipeline
      description: Get Pipeline
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: zenml-pipelines.getpipeline
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-pipeline
      description: Delete Pipeline
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: zenml-pipelines.deletepipeline
      outputParameters:
      - type: object
        mapping: $.