Database endpoints
Configure stopwords
Replaces the stopword list for a table field's full-text index.
POST /v1/tenants/{tenant}/fts/{table}/{field}/stopwords
- Choose the indexed fieldTarget the table and full-text field.
- Supply the complete listInclude every word the setting should retain.
- Confirm the saved settingExpect an empty 201 response.
Before you start
Use your database bearer token.
This replaces the field's complete stopword list. Send an empty list to disable stopwords for that field.
Path parameters
| Field | Type | Required |
|---|---|---|
tenant | string | Required |
table | string | Required |
field | string | Required |
Headers
| Field | Type | Required | Description |
|---|---|---|---|
x-oc-db-user | string | Optional | Acting database user (role, grant and row-policy checks). Send with x-oc-db-key. |
x-oc-db-key | string | Optional | API key of the x-oc-db-user user. |
Request body
application/json
Limits and accepted values
- The complete list for this table field;
- an empty array disables stopwords for the field.
| Field | Type | Required |
|---|---|---|
stopwords | string[] | Required |
Fields in stopwords
| Field | Type | Required |
|---|---|---|
stopwords | string | Optional |
Read the result
Success is 201 with an empty body. The supplied array replaces the whole field's stopword list. Send all words you want to keep, or an empty array to disable the list.
Response statuses
HTTP status reference
| Status | What to do |
|---|---|
| 201 | Created |
| 400 | Correct the request before retrying. |
| 401 | Check the credential and Authorization header. |
| 402 | Check feature access or available credits. |
| 403 | Check tenant access, roles and permissions. |
| 409 | Resolve the conflict before retrying. |
| 413 | Split or reduce the request body. |
| 415 | Send the required Content-Type. |
| 422 | Correct the values or unsupported combination. |
| 429 | Honor Retry-After when present; back off. |
| 503 | Honor Retry-After when present; check write outcomes. |