Oracle Database 19c - Oracle REST Data Services (ORDS) API — SODA

naftiko: 1.0.0-alpha2
info:
  label: Oracle Database 19c - Oracle REST Data Services (ORDS) API — SODA
  description: 'Oracle Database 19c - Oracle REST Data Services (ORDS) API — SODA. 5 operations. Lead operation: List documents
    in a SODA collection. Self-contained Naftiko capability covering one Oracle Database 19c business surface.'
  tags:
  - Oracle Database 19c
  - SODA
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_DATABASE_19C_API_KEY: ORACLE_DATABASE_19C_API_KEY
capability:
  consumes:
  - type: http
    namespace: ords-soda
    baseUri: https://{host}:{port}/ords
    description: Oracle Database 19c - Oracle REST Data Services (ORDS) API — SODA business capability. Self-contained, no
      shared references.
    resources:
    - name: schema-soda-latest-collection
      path: /{schema}/soda/latest/{collection}
      operations:
      - name: listsodadocuments
        method: GET
        description: List documents in a SODA collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection
          in: path
          type: string
          required: true
        - name: limit
          in: query
          type: integer
        - name: offset
          in: query
          type: integer
      - name: insertsodadocument
        method: POST
        description: Insert a document into a SODA collection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: schema-soda-latest-collection-key
      path: /{schema}/soda/latest/{collection}/{key}
      operations:
      - name: getsodadocument
        method: GET
        description: Get a SODA document by key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
      - name: replacesodadocument
        method: PUT
        description: Replace a SODA document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesodadocument
        method: DELETE
        description: Delete a SODA document
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collection
          in: path
          type: string
          required: true
        - name: key
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.ORACLE_DATABASE_19C_API_KEY}}'
  exposes:
  - type: rest
    namespace: ords-soda-rest
    port: 8080
    description: REST adapter for Oracle Database 19c - Oracle REST Data Services (ORDS) API — SODA. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/{schema}/soda/latest/{collection}
      name: schema-soda-latest-collection
      description: REST surface for schema-soda-latest-collection.
      operations:
      - method: GET
        name: listsodadocuments
        description: List documents in a SODA collection
        call: ords-soda.listsodadocuments
        with:
          collection: rest.collection
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: insertsodadocument
        description: Insert a document into a SODA collection
        call: ords-soda.insertsodadocument
        with:
          collection: rest.collection
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/{schema}/soda/latest/{collection}/{key}
      name: schema-soda-latest-collection-key
      description: REST surface for schema-soda-latest-collection-key.
      operations:
      - method: GET
        name: getsodadocument
        description: Get a SODA document by key
        call: ords-soda.getsodadocument
        with:
          collection: rest.collection
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replacesodadocument
        description: Replace a SODA document
        call: ords-soda.replacesodadocument
        with:
          collection: rest.collection
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesodadocument
        description: Delete a SODA document
        call: ords-soda.deletesodadocument
        with:
          collection: rest.collection
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ords-soda-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Database 19c - Oracle REST Data Services (ORDS) API — SODA. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: list-documents-soda-collection
      description: List documents in a SODA collection
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-soda.listsodadocuments
      with:
        collection: tools.collection
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: insert-document-soda-collection
      description: Insert a document into a SODA collection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ords-soda.insertsodadocument
      with:
        collection: tools.collection
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-soda-document-key
      description: Get a SODA document by key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ords-soda.getsodadocument
      with:
        collection: tools.collection
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.
    - name: replace-soda-document
      description: Replace a SODA document
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ords-soda.replacesodadocument
      with:
        collection: tools.collection
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-soda-document
      description: Delete a SODA document
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ords-soda.deletesodadocument
      with:
        collection: tools.collection
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.