Skip to content

Commit 9ca75f1

Browse files
authored
📘 Docs: Add auto-translate warning + OpenAPI fixes for audio endpoints (document segments=true; correct List Surah Recitation schema) (#13)
* docs: document support for location-based filters in random verse endpoint Added missing documentation for existing query parameters supported by the random verse endpoint: - chapter_number - page_number - juz_number - hizb_number - rub_el_hizb_number - ruku_number - manzil_number These parameters were already supported in the API but not reflected in the documentation. This update ensures developers are aware of all available filtering options when using the endpoint. * fix: correct response schema for: /tafsirs/{resource_id}/by_ayah/{ayah_key} Fixed the incorrect response schema shown for the /tafsirs/{resource_id}/by_ayah/{ayah_key} endpoint in the docs. The autogenerated version via <ApiTabs> was causing runtime crashes due to unresolved OpenAPI store references. Since that approach wasn't working despite correct infoPath and operationId setup, we manually wrote the MDX documentation using standard Docusaurus components. Tested locally – page now renders successfully and reflects the accurate response structure. * fix(docs): correct response schema for list-ayah-tafsirs and regenerate MDX Updated the OpenAPI schema (v4.json) for the /tafsirs/{resource_id}/by_ayah/{ayah_key} endpoint to ensure the response structure reflects the actual API output. The previous crash with <ApiTabs> was due to incorrect or incomplete schema context. After fixing the schema, we ran: - yarn clean-all - yarn gen-all - yarn start The generated docs now render correctly and reflect the accurate response, eliminating the need for manual overrides. * fix: correct tafsir typos * Fix Mushaf typo in content API docs * regenerated api docs after fixing "Mushaf" typos * Replace unrendered model placeholders * Regenerated api docs after fixing model names * Replace placeholder endpoints in v4.json * regenerated api docs after replacing endpoint tokens with actual endpoints * docs: document mushafId param * Regenerated the docs after the fix * Add field reference page and link in API spec * Regenerated api docs * Fix unicode escapes in field reference * Clarify qpc_uthmani_hafs description * docs: link resource references * regenerated api docs * Revert "Merge pull request #16 from basit3407/codex/update-docs-for-mushafid-in-get-todays-plan-api" This reverts commit c498c43, reversing changes made to 0969369. * Add SDK documentation * Update SDK docs * Revert "Merge pull request #19 from basit3407/codex/generate-new-api-documentation-for-docusaurus" This reverts commit 66e1279, reversing changes made to 25f0988. * Add translation integrity admonition via JSON * regenerated api docs * docs(openapi): document segments=true for Chapter Reciter Audio File in v4.json (param, schema, and examples) * regenerated api docs * docs(openapi): fix List Surah Recitation response (remove segments/timestamps; correct schema & examples) * regenerated api docs * update api docs
1 parent dba5975 commit 9ca75f1

File tree

167 files changed

+589
-292
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

167 files changed

+589
-292
lines changed

‎docs/content_apis_versioned/4.0.0/chapter-info.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/chapter-reciter-audio-file.api.mdx‎

Lines changed: 9 additions & 5 deletions

‎docs/content_apis_versioned/4.0.0/chapter-reciter-audio-files.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/chapter-reciters.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/content-apis.info.mdx‎

Lines changed: 5 additions & 0 deletions

‎docs/content_apis_versioned/4.0.0/get-chapter.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/info.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/juzs.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/languages.api.mdx‎

Lines changed: 1 addition & 1 deletion

‎docs/content_apis_versioned/4.0.0/list-ayah-recitation.api.mdx‎

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)