Windmill API — volume

naftiko: 1.0.0-alpha2
info:
  label: Windmill API — volume
  description: 'Windmill API — volume. 4 operations. Lead operation: Create a New Volume. Self-contained Naftiko capability
    covering one Windmill business surface.'
  tags:
  - Windmill
  - volume
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WINDMILL_API_KEY: WINDMILL_API_KEY
capability:
  consumes:
  - type: http
    namespace: windmill-volume
    baseUri: ''
    description: Windmill API — volume business capability. Self-contained, no shared references.
    resources:
    - name: w-workspace-volumes-create
      path: /w/{workspace}/volumes/create
      operations:
      - name: createvolume
        method: POST
        description: Create a New Volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-volumes-delete-name
      path: /w/{workspace}/volumes/delete/{name}
      operations:
      - name: deletevolume
        method: DELETE
        description: Delete a Volume (admin Only)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          required: true
    - name: w-workspace-volumes-list
      path: /w/{workspace}/volumes/list
      operations:
      - name: listvolumes
        method: GET
        description: List All Volumes in the Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-volumes-storage
      path: /w/{workspace}/volumes/storage
      operations:
      - name: getvolumestorage
        method: GET
        description: Get the Volume Storage Name (secondary Storage) or Null for Primary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.WINDMILL_API_KEY}}'
  exposes:
  - type: rest
    namespace: windmill-volume-rest
    port: 8080
    description: REST adapter for Windmill API — volume. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/w/{workspace}/volumes/create
      name: w-workspace-volumes-create
      description: REST surface for w-workspace-volumes-create.
      operations:
      - method: POST
        name: createvolume
        description: Create a New Volume
        call: windmill-volume.createvolume
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/volumes/delete/{name}
      name: w-workspace-volumes-delete-name
      description: REST surface for w-workspace-volumes-delete-name.
      operations:
      - method: DELETE
        name: deletevolume
        description: Delete a Volume (admin Only)
        call: windmill-volume.deletevolume
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/volumes/list
      name: w-workspace-volumes-list
      description: REST surface for w-workspace-volumes-list.
      operations:
      - method: GET
        name: listvolumes
        description: List All Volumes in the Workspace
        call: windmill-volume.listvolumes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/volumes/storage
      name: w-workspace-volumes-storage
      description: REST surface for w-workspace-volumes-storage.
      operations:
      - method: GET
        name: getvolumestorage
        description: Get the Volume Storage Name (secondary Storage) or Null for Primary
        call: windmill-volume.getvolumestorage
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: windmill-volume-mcp
    port: 9090
    transport: http
    description: MCP adapter for Windmill API — volume. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: create-new-volume
      description: Create a New Volume
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-volume.createvolume
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-volume-admin-only
      description: Delete a Volume (admin Only)
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-volume.deletevolume
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-volumes-workspace
      description: List All Volumes in the Workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-volume.listvolumes
      outputParameters:
      - type: object
        mapping: $.
    - name: get-volume-storage-name-secondary
      description: Get the Volume Storage Name (secondary Storage) or Null for Primary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-volume.getvolumestorage
      outputParameters:
      - type: object
        mapping: $.