IndexPublicConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/emporix/main/json-schema/emporix-index-public-configuration-schema.json",
  "title": "IndexPublicConfiguration",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/emporix-indexing-service-openapi.yml#/components/schemas/IndexPublicConfiguration",
  "type": "object",
  "properties": {
    "searchKey": {
      "type": "string",
      "description": "API Key used for search purposes."
    },
    "applicationId": {
      "type": "string",
      "description": "Application id of an indexer provider."
    },
    "indexName": {
      "type": "string",
      "description": "Identifier of an index."
    },
    "provider": {
      "type": "string",
      "description": "Index provider name. Supported providers: `ALGOLIA` (https://www.algolia.com), `BATTERY_INCLUDED` (https://www.batteryincluded.io). Only one provider can be active per tenant at a time.",
      "enum": [
        "ALGOLIA",
        "BATTERY_INCLUDED"
      ]
    },
    "active": {
      "type": "boolean",
      "description": "Indicates if the configuration is active or not."
    }
  }
}