GridGain REST module — snapshotManagement

naftiko: 1.0.0-alpha2
info:
  label: GridGain REST module — snapshotManagement
  description: 'GridGain REST module — snapshotManagement. 6 operations. Lead operation: Create snapshot. Self-contained Naftiko
    capability covering one Gridgain business surface.'
  tags:
  - Gridgain
  - snapshotManagement
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GRIDGAIN_API_KEY: GRIDGAIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: gridgain-snapshotmanagement
    baseUri: http://localhost:10300
    description: GridGain REST module — snapshotManagement business capability. Self-contained, no shared references.
    resources:
    - name: management-v1-snapshot-create
      path: /management/v1/snapshot/create
      operations:
      - name: create
        method: POST
        description: Create snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: management-v1-snapshot-delete
      path: /management/v1/snapshot/delete
      operations:
      - name: delete
        method: POST
        description: Delete snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: management-v1-snapshot-list
      path: /management/v1/snapshot/list
      operations:
      - name: getlist
        method: GET
        description: Returns a list of snapshots.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: source
          in: query
          type: string
          description: Snapshot path name specified in the configuration, `null` means use all paths from the configuration.
        - name: showNodeNames
          in: query
          type: boolean
          description: Whether to show node names or only their numbers in the response.
          required: true
        - name: showTableNames
          in: query
          type: boolean
          description: Whether to show table or only their numbers names in the response.
          required: true
        - name: showSourceUri
          in: query
          type: boolean
          description: Whether to show snapshot path URI in the response.
          required: true
    - name: management-v1-snapshot-operations
      path: /management/v1/snapshot/operations
      operations:
      - name: getoperations
        method: GET
        description: Get all snapshot operations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: management-v1-snapshot-operations-operationId
      path: /management/v1/snapshot/operations/{operationId}
      operations:
      - name: getoperationbyid
        method: GET
        description: Get operation by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: operationId
          in: path
          type: string
          description: ID of the operation.
          required: true
        - name: allNodes
          in: query
          type: boolean
          description: if operation status for every node should be retrieved.
          required: true
    - name: management-v1-snapshot-restore
      path: /management/v1/snapshot/restore
      operations:
      - name: restore
        method: POST
        description: Restore snapshot
        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.GRIDGAIN_API_KEY}}'
  exposes:
  - type: rest
    namespace: gridgain-snapshotmanagement-rest
    port: 8080
    description: REST adapter for GridGain REST module — snapshotManagement. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/management/v1/snapshot/create
      name: management-v1-snapshot-create
      description: REST surface for management-v1-snapshot-create.
      operations:
      - method: POST
        name: create
        description: Create snapshot
        call: gridgain-snapshotmanagement.create
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/snapshot/delete
      name: management-v1-snapshot-delete
      description: REST surface for management-v1-snapshot-delete.
      operations:
      - method: POST
        name: delete
        description: Delete snapshot
        call: gridgain-snapshotmanagement.delete
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/snapshot/list
      name: management-v1-snapshot-list
      description: REST surface for management-v1-snapshot-list.
      operations:
      - method: GET
        name: getlist
        description: Returns a list of snapshots.
        call: gridgain-snapshotmanagement.getlist
        with:
          source: rest.source
          showNodeNames: rest.showNodeNames
          showTableNames: rest.showTableNames
          showSourceUri: rest.showSourceUri
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/snapshot/operations
      name: management-v1-snapshot-operations
      description: REST surface for management-v1-snapshot-operations.
      operations:
      - method: GET
        name: getoperations
        description: Get all snapshot operations
        call: gridgain-snapshotmanagement.getoperations
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/snapshot/operations/{operationid}
      name: management-v1-snapshot-operations-operationid
      description: REST surface for management-v1-snapshot-operations-operationId.
      operations:
      - method: GET
        name: getoperationbyid
        description: Get operation by ID
        call: gridgain-snapshotmanagement.getoperationbyid
        with:
          operationId: rest.operationId
          allNodes: rest.allNodes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/snapshot/restore
      name: management-v1-snapshot-restore
      description: REST surface for management-v1-snapshot-restore.
      operations:
      - method: POST
        name: restore
        description: Restore snapshot
        call: gridgain-snapshotmanagement.restore
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gridgain-snapshotmanagement-mcp
    port: 9090
    transport: http
    description: MCP adapter for GridGain REST module — snapshotManagement. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-snapshot
      description: Create snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-snapshotmanagement.create
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-snapshot
      description: Delete snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-snapshotmanagement.delete
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: returns-list-snapshots
      description: Returns a list of snapshots.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-snapshotmanagement.getlist
      with:
        source: tools.source
        showNodeNames: tools.showNodeNames
        showTableNames: tools.showTableNames
        showSourceUri: tools.showSourceUri
      outputParameters:
      - type: object
        mapping: $.
    - name: get-all-snapshot-operations
      description: Get all snapshot operations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-snapshotmanagement.getoperations
      outputParameters:
      - type: object
        mapping: $.
    - name: get-operation-id
      description: Get operation by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-snapshotmanagement.getoperationbyid
      with:
        operationId: tools.operationId
        allNodes: tools.allNodes
      outputParameters:
      - type: object
        mapping: $.
    - name: restore-snapshot
      description: Restore snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-snapshotmanagement.restore
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.