Oracle GoldenGate REST API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate REST API — Configuration
  description: 'Oracle GoldenGate REST API — Configuration. 11 operations. Lead operation: Oracle Goldengate Retrieve Api
    Versions. Self-contained Naftiko capability covering one Oracle Goldengate business surface.'
  tags:
  - Oracle Goldengate
  - Configuration
  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-configuration
    baseUri: https://{goldengate-host}:{port}
    description: Oracle GoldenGate REST API — Configuration business capability. Self-contained, no shared references.
    resources:
    - name: services
      path: /services
      operations:
      - name: getapiversions
        method: GET
        description: Oracle Goldengate Retrieve Api Versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2
      path: /services/v2
      operations:
      - name: describeapiversion
        method: GET
        description: Oracle Goldengate Describe Api Version V2
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-config-files
      path: /services/v2/config/files
      operations:
      - name: listconfigfiles
        method: GET
        description: Oracle Goldengate List Configuration Files
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-config-files-file
      path: /services/v2/config/files/{file}
      operations:
      - name: getconfigfile
        method: GET
        description: Oracle Goldengate Retrieve a Configuration File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file
          in: path
          type: string
          required: true
      - name: createconfigfile
        method: POST
        description: Oracle Goldengate Create a Configuration File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: replaceconfigfile
        method: PUT
        description: Oracle Goldengate Replace a Configuration File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteconfigfile
        method: DELETE
        description: Oracle Goldengate Delete a Configuration File
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: file
          in: path
          type: string
          required: true
    - name: services-v2-config-summary
      path: /services/v2/config/summary
      operations:
      - name: getconfigsummary
        method: GET
        description: Oracle Goldengate Get Service Configuration Summary
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-config-types
      path: /services/v2/config/types
      operations:
      - name: listconfigtypes
        method: GET
        description: Oracle Goldengate List Configuration Data Types
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-parameters
      path: /services/v2/parameters
      operations:
      - name: listparameters
        method: GET
        description: Oracle Goldengate List Parameter Names
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-v2-parameters-parameter
      path: /services/v2/parameters/{parameter}
      operations:
      - name: getparameterinfo
        method: GET
        description: Oracle Goldengate Retrieve Parameter Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: parameter
          in: path
          type: string
          required: true
    authentication:
      type: basic
      username: '{{env.ORACLE_GOLDENGATE_USER}}'
      password: '{{env.ORACLE_GOLDENGATE_PASS}}'
  exposes:
  - type: rest
    namespace: rest-configuration-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate REST API — Configuration. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/services
      name: services
      description: REST surface for services.
      operations:
      - method: GET
        name: getapiversions
        description: Oracle Goldengate Retrieve Api Versions
        call: rest-configuration.getapiversions
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2
      name: services-v2
      description: REST surface for services-v2.
      operations:
      - method: GET
        name: describeapiversion
        description: Oracle Goldengate Describe Api Version V2
        call: rest-configuration.describeapiversion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/config/files
      name: services-v2-config-files
      description: REST surface for services-v2-config-files.
      operations:
      - method: GET
        name: listconfigfiles
        description: Oracle Goldengate List Configuration Files
        call: rest-configuration.listconfigfiles
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/config/files/{file}
      name: services-v2-config-files-file
      description: REST surface for services-v2-config-files-file.
      operations:
      - method: GET
        name: getconfigfile
        description: Oracle Goldengate Retrieve a Configuration File
        call: rest-configuration.getconfigfile
        with:
          file: rest.file
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconfigfile
        description: Oracle Goldengate Create a Configuration File
        call: rest-configuration.createconfigfile
        with:
          file: rest.file
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replaceconfigfile
        description: Oracle Goldengate Replace a Configuration File
        call: rest-configuration.replaceconfigfile
        with:
          file: rest.file
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteconfigfile
        description: Oracle Goldengate Delete a Configuration File
        call: rest-configuration.deleteconfigfile
        with:
          file: rest.file
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/config/summary
      name: services-v2-config-summary
      description: REST surface for services-v2-config-summary.
      operations:
      - method: GET
        name: getconfigsummary
        description: Oracle Goldengate Get Service Configuration Summary
        call: rest-configuration.getconfigsummary
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/config/types
      name: services-v2-config-types
      description: REST surface for services-v2-config-types.
      operations:
      - method: GET
        name: listconfigtypes
        description: Oracle Goldengate List Configuration Data Types
        call: rest-configuration.listconfigtypes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/parameters
      name: services-v2-parameters
      description: REST surface for services-v2-parameters.
      operations:
      - method: GET
        name: listparameters
        description: Oracle Goldengate List Parameter Names
        call: rest-configuration.listparameters
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/v2/parameters/{parameter}
      name: services-v2-parameters-parameter
      description: REST surface for services-v2-parameters-parameter.
      operations:
      - method: GET
        name: getparameterinfo
        description: Oracle Goldengate Retrieve Parameter Information
        call: rest-configuration.getparameterinfo
        with:
          parameter: rest.parameter
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate REST API — Configuration. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: oracle-goldengate-retrieve-api-versions
      description: Oracle Goldengate Retrieve Api Versions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.getapiversions
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-describe-api-version
      description: Oracle Goldengate Describe Api Version V2
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.describeapiversion
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-list-configuration-files
      description: Oracle Goldengate List Configuration Files
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.listconfigfiles
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-configuration-file
      description: Oracle Goldengate Retrieve a Configuration File
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.getconfigfile
      with:
        file: tools.file
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-create-configuration-file
      description: Oracle Goldengate Create a Configuration File
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-configuration.createconfigfile
      with:
        file: tools.file
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-replace-configuration-file
      description: Oracle Goldengate Replace a Configuration File
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-configuration.replaceconfigfile
      with:
        file: tools.file
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-delete-configuration-file
      description: Oracle Goldengate Delete a Configuration File
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-configuration.deleteconfigfile
      with:
        file: tools.file
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-get-service-configuration
      description: Oracle Goldengate Get Service Configuration Summary
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.getconfigsummary
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-list-configuration-data
      description: Oracle Goldengate List Configuration Data Types
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.listconfigtypes
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-list-parameter-names
      description: Oracle Goldengate List Parameter Names
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.listparameters
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-parameter-information
      description: Oracle Goldengate Retrieve Parameter Information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-configuration.getparameterinfo
      with:
        parameter: tools.parameter
      outputParameters:
      - type: object
        mapping: $.