Open
Conversation
Adds 30 new path entries and 24 new component schemas to docs/openAPI.json,
covering Sheets, Collections, Text, Index (incl. Authors), Related, Calendars,
and a public Profile endpoint. Two new tags ("Sheets", "Collections") create
dedicated ReadMe sidebar folders; Authors are folded into Index and Profile
into Misc per the audit decision.
Every example was captured from a live www.sefaria.org response — no invented
values. Schemas reuse existing components (ref, SheetsJSON, BillingualJSON)
where shapes match.
Adds docs/decisions/documented_endpoints.md as a stable audit artifact: the
in-scope list, the skip rubric for future engineers, and the per-endpoint
reasoning for everything that was excluded (auth-required, staff-only,
internal infrastructure, broken under load, etc).
Validation: `npx rdme openapi:validate docs/openAPI.json` passes (the same
command CI runs). Two pre-existing spectral lint errors in textAPIReponse
and RelatedJSON.sheets.example are unchanged by this commit.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
📊 Code Quality Score: 42/100
Scored by GitVelocity · How are scores calculated? |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/extends public API documentation by expanding the documented endpoint set and recording the decision-making audit for what is (and isn’t) exposed to external developers.
Changes:
- Adds an endpoint inventory/audit document with publication decisions and skip rubric.
- Summarizes newly documented vs. skipped endpoints and proposed ReadMe tag grouping.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Description
This PR adds AI-assisted documentation to the OpenAPI.json file for 29 additional endpoints which may be helpful for public-facing users, organized by tags.
Note:
Validation:
npx rdme openapi:validate docs/openAPI.jsonpasses (the same command CI runs).Code Changes
OpenAPI.jsondocs/decisions.Notes