[codex] Clarify recitation and chapter-reciter IDs in v4 docs#122
Merged
[codex] Clarify recitation and chapter-reciter IDs in v4 docs#122
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
4a38dfc
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5186f925.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-clarify-recitation-and.qf-api-docs.pages.dev |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies the distinction between ayah-by-ayah recitation_id and chapter-reciter reciter_id throughout the v4 OpenAPI spec and generated docs, so API consumers use the correct ID family for each endpoint (reducing “Recitation not found” confusion).
Changes:
- Updated v4 OpenAPI descriptions to explicitly state which endpoints accept ayah-by-ayah recitation IDs vs chapter-reciter IDs (including verse
audioquery params and/audio/reciters/...endpoints). - Regenerated/updated the affected MDX API docs so the same guidance appears consistently in the published documentation.
- Added explicit “not interchangeable / not supported” wording where consumers are likely to mix the ID families.
Reviewed changes
Copilot reviewed 16 out of 57 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| openAPI/content/v4.json | Source-of-truth OpenAPI text updated to clarify ID-family usage across endpoints/params. |
| docs/content_apis_versioned/recitations.api.mdx | Recitations “producer” doc now explicitly defines ayah-by-ayah recitation IDs and where they’re valid. |
| docs/content_apis_versioned/audio-reciter-timestamp.api.mdx | Docs for /audio/reciters/{reciter_id}/timestamp updated with chapter-reciter ID guidance (but has encoding artifacts to fix). |
| docs/content_apis_versioned/audio-reciter-lookup.api.mdx | Docs for /audio/reciters/{reciter_id}/lookup updated with chapter-reciter ID guidance (but has encoding artifacts to fix). |
| docs/content_apis_versioned/4.0.0/audio-reciter-timestamp.api.mdx | Versioned copy of timestamp doc updated (but has encoding artifacts to fix). |
| docs/content_apis_versioned/4.0.0/audio-reciter-lookup.api.mdx | Versioned copy of lookup doc updated (but has encoding artifacts to fix). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What changed
openAPI/content/v4.jsonthat ayah-by-ayahrecitation_idvalues come from/resources/recitationsreciter_idvalues come from/resources/chapter_recitersaudioquery param wording explicit that chapter-reciter IDs are not supported thereaudio/reciters/{reciter_id}/timestampand/lookupdocs with the same chapter-reciter ID guidanceWhy
External consumers could reasonably assume the two ID families were interchangeable. That led to valid chapter-reciter IDs being passed into ayah-recitation endpoints and returning
Recitation not found.Impact
Validation
yarn buildinC:\Code\qf-api-docsgit diff --check