schema

Declaratively create or migrate a property's inverted index

Upserts the inverted index of a property, identified by indexName. The body describes the desired index configuration; the server diffs it against the current state and either creates the index, migrates its configuration, or does nothing. Index-mutating work is asynchronous: a 202 with a task ID is returned when a reindex task is submitted, and 200 with {"status":"NO_OP"} is returned when the desired configuration is already in place. indexName accepts rangeable as an alias for rangeFilters.

put/schema/{className}/properties/{propertyName}/index/{indexName}

Request

  • Base URL: https://localhost:8080/v1
  • URL: https://localhost:8080/v1/schema/{className}/properties/{propertyName}/index/{indexName}
  • Auth: one of:
    • none
    • OAuth 2 (implicit, authorization URL http://to-be-configured-in-the-application-config)

Path parameters

classNamestring required

The name of the collection (class) containing the property.

propertyNamestring required

The name of the property whose inverted index should be upserted.

indexName'filterable' | 'searchable' | 'rangeFilters' | 'rangeable' required

The inverted index type to upsert. rangeable is accepted as a write-path alias for rangeFilters.

Query parameters

tenantsstring[]

Tenant names to target. Never valid on PUT: every migration this endpoint can submit is semantic, and semantic migrations are always cluster-wide, so passing tenants is rejected with a 400. Tenant scoping remains available on the /rebuild variant.

Request body

tokenizationstring

Target tokenization for a searchable or filterable index. Required when creating a searchable index; optional otherwise (omitted = keep the current value). On filterable creation it must be omitted or equal the property's current tokenization.

algorithmstring

Target BM25 algorithm for a searchable index. Only blockmax is a valid target (input aliases block-max, block_max, blockmaxwand, bmw are accepted case-insensitively). From WAND this triggers the Map → BlockMax migration; on an already-blockmax index it is a NO_OP. wand is rejected (deprecated); downgrade is intentionally not supported.

Response

Desired configuration already in place AND no reindex task in flight; no task submitted. Body carries {"status":"NO_OP"}.

taskIdstring
statusstring

What the server did. STARTED: a reindex task was submitted and taskId names it. CANCELLED: a cancel stopped the in-flight task named by taskId. NO_OP: a cancel found nothing in flight, and taskId is absent. Not a closed set: a newer server may answer with a value this client does not know, so report an unrecognized status rather than rejecting the response.

Changes

No recorded changes to this operation across all 1 revision of this API.