GridGain REST module — cdcManagement

naftiko: 1.0.0-alpha2
info:
  label: GridGain REST module — cdcManagement
  description: 'GridGain REST module — cdcManagement. 18 operations. Lead operation: Get the list of CDC replications. Self-contained
    Naftiko capability covering one Gridgain business surface.'
  tags:
  - Gridgain
  - cdcManagement
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    GRIDGAIN_API_KEY: GRIDGAIN_API_KEY
capability:
  consumes:
  - type: http
    namespace: gridgain-cdcmanagement
    baseUri: http://localhost:10300
    description: GridGain REST module — cdcManagement business capability. Self-contained, no shared references.
    resources:
    - name: management-v1-cdc-replications
      path: /management/v1/cdc/replications
      operations:
      - name: getcdcreplications
        method: GET
        description: Get the list of CDC replications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcdcreplication
        method: POST
        description: Create CDC replication. CDC replication is identified by unique name. CDC replication has a type, parameters
          and a list of tables that should be replicated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: management-v1-cdc-replications-name
      path: /management/v1/cdc/replications/{name}
      operations:
      - name: getcdcreplication
        method: GET
        description: Get CDC replication by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
      - name: startcdcreplication
        method: POST
        description: Start CDC replication by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Replication name.
          required: true
      - name: deletecdcreplication
        method: DELETE
        description: Delete CDC replication by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Replication name.
          required: true
    - name: management-v1-cdc-replications-name-stop
      path: /management/v1/cdc/replications/{name}/stop
      operations:
      - name: stopcdcreplication
        method: POST
        description: Stop CDC replication by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Replication name.
          required: true
    - name: management-v1-cdc-sinks
      path: /management/v1/cdc/sinks
      operations:
      - name: getsinks
        method: GET
        description: Get the list of CDC sinks
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsink
        method: POST
        description: Create CDC sink. CDC sink is identified by unique name. CDC sink has a type, parameters and a list of
          tables that should be replicated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: management-v1-cdc-sinks-name
      path: /management/v1/cdc/sinks/{name}
      operations:
      - name: getsink
        method: GET
        description: Get CDC sink by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
      - name: updatesink
        method: PUT
        description: Update CDC sink
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesink
        method: DELETE
        description: Delete CDC sink by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
    - name: management-v1-cdc-sinks-name-status
      path: /management/v1/cdc/sinks/{name}/status
      operations:
      - name: getsinkstatus
        method: GET
        description: Get CDC sink status by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
    - name: management-v1-cdc-sources
      path: /management/v1/cdc/sources
      operations:
      - name: getsources
        method: GET
        description: Get the list of CDC sources
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsource
        method: POST
        description: Create CDC source. CDC source is identified by unique name. CDC source has a type, parameters and a list
          of tables that should be replicated.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: management-v1-cdc-sources-name
      path: /management/v1/cdc/sources/{name}
      operations:
      - name: getsource
        method: GET
        description: Get CDC source by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
      - name: updatesource
        method: PUT
        description: Update CDC source
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesource
        method: DELETE
        description: Delete CDC source by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
    - name: management-v1-cdc-sources-name-status
      path: /management/v1/cdc/sources/{name}/status
      operations:
      - name: getsourcestatus
        method: GET
        description: Get CDC source status by name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: path
          type: string
          description: Name.
          required: true
    authentication:
      type: bearer
      token: '{{env.GRIDGAIN_API_KEY}}'
  exposes:
  - type: rest
    namespace: gridgain-cdcmanagement-rest
    port: 8080
    description: REST adapter for GridGain REST module — cdcManagement. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/management/v1/cdc/replications
      name: management-v1-cdc-replications
      description: REST surface for management-v1-cdc-replications.
      operations:
      - method: GET
        name: getcdcreplications
        description: Get the list of CDC replications
        call: gridgain-cdcmanagement.getcdcreplications
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcdcreplication
        description: Create CDC replication. CDC replication is identified by unique name. CDC replication has a type, parameters
          and a list of tables that should be replicated.
        call: gridgain-cdcmanagement.createcdcreplication
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/replications/{name}
      name: management-v1-cdc-replications-name
      description: REST surface for management-v1-cdc-replications-name.
      operations:
      - method: GET
        name: getcdcreplication
        description: Get CDC replication by name
        call: gridgain-cdcmanagement.getcdcreplication
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: startcdcreplication
        description: Start CDC replication by name
        call: gridgain-cdcmanagement.startcdcreplication
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecdcreplication
        description: Delete CDC replication by name
        call: gridgain-cdcmanagement.deletecdcreplication
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/replications/{name}/stop
      name: management-v1-cdc-replications-name-stop
      description: REST surface for management-v1-cdc-replications-name-stop.
      operations:
      - method: POST
        name: stopcdcreplication
        description: Stop CDC replication by name
        call: gridgain-cdcmanagement.stopcdcreplication
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/sinks
      name: management-v1-cdc-sinks
      description: REST surface for management-v1-cdc-sinks.
      operations:
      - method: GET
        name: getsinks
        description: Get the list of CDC sinks
        call: gridgain-cdcmanagement.getsinks
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsink
        description: Create CDC sink. CDC sink is identified by unique name. CDC sink has a type, parameters and a list of
          tables that should be replicated.
        call: gridgain-cdcmanagement.createsink
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/sinks/{name}
      name: management-v1-cdc-sinks-name
      description: REST surface for management-v1-cdc-sinks-name.
      operations:
      - method: GET
        name: getsink
        description: Get CDC sink by name
        call: gridgain-cdcmanagement.getsink
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesink
        description: Update CDC sink
        call: gridgain-cdcmanagement.updatesink
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesink
        description: Delete CDC sink by name
        call: gridgain-cdcmanagement.deletesink
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/sinks/{name}/status
      name: management-v1-cdc-sinks-name-status
      description: REST surface for management-v1-cdc-sinks-name-status.
      operations:
      - method: GET
        name: getsinkstatus
        description: Get CDC sink status by name
        call: gridgain-cdcmanagement.getsinkstatus
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/sources
      name: management-v1-cdc-sources
      description: REST surface for management-v1-cdc-sources.
      operations:
      - method: GET
        name: getsources
        description: Get the list of CDC sources
        call: gridgain-cdcmanagement.getsources
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsource
        description: Create CDC source. CDC source is identified by unique name. CDC source has a type, parameters and a list
          of tables that should be replicated.
        call: gridgain-cdcmanagement.createsource
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/sources/{name}
      name: management-v1-cdc-sources-name
      description: REST surface for management-v1-cdc-sources-name.
      operations:
      - method: GET
        name: getsource
        description: Get CDC source by name
        call: gridgain-cdcmanagement.getsource
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatesource
        description: Update CDC source
        call: gridgain-cdcmanagement.updatesource
        with:
          name: rest.name
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesource
        description: Delete CDC source by name
        call: gridgain-cdcmanagement.deletesource
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/management/v1/cdc/sources/{name}/status
      name: management-v1-cdc-sources-name-status
      description: REST surface for management-v1-cdc-sources-name-status.
      operations:
      - method: GET
        name: getsourcestatus
        description: Get CDC source status by name
        call: gridgain-cdcmanagement.getsourcestatus
        with:
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: gridgain-cdcmanagement-mcp
    port: 9090
    transport: http
    description: MCP adapter for GridGain REST module — cdcManagement. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: get-list-cdc-replications
      description: Get the list of CDC replications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getcdcreplications
      outputParameters:
      - type: object
        mapping: $.
    - name: create-cdc-replication-cdc-replication
      description: Create CDC replication. CDC replication is identified by unique name. CDC replication has a type, parameters
        and a list of tables that should be replicated.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: gridgain-cdcmanagement.createcdcreplication
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cdc-replication-name
      description: Get CDC replication by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getcdcreplication
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: start-cdc-replication-name
      description: Start CDC replication by name
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-cdcmanagement.startcdcreplication
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-cdc-replication-name
      description: Delete CDC replication by name
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gridgain-cdcmanagement.deletecdcreplication
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-cdc-replication-name
      description: Stop CDC replication by name
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: gridgain-cdcmanagement.stopcdcreplication
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-list-cdc-sinks
      description: Get the list of CDC sinks
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getsinks
      outputParameters:
      - type: object
        mapping: $.
    - name: create-cdc-sink-cdc-sink
      description: Create CDC sink. CDC sink is identified by unique name. CDC sink has a type, parameters and a list of tables
        that should be replicated.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: gridgain-cdcmanagement.createsink
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cdc-sink-name
      description: Get CDC sink by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getsink
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-cdc-sink
      description: Update CDC sink
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.updatesink
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-cdc-sink-name
      description: Delete CDC sink by name
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gridgain-cdcmanagement.deletesink
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cdc-sink-status-name
      description: Get CDC sink status by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getsinkstatus
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-list-cdc-sources
      description: Get the list of CDC sources
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getsources
      outputParameters:
      - type: object
        mapping: $.
    - name: create-cdc-source-cdc-source
      description: Create CDC source. CDC source is identified by unique name. CDC source has a type, parameters and a list
        of tables that should be replicated.
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: gridgain-cdcmanagement.createsource
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cdc-source-name
      description: Get CDC source by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getsource
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: update-cdc-source
      description: Update CDC source
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.updatesource
      with:
        name: tools.name
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-cdc-source-name
      description: Delete CDC source by name
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: gridgain-cdcmanagement.deletesource
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: get-cdc-source-status-name
      description: Get CDC source status by name
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: gridgain-cdcmanagement.getsourcestatus
      with:
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.