Oracle Database Metadata API

openapi: 3.2.0
info:
  title: Oracle Database Oracle SODA (Simple Oracle Document Access) REST Metadata API
  description: NoSQL-style document access API for Oracle Database. SODA for REST provides HTTP operations for managing JSON document collections, enabling CRUD operations, querying by example (QBE), bulk operations, and index management through a RESTful interface built on Oracle REST Data Services.
  version: 1.0.0
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Technology Network License
    url: https://www.oracle.com/downloads/licenses/standard-license.html
  termsOfService: https://www.oracle.com/legal/terms.html
servers:
- url: https://{host}:{port}/ords/{schema}/soda/{version}
  description: SODA REST API Server
  variables:
    host:
      default: localhost
      description: ORDS server hostname
    port:
      default: '8443'
      description: ORDS server port
    schema:
      default: myschema
      description: Oracle Database schema name
    version:
      default: latest
      description: SODA API version
security:
- oauth2: []
- basicAuth: []
tags:
- name: Metadata
  description: Collection metadata and catalog operations
paths:
  /metadata-catalog:
    get:
      operationId: getCatalog
      summary: Oracle Database Get collection catalog with metadata
      description: Lists all collections in the schema with full metadata and navigation links. Each collection includes its properties and links to the collection itself and its JSON schema.
      tags:
      - Metadata
      parameters:
      - name: limit
        in: query
        description: Maximum number of collections to return
        schema:
          type: integer
          minimum: 1
      - name: fromID
        in: query
        description: Start from this collection name (inclusive)
        schema:
          type: string
      responses:
        '200':
          description: Catalog retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /metadata-catalog/{collection}:
    get:
      operationId: getCollectionSchema
      summary: Oracle Database Get JSON schema for a collection
      description: Retrieves the JSON schema describing the document structure for the specified collection, including collection properties and column configurations.
      tags:
      - Metadata
      parameters:
      - $ref: '#/components/parameters/collectionParam'
      responses:
        '200':
          description: Collection schema retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionSchema'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /custom-actions/:
    get:
      operationId: listCustomActions
      summary: Oracle Database List available custom actions
      description: Returns a list of available custom actions for SODA collections.
      tags:
      - Metadata
      responses:
        '200':
          description: Custom actions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        description:
                          type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
    CollectionSchema:
      type: object
      properties:
        name:
          type: string
          description: Collection name
        properties:
          type: object
          properties:
            schemaName:
              type: string
              description: Database schema name
            tableName:
              type: string
              description: Underlying table name
            keyColumn:
              type: object
              description: Key column configuration
            contentColumn:
              type: object
              description: Content column configuration
            versionColumn:
              type: object
              description: Version column configuration
            lastModifiedColumn:
              type: object
              description: Last modified column configuration
            readOnly:
              type: boolean
              description: Whether collection is read-only
        schema:
          type: object
          description: JSON Schema describing document structure
          properties:
            type:
              type: string
            properties:
              type: object
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
    Link:
      type: object
      properties:
        rel:
          type: string
          description: Link relation type
        href:
          type: string
          format: uri
          description: Link URL
        mediaType:
          type: string
          description: Media type of the linked resource
    CatalogResponse:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Collection name
              properties:
                type: object
                description: Collection metadata properties
              links:
                type: array
                items:
                  $ref: '#/components/schemas/Link'
        hasMore:
          type: boolean
  responses:
    NotFound:
      description: The specified collection or document was not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or credentials invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request - invalid parameter value
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    collectionParam:
      name: collection
      in: path
      required: true
      description: The name of the SODA collection
      schema:
        type: string
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /ords/{schema}/oauth/token
          scopes: {}
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: SODA for REST Documentation
  url: https://docs.oracle.com/en/database/oracle/simple-oracle-document-access/rest/