[codex] Document public v4 hadith reference endpoints#117
Conversation
Deploying qf-api-docs with
|
| Latest commit: |
a247d55
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://84c16916.qf-api-docs.pages.dev |
| Branch Preview URL: | https://codex-v4-hadith-public-parit.qf-api-docs.pages.dev |
![chatgpt-codex-connector[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 285370f650
ℹ️ 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".
There was a problem hiding this comment.
Pull request overview
Updates the Content API v4 OpenAPI spec and generated Docusaurus pages to document new public v4 hadith reference endpoints, including schemas/examples that align with the QDC-shaped response contract.
Changes:
- Added 3 new Hadith endpoints to
openAPI/content/v4.json(by_ayah,by_ayah/hadiths,count_within_range). - Introduced hadith-focused component schemas (reference records, hadith payloads, count map, and QDC-style error body).
- Added generated
.api.mdxendpoint pages in both the unversioned and4.0.0versioned doc paths.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| openAPI/content/v4.json | Adds new Hadith paths plus supporting schemas/examples. |
| docs/content_apis_versioned/hadiths-by-ayah.api.mdx | Generated docs page for GET /hadith_references/by_ayah/{ayah_key}/hadiths. |
| docs/content_apis_versioned/hadith-references-by-ayah.api.mdx | Generated docs page for GET /hadith_references/by_ayah/{ayah_key}. |
| docs/content_apis_versioned/hadith-count-within-range.api.mdx | Generated docs page for GET /hadith_references/count_within_range. |
| docs/content_apis_versioned/4.0.0/hadiths-by-ayah.api.mdx | Versioned generated docs page for hadiths-by-ayah. |
| docs/content_apis_versioned/4.0.0/hadith-references-by-ayah.api.mdx | Versioned generated docs page for hadith-references-by-ayah. |
| docs/content_apis_versioned/4.0.0/hadith-count-within-range.api.mdx | Versioned generated docs page for hadith-count-within-range. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0c6716217b
ℹ️ 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".
|
@codex review |
|
Codex Review: Didn't find any major issues. Chef's kiss. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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". |
Summary
Why
The API change adds public v4 hadith reference endpoints, so the content API docs need matching path definitions and generated endpoint pages.
Impact
GET /hadith_references/by_ayah/{ayah_key}GET /hadith_references/by_ayah/{ayah_key}/hadithsGET /hadith_references/count_within_rangedocs/content_apis_versioned/anddocs/content_apis_versioned/4.0.0/Validation
node -e "JSON.parse(require('fs').readFileSync('openAPI/content/v4.json','utf8')); console.log('openapi json ok')"yarn builddocs/content_apis_versioned/posts-controller-feed.api.mdx