VTEX · Schema

Index

Index information.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name	Type	Description
name	string	Index name.
acronym	string	Data entity name.
isGlobal	boolean	Defines whether the index is global (`true`) or not (`false`).
multiple	boolean	Determines whether the values need to be unique. If `false`, values must be unique.
fields	string	Comma-separated fields of the index.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Index",
  "title": "Index",
  "type": "object",
  "description": "Index information.",
  "properties": {
    "name": {
      "type": "string",
      "description": "Index name."
    },
    "acronym": {
      "type": "string",
      "description": "Data entity name."
    },
    "isGlobal": {
      "type": "boolean",
      "description": "Defines whether the index is global (`true`) or not (`false`).",
      "deprecated": true
    },
    "multiple": {
      "type": "boolean",
      "description": "Determines whether the values need to be unique. If `false`, values must be unique."
    },
    "fields": {
      "type": "string",
      "description": "Comma-separated fields of the index."
    }
  }
}