Currently, CX has two legacy tables in its database infrastructure, that were used to serve suggestions in previous CX versions: cx_lists and cx_suggestions. However, the Unified Dashboard doesn't make any use of these tables except one single case: the favorite suggestions.
In the past there was also a API module to support addition and removal of suggestions to suggestion lists named ApiContentTranslationSuggestionList, but that was removed as part of T395653, and it was replaced with a new API module named ApiContentTranslationFavoriteSuggestions (T397354).
Following the same logic, this task proposes the renaming of the ApiQueryContentTranslationSuggestions API module to ApiQueryContentTranslationFavoriteSuggestions and its repurposing to only serve favorite suggestions, as no other kind of suggestions are anymore stored in the databases.
Derived Requirement
Repurpose the ApiQueryContentTranslationSuggestions API module to serve only favorite suggestions and rename it to ApiQueryContentTranslationFavoriteSuggestions.
The updated API should:
- Retrieve only favorite suggestions from the database.
- Exclude all other suggestion types previously stored in legacy tables (cx_lists and cx_suggestions).
- Maintain existing functionality for querying, filtering, and returning user-specific favorite suggestions.
- Ensure compatibility with the Unified Dashboard, which relies solely on favorite suggestions.
Test Steps
Test Case 1: Verify API renaming
- Access the API sandbox or endpoint for ApiQueryContentTranslationFavoriteSuggestions.
- Execute a GET request to confirm endpoint accessibility.
- ✅❓❌⬜ AC1: Confirm that the endpoint ApiQueryContentTranslationFavoriteSuggestions exists and ApiQueryContentTranslationSuggestions is deprecated or removed.
Test Case 2: Verify only favorite suggestions are returned
- Using the new ApiQueryContentTranslationFavoriteSuggestions endpoint, execute a query as a logged-in user with saved favorite suggestions.
- Review the API response payload.
- ✅❓❌⬜ AC2: Confirm that the returned data includes only favorite suggestions (no other suggestion types).
Test Case 3: Verify no legacy data (non-favorite suggestions) are served
- Query the API using a user account that has data in the legacy tables (cx_lists or cx_suggestions) but no favorite suggestions.
- ✅❓❌⬜ AC3: Confirm that the response is empty or includes only favorite suggestions, not legacy entries.
QA Results - TestWiki
| AC | Status | Details |
|---|---|---|
| 1 | ✅ | T404049#11256995 |
| 2 | ✅ | T404049#11256995 |
| 3 | ✅ | T404049#11256995 |