OpenStorage SDK — OpenStorageVerifyChecksum

naftiko: 1.0.0-alpha2
info:
  label: OpenStorage SDK — OpenStorageVerifyChecksum
  description: 'OpenStorage SDK — OpenStorageVerifyChecksum. 3 operations. Lead operation: Start a verify checksum background
    operation on a volume.. Self-contained Naftiko capability covering one Portworx business surface.'
  tags:
  - Portworx
  - OpenStorageVerifyChecksum
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PORTWORX_API_KEY: PORTWORX_API_KEY
capability:
  consumes:
  - type: http
    namespace: portworx-openstorageverifychecksum
    baseUri: ''
    description: OpenStorage SDK — OpenStorageVerifyChecksum business capability. Self-contained, no shared references.
    resources:
    - name: v1-verify-checksum-start
      path: /v1/verify-checksum/start
      operations:
      - name: openstorageverifychecksumstart
        method: POST
        description: Start a verify checksum background operation on a volume.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-verify-checksum-status
      path: /v1/verify-checksum/status
      operations:
      - name: openstorageverifychecksumstatus
        method: GET
        description: Get Status of a verify checksum background operation on a volume
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: volume_id
          in: query
          type: string
          description: Id of the volume.
    - name: v1-verify-checksum-stop
      path: /v1/verify-checksum/stop
      operations:
      - name: openstorageverifychecksumstop
        method: POST
        description: Stop a verify checksum background operation on a volume
        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.PORTWORX_API_KEY}}'
  exposes:
  - type: rest
    namespace: portworx-openstorageverifychecksum-rest
    port: 8080
    description: REST adapter for OpenStorage SDK — OpenStorageVerifyChecksum. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v1/verify-checksum/start
      name: v1-verify-checksum-start
      description: REST surface for v1-verify-checksum-start.
      operations:
      - method: POST
        name: openstorageverifychecksumstart
        description: Start a verify checksum background operation on a volume.
        call: portworx-openstorageverifychecksum.openstorageverifychecksumstart
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/verify-checksum/status
      name: v1-verify-checksum-status
      description: REST surface for v1-verify-checksum-status.
      operations:
      - method: GET
        name: openstorageverifychecksumstatus
        description: Get Status of a verify checksum background operation on a volume
        call: portworx-openstorageverifychecksum.openstorageverifychecksumstatus
        with:
          volume_id: rest.volume_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/verify-checksum/stop
      name: v1-verify-checksum-stop
      description: REST surface for v1-verify-checksum-stop.
      operations:
      - method: POST
        name: openstorageverifychecksumstop
        description: Stop a verify checksum background operation on a volume
        call: portworx-openstorageverifychecksum.openstorageverifychecksumstop
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: portworx-openstorageverifychecksum-mcp
    port: 9090
    transport: http
    description: MCP adapter for OpenStorage SDK — OpenStorageVerifyChecksum. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: start-verify-checksum-background-operation
      description: Start a verify checksum background operation on a volume.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstorageverifychecksum.openstorageverifychecksumstart
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-status-verify-checksum-background
      description: Get Status of a verify checksum background operation on a volume
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: portworx-openstorageverifychecksum.openstorageverifychecksumstatus
      with:
        volume_id: tools.volume_id
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-verify-checksum-background-operation
      description: Stop a verify checksum background operation on a volume
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: portworx-openstorageverifychecksum.openstorageverifychecksumstop
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.