docs: initial OpenAPI 3.0 spec reverse-engineered from Android/iOS clients - #3
Open
stevie86 wants to merge 1 commit into
Open
docs: initial OpenAPI 3.0 spec reverse-engineered from Android/iOS clients#3stevie86 wants to merge 1 commit into
stevie86 wants to merge 1 commit into
Conversation
…S clients
The sabbath-school-api-docs repo has been empty (LICENSE + 25-byte README)
since 2024-04. Mobile clients consume a real backend API but the surface is
undocumented. This commit adds a 17 KB OpenAPI 3.0 spec covering 19 endpoints
across 6 Retrofit interfaces in the Android client, reconciled with the iOS
client.
Endpoints documented:
- Auth: signin/anonymous, signin/google, refresh, delete (v2 + v3 parity)
- Resources: languages, feed, feedGroup, resource, document, segment,
userInput, saveUserInput, audio, video (v3)
- Lessons: getLessonInfo, getQuarterlies, getQuarterlyInfo (v2)
- Media: getAudio (v1 legacy), getVideoLanguages, getLatestVideo (v2)
Caveats called out in the spec:
- POST /api/v{2,3}/auth/refresh returns HTTP 500 (issue #204 in
Adventech/sabbath-school-ios)
- Most data endpoints return the Cloudflare Pages SPA fallback for
non-auth paths; only /api/v{2,3}/auth/* is publicly callable
No API keys, refresh tokens, or user data were stored beyond ephemeral
anonymous sign-in responses used to verify endpoint shapes.
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
The
sabbath-school-api-docsrepo has been empty (LICENSE + 25-byte README) since 2024-04. The mobile clients consume a real backend API but the surface is undocumented.This PR adds a 17 KB OpenAPI 3.0 spec (
openapi.yaml) covering 19 endpoints across 6 Retrofit interfaces in the Android client, reconciled with the iOS client.Endpoints documented
Auth (publicly callable, verified):
POST /api/v2/auth/signin/anonymous,/api/v3/auth/signin/anonymousPOST /api/v2/auth/signin/googlePOST /api/v2/auth/refresh— flagged as currently broken (HTTP 500, see issue #204 in sabbath-school-ios)POST /api/v2/auth/deleteResources (v3):
GET /api/v3/resources/index.jsonGET /api/v3/{language}/{type}/index.jsonGET /api/v3/{language}/{type}/feeds/{groupId}/index.jsonGET /api/v3/{index}/sections/index.jsonGET /api/v3/{index}/index.json(document or segment)GET /api/v3/resources/user/input/document/{documentId}POST /api/v3/resources/user/input/{inputType}/{documentId}/{blockId}GET /api/v3/{index}/audio.json,/api/v3/{index}/video.jsonLessons (v2):
GET /api/v2/{lesson}/index.jsonGET /api/v2/{lang}/quarterlies/index.jsonGET /api/v2/{lang}/quarterlies/{id}/index.jsonMedia:
GET /api/v1/{lang}/quarterlies/{quarterly_id}/audio.json(legacy v1)GET /api/v2/video/languages.jsonGET /api/v2/{lang}/video/latest.jsonVerification
Caveats called out in the spec
index.html) for non-auth paths. Only/api/v{2,3}/auth/*is publicly callable.auth/refreshis broken (HTTP 500).ResourceDocument,Segment,UserInput) are markedadditionalProperties: truebecause the actual BlockKit shape lives in a separate repo (https://github.com/Adventech/blockkit) and is not exhaustively documented here.Authorship
Initial draft by an external contributor reverse-engineering the public Android and iOS source. No API keys, refresh tokens, or user data were stored beyond ephemeral anonymous sign-in responses used to verify endpoint shapes.
Happy to follow up with a separate PR for the broken
auth/refreshendpoint once the maintainers confirm which leg is the regression.