Oracle GoldenGate Veridata REST API — Monitoring

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate Veridata REST API — Monitoring
  description: 'Oracle GoldenGate Veridata REST API — Monitoring. 5 operations. Lead operation: Oracle Goldengate Retrieve
    Comparison Report. Self-contained Naftiko capability covering one Oracle Goldengate business surface.'
  tags:
  - Oracle Goldengate
  - Monitoring
  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: veridata-rest-monitoring
    baseUri: https://{veridata-host}:{port}/veridata/v1
    description: Oracle GoldenGate Veridata REST API — Monitoring business capability. Self-contained, no shared references.
    resources:
    - name: services-monitoring-comparison-runId-reports
      path: /services/monitoring/comparison/{runId}/reports
      operations:
      - name: getcomparisonreport
        method: GET
        description: Oracle Goldengate Retrieve Comparison Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-monitoring-cps
      path: /services/monitoring/cps
      operations:
      - name: getcomparepairstatistics
        method: GET
        description: Oracle Goldengate Retrieve Compare Pair Statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-monitoring-jobs
      path: /services/monitoring/jobs
      operations:
      - name: getjobstatistics
        method: GET
        description: Oracle Goldengate Retrieve Job Statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-oos-runId
      path: /services/oos/{runId}
      operations:
      - name: getoutofsyncdata
        method: GET
        description: Oracle Goldengate Retrieve Out-of-sync Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-purge-stats
      path: /services/purge/stats
      operations:
      - name: purgestatistics
        method: DELETE
        description: Oracle Goldengate Purge Comparison Statistics
        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: veridata-rest-monitoring-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate Veridata REST API — Monitoring. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/services/monitoring/comparison/{runid}/reports
      name: services-monitoring-comparison-runid-reports
      description: REST surface for services-monitoring-comparison-runId-reports.
      operations:
      - method: GET
        name: getcomparisonreport
        description: Oracle Goldengate Retrieve Comparison Report
        call: veridata-rest-monitoring.getcomparisonreport
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/monitoring/cps
      name: services-monitoring-cps
      description: REST surface for services-monitoring-cps.
      operations:
      - method: GET
        name: getcomparepairstatistics
        description: Oracle Goldengate Retrieve Compare Pair Statistics
        call: veridata-rest-monitoring.getcomparepairstatistics
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/monitoring/jobs
      name: services-monitoring-jobs
      description: REST surface for services-monitoring-jobs.
      operations:
      - method: GET
        name: getjobstatistics
        description: Oracle Goldengate Retrieve Job Statistics
        call: veridata-rest-monitoring.getjobstatistics
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/oos/{runid}
      name: services-oos-runid
      description: REST surface for services-oos-runId.
      operations:
      - method: GET
        name: getoutofsyncdata
        description: Oracle Goldengate Retrieve Out-of-sync Data
        call: veridata-rest-monitoring.getoutofsyncdata
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/purge/stats
      name: services-purge-stats
      description: REST surface for services-purge-stats.
      operations:
      - method: DELETE
        name: purgestatistics
        description: Oracle Goldengate Purge Comparison Statistics
        call: veridata-rest-monitoring.purgestatistics
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: veridata-rest-monitoring-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate Veridata REST API — Monitoring. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: oracle-goldengate-retrieve-comparison-report
      description: Oracle Goldengate Retrieve Comparison Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-monitoring.getcomparisonreport
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-compare-pair
      description: Oracle Goldengate Retrieve Compare Pair Statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-monitoring.getcomparepairstatistics
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-job-statistics
      description: Oracle Goldengate Retrieve Job Statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-monitoring.getjobstatistics
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-out-sync
      description: Oracle Goldengate Retrieve Out-of-sync Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-monitoring.getoutofsyncdata
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-purge-comparison-statistics
      description: Oracle Goldengate Purge Comparison Statistics
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: veridata-rest-monitoring.purgestatistics
      outputParameters:
      - type: object
        mapping: $.