Skip to content

docs(content): document reciter_id, beta and audio file duration - #255

Merged
basit3407 merged 1 commit into
mainfrom
docs/v4-reciter-id-beta-duration
Nov 12, 2026
Merged

basit3407 merged 1 commit into
mainfrom
docs/v4-reciter-id-beta-duration

Conversation

@basit3407

Copy link
Copy Markdown
Collaborator

Why

quran/quran.com-api#1029 added three fields to Content API v4 that partners moving off /qdc were missing. It is deployed to production. I verified the fields there with cache-busted requests: all three match /qdc for every production reciter and audio file I compared.

Changes

openAPI/content/v4.json:

  • chapter-reciters schema:
    • id: clarified that this is the chapter-reciter ID used by /chapter_recitations/{reciter_id}.
    • New reciter_id (integer, nullable): the person reciting. Several chapter reciters can share one.
    • New beta (boolean).
  • chapter-recitation and AudioFile schemas: new duration (integer, milliseconds, nullable).
  • Examples use real production values: Abu Bakr al-Shatri is chapter reciter 4 with reciter_id 3, and file 457 has duration 53000.

Generated pages: regenerated only the three affected operations (chapter-reciters, chapter-reciter-audio-files, chapter-reciter-audio-file) in both docs/content_apis_versioned/ and 4.0.0/. Their 403 text also changes, because these pages were stale against the spec's current 403 description.

contract:openapi:check passes.

🤖 Generated with Claude Code

quran.com-api #1029 (deployed to production) adds:

- /resources/chapter_reciters: reciter_id and beta
- /chapter_recitations/{reciter_id} and /{chapter_number}: duration (ms)

Regenerate the three affected API pages. The 403 text in those pages
also changes because they had not been regenerated since the spec's
403 description was updated.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-12T03:05:06.846266Z b77d400 Manual request
🔒 Security Review ✅ Completed 2026-11-12T02:59:23.290312Z b77d400 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Repo admins can enable using credits for code reviews in their settings.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: b77d400
Status: ✅  Deploy successful!
Preview URL: https://75e7b7f4.qf-api-docs.pages.dev
Branch Preview URL: https://docs-v4-reciter-id-beta-dura.qf-api-docs.pages.dev

View logs

@basit3407

Copy link
Copy Markdown
Collaborator Author

@codex review

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: b77d40012f

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@basit3407
basit3407 merged commit 2837c1a into main Nov 12, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant