docs(api-keys): add synonym_sets action scope and migration notice#437
Open
alangmartini wants to merge 3 commits intotypesense:masterfrom
Open
docs(api-keys): add synonym_sets action scope and migration notice#437alangmartini wants to merge 3 commits intotypesense:masterfrom
alangmartini wants to merge 3 commits intotypesense:masterfrom
Conversation
In v30, the synonym API route changed from /collections/{id}/synonyms
to /synonym_sets, which means API keys scoped to synonyms:* actions
no longer grant access to the new endpoints. This adds the new
synonym_sets:* actions and documents the migration path.
Move the breaking change notice about synonym API key actions from the api-keys page into the deprecations/behavior changes section of the changelog where users are more likely to see it during upgrades.
Users landing on the synonyms docs page should also see the notice about needing to update their API key actions from synonyms:* to synonym_sets:* when upgrading to v30.
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.
Summary
synonym_sets:*API key action scope to the v30.0 and v30.1 API Keys documentationsynonyms:*do not grant access to the new/synonym_setsendpoints, resulting in401 Unauthorizederrorssynonym_sets:*actions, then delete old keys (since there is no update endpoint for API keys)/collections/{collection}/synonymsendpointsContext
When upgrading to v30, the synonym API route changed from
/collections/{collection}/synonymsto/synonym_sets. Since Typesense derives API key action scopes from the API route + operation, any existing API keys usingsynonyms:*actions will not work with the new synonym sets endpoints.