Oracle Database Indexes API

openapi: 3.2.0
info:
  title: Oracle Database Oracle SODA (Simple Oracle Document Access) REST Indexes 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: Indexes
  description: Collection index management
paths:
  /custom-actions/index/{collection}:
    post:
      operationId: createIndex
      summary: Oracle Database Create a collection index
      description: Creates an index on the specified collection based on the SODA index specification provided in the request body.
      tags:
      - Indexes
      parameters:
      - $ref: '#/components/parameters/collectionParam'
      requestBody:
        required: true
        description: SODA index specification
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IndexSpecification'
      responses:
        '200':
          description: Index created successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /custom-actions/unindex/{collection}:
    post:
      operationId: dropIndex
      summary: Oracle Database Drop a collection index
      description: Drops the specified index from the collection.
      tags:
      - Indexes
      parameters:
      - $ref: '#/components/parameters/collectionParam'
      requestBody:
        required: true
        description: Index to drop
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                  description: Name of the index to drop
      responses:
        '200':
          description: Index dropped successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
    IndexSpecification:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Index name
        fields:
          type: array
          description: Fields to index
          items:
            type: object
            properties:
              path:
                type: string
                description: JSON path to the field
              datatype:
                type: string
                description: Data type for indexing
                enum:
                - string
                - number
                - date
                - timestamp
              maxLength:
                type: integer
                description: Maximum length for string fields
              order:
                type: string
                enum:
                - asc
                - desc
        unique:
          type: boolean
          description: Whether the index enforces uniqueness
        language:
          type: string
          description: Language for text indexes
        spatial:
          type: string
          description: Spatial index specification
        search_on:
          type: string
          description: Full-text search specification
          enum:
          - none
          - text
          - text_value
  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'
  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/