[SABRA-2456] Add V2 Facets and Searchabilities API Support#237
Open
aandrukhovich wants to merge 21 commits intomasterfrom
Open
[SABRA-2456] Add V2 Facets and Searchabilities API Support#237aandrukhovich wants to merge 21 commits intomasterfrom
aandrukhovich wants to merge 21 commits intomasterfrom
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 6 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Add V2 Facets and Searchabilities API Support
Summary
This PR adds support for the V2 versions of the
/v2/facetsand/v2/searchabilitiesendpoints, running in parallel with the existing V1 implementations.Changes
New Facets V2 Methods
addFacetConfigurationV2- Create a single facet configurationgetFacetConfigurationsV2- Retrieve all facet configurations with paginationgetFacetConfigurationV2- Get a specific facet by namemodifyFacetConfigurationsV2- Batch partial update facets (PATCH)modifyFacetConfigurationV2- Partially update a single facetreplaceFacetConfigurationV2- Replace a single facet configuration (PUT)createOrReplaceFacetConfigurationsV2- Batch create or replace facets (PUT)removeFacetConfigurationV2- Delete a facet configurationNew Searchabilities V2 Methods
retrieveSearchabilitiesV2- Retrieve searchabilities with filtering/pagination/sortinggetSearchabilityV2- Get a specific searchability by namepatchSearchabilitiesV2- Batch create or update searchabilitiespatchSearchabilityV2- Update a single searchabilitydeleteSearchabilitiesV2- Batch delete searchabilitiesdeleteSearchabilityV2- Delete a single searchabilityNew Types (TypeScript)
FacetConfigurationV2- V2 facet model withpathInMetadatafieldSearchabilityConfigurationV2- V2 searchability model with new fields (displayable,hidden,createdAt,updatedAt)V2 API Differences from V1
Facets:
pathInMetadatafield which specifies where in item metadata the facet data is located/v2/facetsendpoint instead of/v1/facetsSearchabilities:
displayableandhiddenfieldscreatedAt/updatedAttimestamps/v2/searchabilitiesendpoint instead of/v1/searchabilitiesTest Plan
catalog-facet-configurations-v2.jswith comprehensive test coverage for all facet V2 operationscatalog-searchabilities-v2.jswith comprehensive test coverage for all searchability V2 operationsafterhooksBreaking Changes
None. V2 methods are additive and V1 methods remain unchanged.