Oracle GoldenGate REST API — Heartbeat

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate REST API — Heartbeat
  description: 'Oracle GoldenGate REST API — Heartbeat. 5 operations. Lead operation: Oracle Goldengate Retrieve Heartbeat
    Table Configuration. Self-contained Naftiko capability covering one Oracle Goldengate business surface.'
  tags:
  - Oracle Goldengate
  - Heartbeat
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_GOLDENGATE_API_KEY: ORACLE_GOLDENGATE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-heartbeat
    baseUri: https://{goldengate-host}:{port}
    description: Oracle GoldenGate REST API — Heartbeat business capability. Self-contained, no shared references.
    resources:
    - name: services-v2-connections-connection-tables-heartbeat
      path: /services/v2/connections/{connection}/tables/heartbeat
      operations:
      - name: getheartbeattable
        method: GET
        description: Oracle Goldengate Retrieve Heartbeat Table Configuration
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createheartbeattable
        method: POST
        description: Oracle Goldengate Create Heartbeat Table
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateheartbeattable
        method: PATCH
        description: Oracle Goldengate Update Heartbeat Table
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteheartbeattable
        method: DELETE
        description: Oracle Goldengate Delete Heartbeat Table
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-connections-connection-tables-heartbeatData
      path: /services/v2/connections/{connection}/tables/heartbeatData
      operations:
      - name: getheartbeatentries
        method: GET
        description: Oracle Goldengate Retrieve Heartbeat Table Entries
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.ORACLE_GOLDENGATE_USER}}'
      password: '{{env.ORACLE_GOLDENGATE_PASS}}'
  exposes:
  - type: rest
    namespace: rest-heartbeat-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate REST API — Heartbeat. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/services/v2/connections/{connection}/tables/heartbeat
      name: services-v2-connections-connection-tables-heartbeat
      description: REST surface for services-v2-connections-connection-tables-heartbeat.
      operations:
      - method: GET
        name: getheartbeattable
        description: Oracle Goldengate Retrieve Heartbeat Table Configuration
        call: rest-heartbeat.getheartbeattable
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createheartbeattable
        description: Oracle Goldengate Create Heartbeat Table
        call: rest-heartbeat.createheartbeattable
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateheartbeattable
        description: Oracle Goldengate Update Heartbeat Table
        call: rest-heartbeat.updateheartbeattable
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteheartbeattable
        description: Oracle Goldengate Delete Heartbeat Table
        call: rest-heartbeat.deleteheartbeattable
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/connections/{connection}/tables/heartbeatdata
      name: services-v2-connections-connection-tables-heartbeatdata
      description: REST surface for services-v2-connections-connection-tables-heartbeatData.
      operations:
      - method: GET
        name: getheartbeatentries
        description: Oracle Goldengate Retrieve Heartbeat Table Entries
        call: rest-heartbeat.getheartbeatentries
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-heartbeat-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate REST API — Heartbeat. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: oracle-goldengate-retrieve-heartbeat-table
      description: Oracle Goldengate Retrieve Heartbeat Table Configuration
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-heartbeat.getheartbeattable
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-create-heartbeat-table
      description: Oracle Goldengate Create Heartbeat Table
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-heartbeat.createheartbeattable
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-update-heartbeat-table
      description: Oracle Goldengate Update Heartbeat Table
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-heartbeat.updateheartbeattable
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-delete-heartbeat-table
      description: Oracle Goldengate Delete Heartbeat Table
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-heartbeat.deleteheartbeattable
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-heartbeat-table-2
      description: Oracle Goldengate Retrieve Heartbeat Table Entries
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-heartbeat.getheartbeatentries
      outputParameters:
      - type: object
        mapping: $.