Add audio timings API endpoint and documentation - #66
Open
KallynGowdy wants to merge 1 commit into
Open
KallynGowdy wants to merge 1 commit into
KallynGowdy wants to merge 1 commit into
Conversation
Add a "Get the Audio Timings for a Chapter" section covering
/api/{translation}/{book}/{chapter}.{reader}.audioTimings.json, and fill in
the thisChapterAudioTimings/next/previous link fields that were already part
of the chapter and simplified-chapter response schemas but missing from the
docs. Also document the raw per-verse timings embedded in the complete
translation downloads (renamed to TranslationBookChapterAudioTimingsMap to
avoid colliding with the new per-endpoint type name), correcting the
complete-chapter interface to list its actual fields instead of extending
the full per-chapter type.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01M4cbAY2rUoVD6LqXaHTXcg
KallynGowdy
force-pushed
the
claude/audio-timings-docs-2qrxey
branch
from
September 4, 2026 15:29
7a2bbfe to
41860b3
Compare
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
This PR adds comprehensive support for audio timings across the Bible API documentation. It introduces a new endpoint for retrieving per-verse audio timing data and updates all related chapter endpoints to include audio timing links and data.
Key Changes
New Endpoint: Added "Get the Audio Timings for a Chapter" endpoint (
GET /api/{translation}/{book}/{chapter}.{reader}.audioTimings.json) that returns per-verse start times in seconds for a specific reader's narrationTranslationBookChapterAudioTimings)Standard Format Updates (
docs/reference/translations/standard.md):thisChapterAudioTimings,nextChapterAudioTimings, andpreviousChapterAudioTimingsfields toTranslationBookChapterinterfaceTranslationBookChapterAudioTimingsLinksinterface to map reader IDs to audio timing file URLsTranslationCompleteChapterto include embedded audio timings data via newTranslationBookChapterAudioTimingsMapinterfaceSimplified Format Updates (
docs/reference/translations/simplified.md):thisChapterAudioTimings,nextChapterAudioTimings, andpreviousChapterAudioTimingsfields toSimpleTranslationBookChapterinterfaceSimpleTranslationCompleteChapterto useTranslationBookChapterAudioTimingsMapNotable Implementation Details
https://claude.ai/code/session_01M4cbAY2rUoVD6LqXaHTXcg