[SITES-47932] docs: add GET /sites response examples for all three response shapes#2846
Draft
habansal wants to merge 1 commit into
Draft
[SITES-47932] docs: add GET /sites response examples for all three response shapes#2846habansal wants to merge 1 commit into
habansal wants to merge 1 commit into
Conversation
…ponse shapes Adds named OpenAPI examples for SiteList, SitePagedResponse, and SiteSearchResponse so the API docs show real response samples in the dropdown rather than the Redoc-generated empty placeholder. Also bumps @adobe/spacecat-shared-drs-client 1.13.0 → 1.14.0 to fix pre-existing type-check failures (listJobs and createBrandPresenceSchedule were missing from the published DrsClient type definition). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Related Issues
SITES-47932
Summary
The GET /sites endpoint supports three response shapes but none had named OpenAPI examples, so the API docs showed an empty
[]placeholder in the right-hand dropdown regardless of which shape was used.site-list,site-paged-response, andsite-search-responsetoexamples.yamlresponses.200block insites-api.yamlso all three appear in the Redoc dropdowndocs/index.html@adobe/spacecat-shared-drs-client1.13.0 → 1.14.0 to fix pre-existing type-check failures (listJobsandcreateBrandPresenceSchedulewere missing from the publishedDrsClienttype definition)Test plan
npm run docs:lint— passes with 0 errorsnpm run docs:build— builds successfullynpm run type-check— passes cleandocs/index.htmllocally and verify GET /sites shows three options in the Example dropdown: SiteList, SitePagedResponse, SiteSearchResponse, each with real data🤖 Generated with Claude Code