GridGain REST module — deployment

naftiko: 1.0.0-alpha2
info:
  label: GridGain REST module — deployment
  description: 'GridGain REST module — deployment. 8 operations. Lead operation: Get cluster unit statuses. Self-contained
    Naftiko capability covering one Gridgain business surface.'
  tags:
  - Gridgain
  - deployment
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GRIDGAIN_API_KEY: GRIDGAIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: gridgain-deployment
    baseUri: http://localhost:10300
    description: GridGain REST module — deployment business capability. Self-contained, no shared references.
    resources:
    - name: management-v1-deployment-cluster-units
      path: /management/v1/deployment/cluster/units
      operations:
      - name: listclusterstatuses
        method: GET
        description: Get cluster unit statuses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: statuses
          in: query
          type: array
    - name: management-v1-deployment-cluster-units-unitId
      path: /management/v1/deployment/cluster/units/{unitId}
      operations:
      - name: listclusterstatusesbyunit
        method: GET
        description: Get specific cluster unit statuses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: string
        - name: statuses
          in: query
          type: array
    - name: management-v1-deployment-node-units
      path: /management/v1/deployment/node/units
      operations:
      - name: listnodestatuses
        method: GET
        description: Get node unit statuses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: statuses
          in: query
          type: array
    - name: management-v1-deployment-node-units-structure-unitId-unitVersion
      path: /management/v1/deployment/node/units/structure/{unitId}/{unitVersion}
      operations:
      - name: unitcontent
        method: GET
        description: Get unit contents.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          required: true
        - name: unitVersion
          in: path
          type: string
          required: true
    - name: management-v1-deployment-node-units-unitId
      path: /management/v1/deployment/node/units/{unitId}
      operations:
      - name: listnodestatusesbyunit
        method: GET
        description: Get specific node unit statuses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: string
        - name: statuses
          in: query
          type: array
    - name: management-v1-deployment-units-zip-unitId-unitVersion
      path: /management/v1/deployment/units/zip/{unitId}/{unitVersion}
      operations:
      - name: deployzipunit
        method: POST
        description: Deploy unit with folders structure in zip.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          required: true
        - name: unitVersion
          in: path
          type: string
          required: true
        - name: deployMode
          in: query
          type: string
        - name: initialNodes
          in: query
          type: array
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: management-v1-deployment-units-unitId-unitVersion
      path: /management/v1/deployment/units/{unitId}/{unitVersion}
      operations:
      - name: deployunit
        method: POST
        description: Deploy unit
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          required: true
        - name: unitVersion
          in: path
          type: string
          required: true
        - name: deployMode
          in: query
          type: string
        - name: initialNodes
          in: query
          type: array
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: undeployunit
        method: DELETE
        description: Undeploy unit
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: unitId
          in: path
          type: string
          required: true
        - name: unitVersion
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.GRIDGAIN_API_KEY}}'
  exposes:
  - type: rest
    namespace: gridgain-deployment-rest
    port: 8080
    description: REST adapter for GridGain REST module — deployment. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/management/v1/deployment/cluster/units
      name: management-v1-deployment-cluster-units
      description: REST surface for management-v1-deployment-cluster-units.
      operations:
      - method: GET
        name: listclusterstatuses
        description: Get cluster unit statuses
        call: gridgain-deployment.listclusterstatuses
        with:
          statuses: rest.statuses
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/deployment/cluster/units/{unitid}
      name: management-v1-deployment-cluster-units-unitid
      description: REST surface for management-v1-deployment-cluster-units-unitId.
      operations:
      - method: GET
        name: listclusterstatusesbyunit
        description: Get specific cluster unit statuses
        call: gridgain-deployment.listclusterstatusesbyunit
        with:
          unitId: rest.unitId
          version: rest.version
          statuses: rest.statuses
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/deployment/node/units
      name: management-v1-deployment-node-units
      description: REST surface for management-v1-deployment-node-units.
      operations:
      - method: GET
        name: listnodestatuses
        description: Get node unit statuses
        call: gridgain-deployment.listnodestatuses
        with:
          statuses: rest.statuses
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/deployment/node/units/structure/{unitid}/{unitversion}
      name: management-v1-deployment-node-units-structure-unitid-unitversion
      description: REST surface for management-v1-deployment-node-units-structure-unitId-unitVersion.
      operations:
      - method: GET
        name: unitcontent
        description: Get unit contents.
        call: gridgain-deployment.unitcontent
        with:
          unitId: rest.unitId
          unitVersion: rest.unitVersion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/deployment/node/units/{unitid}
      name: management-v1-deployment-node-units-unitid
      description: REST surface for management-v1-deployment-node-units-unitId.
      operations:
      - method: GET
        name: listnodestatusesbyunit
        description: Get specific node unit statuses
        call: gridgain-deployment.listnodestatusesbyunit
        with:
          unitId: rest.unitId
          version: rest.version
          statuses: rest.statuses
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/deployment/units/zip/{unitid}/{unitversion}
      name: management-v1-deployment-units-zip-unitid-unitversion
      description: REST surface for management-v1-deployment-units-zip-unitId-unitVersion.
      operations:
      - method: POST
        name: deployzipunit
        description: Deploy unit with folders structure in zip.
        call: gridgain-deployment.deployzipunit
        with:
          unitId: rest.unitId
          unitVersion: rest.unitVersion
          deployMode: rest.deployMode
          initialNodes: rest.initialNodes
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/deployment/units/{unitid}/{unitversion}
      name: management-v1-deployment-units-unitid-unitversion
      description: REST surface for management-v1-deployment-units-unitId-unitVersion.
      operations:
      - method: POST
        name: deployunit
        description: Deploy unit
        call: gridgain-deployment.deployunit
        with:
          unitId: rest.unitId
          unitVersion: rest.unitVersion
          deployMode: rest.deployMode
          initialNodes: rest.initialNodes
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: undeployunit
        description: Undeploy unit
        call: gridgain-deployment.undeployunit
        with:
          unitId: rest.unitId
          unitVersion: rest.unitVersion
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gridgain-deployment-mcp
    port: 9090
    transport: http
    description: MCP adapter for GridGain REST module — deployment. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-cluster-unit-statuses
      description: Get cluster unit statuses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-deployment.listclusterstatuses
      with:
        statuses: tools.statuses
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-cluster-unit-statuses
      description: Get specific cluster unit statuses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-deployment.listclusterstatusesbyunit
      with:
        unitId: tools.unitId
        version: tools.version
        statuses: tools.statuses
      outputParameters:
      - type: object
        mapping: $.
    - name: get-node-unit-statuses
      description: Get node unit statuses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-deployment.listnodestatuses
      with:
        statuses: tools.statuses
      outputParameters:
      - type: object
        mapping: $.
    - name: get-unit-contents
      description: Get unit contents.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-deployment.unitcontent
      with:
        unitId: tools.unitId
        unitVersion: tools.unitVersion
      outputParameters:
      - type: object
        mapping: $.
    - name: get-specific-node-unit-statuses
      description: Get specific node unit statuses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-deployment.listnodestatusesbyunit
      with:
        unitId: tools.unitId
        version: tools.version
        statuses: tools.statuses
      outputParameters:
      - type: object
        mapping: $.
    - name: deploy-unit-folders-structure-zip
      description: Deploy unit with folders structure in zip.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-deployment.deployzipunit
      with:
        unitId: tools.unitId
        unitVersion: tools.unitVersion
        deployMode: tools.deployMode
        initialNodes: tools.initialNodes
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: deploy-unit
      description: Deploy unit
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-deployment.deployunit
      with:
        unitId: tools.unitId
        unitVersion: tools.unitVersion
        deployMode: tools.deployMode
        initialNodes: tools.initialNodes
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: undeploy-unit
      description: Undeploy unit
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gridgain-deployment.undeployunit
      with:
        unitId: tools.unitId
        unitVersion: tools.unitVersion
      outputParameters:
      - type: object
        mapping: $.