Commit 9ff52da
authored
📚 Sync docs: Fix Tafsir endpoint schema & document random verse filters & other updates (#10)
* 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 endpoints1 parent a3f6897 commit 9ff52da
121 files changed
Lines changed: 508 additions & 403 deletions
File tree
- docs
- content_apis_versioned
- 4.0.0
- openAPI/content
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.
Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
8 | | - | |
| 8 | + | |
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| |||
Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.
Lines changed: 6 additions & 2 deletions
Large diffs are not rendered by default.
Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.
Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.
Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.
0 commit comments