Oracle GoldenGate REST API

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate REST API
  description: 'Oracle GoldenGate REST API. 5 operations. Lead operation: Oracle Goldengate List Services for a Deployment.
    Self-contained Naftiko capability covering one Oracle Goldengate business surface.'
  tags:
  - Oracle Goldengate
  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-general
    baseUri: https://{goldengate-host}:{port}
    description: Oracle GoldenGate REST API business capability. Self-contained, no shared references.
    resources:
    - name: services-v2-deployments-deployment-services
      path: /services/v2/deployments/{deployment}/services
      operations:
      - name: listservices
        method: GET
        description: Oracle Goldengate List Services for a Deployment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-deployments-deployment-services-service
      path: /services/v2/deployments/{deployment}/services/{service}
      operations:
      - name: getservice
        method: GET
        description: Oracle Goldengate Retrieve a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createservice
        method: POST
        description: Oracle Goldengate Create a Service
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: updateservice
        method: PATCH
        description: Oracle Goldengate Update Service Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteservice
        method: DELETE
        description: Oracle Goldengate Remove a Service
        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-general-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate REST API. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/services/v2/deployments/{deployment}/services
      name: services-v2-deployments-deployment-services
      description: REST surface for services-v2-deployments-deployment-services.
      operations:
      - method: GET
        name: listservices
        description: Oracle Goldengate List Services for a Deployment
        call: rest-general.listservices
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/deployments/{deployment}/services/{service}
      name: services-v2-deployments-deployment-services-service
      description: REST surface for services-v2-deployments-deployment-services-service.
      operations:
      - method: GET
        name: getservice
        description: Oracle Goldengate Retrieve a Service
        call: rest-general.getservice
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createservice
        description: Oracle Goldengate Create a Service
        call: rest-general.createservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateservice
        description: Oracle Goldengate Update Service Properties
        call: rest-general.updateservice
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteservice
        description: Oracle Goldengate Remove a Service
        call: rest-general.deleteservice
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-general-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate REST API. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: oracle-goldengate-list-services-deployment
      description: Oracle Goldengate List Services for a Deployment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-general.listservices
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-service
      description: Oracle Goldengate Retrieve a Service
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-general.getservice
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-create-service
      description: Oracle Goldengate Create a Service
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-general.createservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-update-service-properties
      description: Oracle Goldengate Update Service Properties
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-general.updateservice
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-remove-service
      description: Oracle Goldengate Remove a Service
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-general.deleteservice
      outputParameters:
      - type: object
        mapping: $.