docs: deprecate reindex/backfill and ES-era query param docs (PPT-2644) - #29
Merged
Conversation
Search is served from PostgreSQL full-text search: /reindex and /backfill are server-side no-ops pending removal, the fields and ref params are ignored, and q is prefix-word matching (all words must match). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
🎉 This PR is included in version 6.0.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of PPT-2644: PlaceOS search moved from Elasticsearch to PostgreSQL full-text search (models#324/#325, rest-api#445 — merged). The ES-era admin endpoints
/reindexand/backfillare now server-side 200 no-ops pending removal, and several index-endpoint query params changed meaning or stopped doing anything. This PR updates the SDK docs to match; it is documentation/deprecation only — zero runtime change.What
reindex()andbackfill()(src/root/functions.ts) are tagged@deprecated— they still call their endpoints (which return 200) so existing callers, including Backoffice's admin card, keep working. The methods themselves will be removed in the next ts-client major.PlaceResourceQueryOptions(src/resources/interface.ts) doc rewrites:q— no longer ESsimple_query_stringsyntax; words match as prefixes against the resource's searchable fields and all words must match.fields—@deprecated, ignored by the server (was ES field-list/boost syntax).ref—@deprecated, ignored by the server; pagination follows theLinkheader's offset.offset— un-deprecated (it is the pagination mechanism again), max corrected to 1,000,000.limit— max corrected from 500 to 10,000.Verification
@deprecatedJSDoc tags.Merge order
Independent of the other PPT-2644 infra-removal PRs — safe to merge any time. Actual removal of
reindex()/backfill()lands in the next ts-client major.