NetApp ONTAP REST API — Volumes

naftiko: 1.0.0-alpha2
info:
  label: NetApp ONTAP REST API — Volumes
  description: 'NetApp ONTAP REST API — Volumes. 5 operations. Lead operation: Netapp List Storage Volumes. Self-contained
    Naftiko capability covering one Netapp business surface.'
  tags:
  - Netapp
  - Volumes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    NETAPP_API_KEY: NETAPP_API_KEY
capability:
  consumes:
  - type: http
    namespace: ontap-volumes
    baseUri: https://{clusterMgmtIp}/api
    description: NetApp ONTAP REST API — Volumes business capability. Self-contained, no shared references.
    resources:
    - name: storage-volumes
      path: /storage/volumes
      operations:
      - name: listvolumes
        method: GET
        description: Netapp List Storage Volumes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: svm.name
          in: query
          type: string
          description: Filter by SVM name
        - name: name
          in: query
          type: string
          description: Filter by volume name
        - name: state
          in: query
          type: string
          description: Filter by volume state
        - name: type
          in: query
          type: string
          description: Filter by volume type
      - name: createvolume
        method: POST
        description: Netapp Create a New Volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: return_records
          in: query
          type: boolean
          description: Return the newly created record
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: storage-volumes-uuid
      path: /storage/volumes/{uuid}
      operations:
      - name: getvolume
        method: GET
        description: Netapp Retrieve a Specific Volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatevolume
        method: PATCH
        description: Netapp Update a Volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletevolume
        method: DELETE
        description: Netapp Delete a Volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.NETAPP_API_KEY}}'
  exposes:
  - type: rest
    namespace: ontap-volumes-rest
    port: 8080
    description: REST adapter for NetApp ONTAP REST API — Volumes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/storage/volumes
      name: storage-volumes
      description: REST surface for storage-volumes.
      operations:
      - method: GET
        name: listvolumes
        description: Netapp List Storage Volumes
        call: ontap-volumes.listvolumes
        with:
          svm.name: rest.svm.name
          name: rest.name
          state: rest.state
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createvolume
        description: Netapp Create a New Volume
        call: ontap-volumes.createvolume
        with:
          return_records: rest.return_records
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/storage/volumes/{uuid}
      name: storage-volumes-uuid
      description: REST surface for storage-volumes-uuid.
      operations:
      - method: GET
        name: getvolume
        description: Netapp Retrieve a Specific Volume
        call: ontap-volumes.getvolume
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatevolume
        description: Netapp Update a Volume
        call: ontap-volumes.updatevolume
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletevolume
        description: Netapp Delete a Volume
        call: ontap-volumes.deletevolume
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ontap-volumes-mcp
    port: 9090
    transport: http
    description: MCP adapter for NetApp ONTAP REST API — Volumes. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: netapp-list-storage-volumes
      description: Netapp List Storage Volumes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ontap-volumes.listvolumes
      with:
        svm.name: tools.svm.name
        name: tools.name
        state: tools.state
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: netapp-create-new-volume
      description: Netapp Create a New Volume
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ontap-volumes.createvolume
      with:
        return_records: tools.return_records
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: netapp-retrieve-specific-volume
      description: Netapp Retrieve a Specific Volume
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ontap-volumes.getvolume
      outputParameters:
      - type: object
        mapping: $.
    - name: netapp-update-volume
      description: Netapp Update a Volume
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ontap-volumes.updatevolume
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: netapp-delete-volume
      description: Netapp Delete a Volume
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ontap-volumes.deletevolume
      outputParameters:
      - type: object
        mapping: $.