Skip to content

Fix inaccurate Pagination section in General API Conventions#299

Merged
jordanpadams merged 1 commit into
mainfrom
doc/fix-pagination-conventions
Apr 2, 2026
Merged

Fix inaccurate Pagination section in General API Conventions#299
jordanpadams merged 1 commit into
mainfrom
doc/fix-pagination-conventions

Conversation

@jordanpadams

Copy link
Copy Markdown
Member

🗒️ Summary

Updates the Pagination/Sort section in general-conventions.html to fix inaccurate documentation that was causing user confusion (see NASA-PDS/registry-api#746):

  • Renames section from "Pagination/Sort" to "Pagination" (removes misleading "Sort" reference)
  • Removes the start query parameter, which does not exist in the PDS Search API
  • Removes the external Moesif blog link
  • Replaces the section with an accurate description of the actual pagination mechanism (search-after, sort, limit) and a cross-reference to the detailed pagination docs in the Search API guide

🤖 AI Assistance Disclosure

  • No AI assistance used
  • AI used for light assistance (e.g., suggestions, refactoring, documentation help, minor edits)
  • AI used for moderate content generation (AI generated some code or logic, but the developer authored or heavily revised the majority)
  • AI generated substantial portions of this code

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

  • Documentation: README, Wiki, or inline documentation (Sphinx, Javadoc, Docstrings) have been updated to reflect these changes.
  • Issue Traceability: The PR is linked to a valid GitHub Issue
  • PR Title: The PR title is "user-friendly" clearly identifying what is being fixed or the new feature being added, that if you saw it in the Release Notes for a tool, you would be able to get the gist of what was done.

Security & Quality

  • SonarCloud: Confirmed no new High or Critical security findings.
  • Secrets Detection: Verified that the Secrets Detection scan passed and no sensitive information (keys, tokens, PII) is exposed.
  • Code Quality: Code follows organization style guidelines and best practices for the specific language (e.g., PEP 8, Google Java Style).

Testing & Validation

  • Test Accuracy: Verified that test data is accurate, representative of real-world PDS4 scenarios, and sufficient for the logic being tested.
  • Coverage: Automated tests cover new logic and edge cases.
  • Local Verification: (If applicable) Successfully built and ran the changes in a local or staging environment.

Maintenance

  • Backward Compatibility: Confirmed that these changes do not break existing downstream dependencies or API contracts (or that breaking changes are clearly documented).

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>
@jordanpadams jordanpadams requested a review from a team as a code owner March 28, 2026 17:30
@jordanpadams jordanpadams self-assigned this Mar 28, 2026
@sonarqubecloud

Copy link
Copy Markdown

@nutjob4life nutjob4life left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doc delta: ✓
RST syntax: ✓
Approval: ✅

@jordanpadams jordanpadams merged commit 08e5d9d into main Apr 2, 2026
2 checks passed
@jordanpadams jordanpadams deleted the doc/fix-pagination-conventions branch April 2, 2026 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants