docs: complete API v3 documentation (resolves #2650)#1
Open
rafaumeu wants to merge 2 commits into
Open
Conversation
Reverse-engineered from production endpoints and official client source code. Covers all endpoints, content hierarchy, block types, naming conventions, assets CDN, and error handling patterns. Resolves #2650
- Full v2 endpoint documentation (resources, quarterlies, lessons, days, read) - v2 vs v3 comparison table - v2/v3 content hierarchy diagrams - HTML content format + Bible verse reference system - PDF CDN documentation - Language coverage table (7 languages sampled)
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.
Summary
This PR adds comprehensive documentation for the Sabbath School API v3, resolving issue #2650 which has been open for 2+ years with multiple requests from the community.
Background
The API v3 has been live in production since late 2024, but documentation was never published. This documentation was sourced by:
What's Documented
Testing
All documented endpoints were verified against production (https://sabbath-school.adventech.io/api/v3/) across multiple languages (en, pt, es, zh) and content types (ss, aij, devo).
Closes #2650