Elastic Path Stopword Sets API
Stopword Sets allow you to define sets of common words (such as "the", "a", "an", "is") that should be ignored during search queries. By removing these low-value terms from search processing, you can improve search relevance and reduce noise in results.### How Stopword Sets WorkA stopword set is a named container of stopword words. Each set belongs to an organization or store and is synced asynchronously. Once synced, the stopwords are applied during search query processing to filter out the specified terms.### Common StopwordsStopword sets contain a flat list of words to ignore:- **Common articles**: "the", "a", "an"- **Prepositions**: "in", "on", "at", "for"- **Conjunctions**: "and", "or", "but"### Sync StatusStopword sets are synced asynchronously. The sync status is tracked and exposed in API responses:| Status | Description ||------------------|----------------------------------------------------------------|| `pending_sync` | Set has been created or updated in MongoDB but not yet synced || `synced` | Set has been successfully synced || `sync_failed` | The last sync attempt failed || `pending_delete` | Set is marked for deletion; a background worker will remove it |### TenancyStopword sets follow the same tenancy model as other resources:- **Organization-scoped sets**: Managed by the organization; apply across all stores- **Store-scoped sets**: Managed by the store; apply only to that storeStores cannot modify organization-scoped stopword sets.
Elastic Path Stopword Sets API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Stopword Sets. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 5 operations across 2 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.
Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Elastic Path Stopword Sets API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (BearerToken).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Stopword Sets allow you to define sets of common words (such as "the", "a", "an", "is") that should be ignored during search queries. By removing these low-value terms from search…
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are StopwordSetMeta (5 properties), Error (4 properties), StopwordSet (4 properties), StopwordSetAttributes (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Elastic Path 12
Other APIs Elastic Path publishes across the network.