versioned_docs/version-0.9.0-incubating/open-api/indexes.yaml

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

---

components:
  schemas:
    IndexesSpec:
      type: array
      items:
        $ref: "#/components/schemas/IndexSpec"

    IndexSpec:
      type: object
      required:
        - indexType
        - fieldNames
      properties:
        indexType:
          type: string
          enum:
            - "primary_key"
            - "unique_key"
        name:
          type: string
          description: The name of the index
          nullable: true
        fieldNames:
          $ref: "./tables.yaml#/components/schemas/FieldNames"