Oracle GoldenGate for Big Data REST API — Configuration

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate for Big Data REST API — Configuration
  description: 'Oracle GoldenGate for Big Data REST API — Configuration. 5 operations. Lead operation: Oracle Goldengate List
    Configuration Files. 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: big-data-rest-configuration
    baseUri: https://{goldengate-host}:{port}
    description: Oracle GoldenGate for Big Data REST API — Configuration business capability. Self-contained, no shared references.
    resources:
    - 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
    authentication:
      type: basic
      username: '{{env.ORACLE_GOLDENGATE_USER}}'
      password: '{{env.ORACLE_GOLDENGATE_PASS}}'
  exposes:
  - type: rest
    namespace: big-data-rest-configuration-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate for Big Data REST API — Configuration. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - 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: big-data-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: big-data-rest-configuration.getconfigfile
        with:
          file: rest.file
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createconfigfile
        description: Oracle Goldengate Create a Configuration File
        call: big-data-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: big-data-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: big-data-rest-configuration.deleteconfigfile
        with:
          file: rest.file
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: big-data-rest-configuration-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate for Big Data REST API — Configuration. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: oracle-goldengate-list-configuration-files
      description: Oracle Goldengate List Configuration Files
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: big-data-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: big-data-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: big-data-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: big-data-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: big-data-rest-configuration.deleteconfigfile
      with:
        file: tools.file
      outputParameters:
      - type: object
        mapping: $.