Fix inaccurate Pagination section in General API Conventions#299
Merged
Conversation
Removes the `start` parameter which does not exist in the PDS Search API, removes the misleading "Sort" reference from the section heading, drops the external Moesif link, and replaces the section with an accurate description and cross-reference to the detailed pagination docs in the Search API guide. Fixes NASA-PDS/registry-api#746 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
nutjob4life
approved these changes
Mar 28, 2026
nutjob4life
left a comment
Member
There was a problem hiding this comment.
Doc delta: ✓
RST syntax: ✓
Approval: ✅
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.



🗒️ Summary
Updates the Pagination/Sort section in
general-conventions.htmlto fix inaccurate documentation that was causing user confusion (see NASA-PDS/registry-api#746):startquery parameter, which does not exist in the PDS Search APIsearch-after,sort,limit) and a cross-reference to the detailed pagination docs in the Search API guide🤖 AI Assistance Disclosure
Estimated % of code influenced by AI: 80 %
⚙️ Test Data and/or Report
Documentation-only change. Verified by reading the updated RST source and confirming it accurately reflects the implemented Search API pagination behavior described in
docs/source/guides/search/endpoints.rst.♻️ Related Issues
Fixes NASA-PDS/registry-api#746
🤓 Reviewer Checklist
Reviewers: Please verify the following before approving this pull request.
Documentation and PR Content
Security & Quality
Testing & Validation
Maintenance