Oracle GoldenGate Veridata REST API — Server

naftiko: 1.0.0-alpha2
info:
  label: Oracle GoldenGate Veridata REST API — Server
  description: 'Oracle GoldenGate Veridata REST API — Server. 7 operations. Lead operation: Oracle Goldengate Login to Veridata.
    Self-contained Naftiko capability covering one Oracle Goldengate business surface.'
  tags:
  - Oracle Goldengate
  - Server
  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-server
    baseUri: https://{veridata-host}:{port}/veridata/v1
    description: Oracle GoldenGate Veridata REST API — Server business capability. Self-contained, no shared references.
    resources:
    - name: auth-login
      path: /auth/login
      operations:
      - name: login
        method: GET
        description: Oracle Goldengate Login to Veridata
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Authorization
          in: header
          type: string
          required: true
    - name: services-server-configuration
      path: /services/server/configuration
      operations:
      - name: getserverconfiguration
        method: GET
        description: Oracle Goldengate Retrieve Server Configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateserverconfiguration
        method: PATCH
        description: Oracle Goldengate Update Server Configurations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: services-server-configuration-reset
      path: /services/server/configuration/reset
      operations:
      - name: resetserverconfiguration
        method: PUT
        description: Oracle Goldengate Reset Server Configurations to Default
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: services-server-info
      path: /services/server/info
      operations:
      - name: getserverinfo
        method: GET
        description: Oracle Goldengate Retrieve Server Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: session-extend
      path: /session/extend
      operations:
      - name: extendsession
        method: GET
        description: Oracle Goldengate Extend User Session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: session-invalidate
      path: /session/invalidate
      operations:
      - name: invalidatesession
        method: GET
        description: Oracle Goldengate Invalidate Session (logout)
        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-server-rest
    port: 8080
    description: REST adapter for Oracle GoldenGate Veridata REST API — Server. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/auth/login
      name: auth-login
      description: REST surface for auth-login.
      operations:
      - method: GET
        name: login
        description: Oracle Goldengate Login to Veridata
        call: veridata-rest-server.login
        with:
          Authorization: rest.Authorization
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/server/configuration
      name: services-server-configuration
      description: REST surface for services-server-configuration.
      operations:
      - method: GET
        name: getserverconfiguration
        description: Oracle Goldengate Retrieve Server Configurations
        call: veridata-rest-server.getserverconfiguration
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateserverconfiguration
        description: Oracle Goldengate Update Server Configurations
        call: veridata-rest-server.updateserverconfiguration
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/server/configuration/reset
      name: services-server-configuration-reset
      description: REST surface for services-server-configuration-reset.
      operations:
      - method: PUT
        name: resetserverconfiguration
        description: Oracle Goldengate Reset Server Configurations to Default
        call: veridata-rest-server.resetserverconfiguration
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/services/server/info
      name: services-server-info
      description: REST surface for services-server-info.
      operations:
      - method: GET
        name: getserverinfo
        description: Oracle Goldengate Retrieve Server Details
        call: veridata-rest-server.getserverinfo
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/session/extend
      name: session-extend
      description: REST surface for session-extend.
      operations:
      - method: GET
        name: extendsession
        description: Oracle Goldengate Extend User Session
        call: veridata-rest-server.extendsession
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/session/invalidate
      name: session-invalidate
      description: REST surface for session-invalidate.
      operations:
      - method: GET
        name: invalidatesession
        description: Oracle Goldengate Invalidate Session (logout)
        call: veridata-rest-server.invalidatesession
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: veridata-rest-server-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle GoldenGate Veridata REST API — Server. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: oracle-goldengate-login-veridata
      description: Oracle Goldengate Login to Veridata
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-server.login
      with:
        Authorization: tools.Authorization
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-server-configurations
      description: Oracle Goldengate Retrieve Server Configurations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-server.getserverconfiguration
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-update-server-configurations
      description: Oracle Goldengate Update Server Configurations
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: veridata-rest-server.updateserverconfiguration
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-reset-server-configurations
      description: Oracle Goldengate Reset Server Configurations to Default
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: veridata-rest-server.resetserverconfiguration
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-retrieve-server-details
      description: Oracle Goldengate Retrieve Server Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-server.getserverinfo
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-extend-user-session
      description: Oracle Goldengate Extend User Session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-server.extendsession
      outputParameters:
      - type: object
        mapping: $.
    - name: oracle-goldengate-invalidate-session-logout
      description: Oracle Goldengate Invalidate Session (logout)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: veridata-rest-server.invalidatesession
      outputParameters:
      - type: object
        mapping: $.