Skip to content

Align chapter endpoint OpenAPI docs with actual responses #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
osamasayed merged 2 commits into from
Nov 1, 2025
Merged

Align chapter endpoint OpenAPI docs with actual responses #28

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
70ef3b9
Align chapter endpoint OpenAPI docs with actual
basit3407 Nov 1, 2025
ae61cd0
Merge branch 'main' into metadata_endpoints
basit3407 Nov 1, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Merge branch 'main' into metadata_endpoints
  • Loading branch information
@basit3407
basit3407 authored Nov 1, 2025
commit ae61cd022fcfe2cb97319a8dbbf6413d45f72a4a
82 changes: 81 additions & 1 deletion docs/content_apis_versioned/4.0.0/sidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,81 @@
module.exports = [{"type":"doc","id":"content_apis_versioned/4.0.0/content-apis"},{"type":"category","label":"Audio","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-reciter-audio-file","label":"Get chapter's audio file of a reciter","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-reciter-audio-files","label":"List of all chapter audio files of a reciter","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/recitations","label":"Recitations","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/recitation-audio-files","label":"Get list of Audio files of single recitation","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-reciters","label":"List of Chapter Reciters","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-surah-recitation","label":"Get Ayah recitations for specific Surah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-juz-recitation","label":"Get Ayah recitations for specific Juz","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-page-recitation","label":"Get Ayah recitations for specific Madani Mushaf page","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-rub-el-hizb-recitation","label":"Get Ayah recitations for specific Rub el Hizb","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-hizb-recitation","label":"Get Ayah recitations for specific Hizb","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-ayah-recitation","label":"Get Ayah recitations for specific Ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-manzil-recitation","label":"Get Ayah recitations for specific Manzil","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-ruku-recitation","label":"Get Ayah recitations for specific Ruku","className":"api-method get"}]},{"type":"category","label":"Chapters","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/list-chapters","label":"List Chapters","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/get-chapter","label":"Get Chapter","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/get-chapter-info","label":"Get Chapter Info","className":"api-method get"}]},{"type":"category","label":"Verses","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-chapter-number","label":"By Chapter","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-page-number","label":"By Page","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-juz-number","label":"By Juz","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-hizb-number","label":"By Hizb number","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-rub-el-hizb-number","label":"By Rub el Hizb number","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-verse-key","label":"By Specific Verse By Key","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/random-verse","label":"Get random ayah","className":"api-method get"}]},{"type":"category","label":"Juz","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/juzs","label":"Get All Juzs","className":"api-method get"}]},{"type":"category","label":"Quran","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-indopak","label":"Get Indopak Script of ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-uthmani-tajweed","label":"Get Uthmani Tajweed Script of ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-uthmani","label":"Get Uthmani Script of ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-uthmani-simple","label":"Get Uthmani simple script of ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-imlaei","label":"Get Imlaei Simple text of ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/translation","label":"Get a single translation","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/tafsir","label":"Get a single tafsir","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-code-v-1","label":"Get V1 Glyph codes of ayah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-code-v-2","label":"Get V2 Glyph codes of ayah","className":"api-method get"}]},{"type":"category","label":"Resources","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/recitation-info","label":"Recitation Info","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/translation-info","label":"Translation Info","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/translations","label":"Translations","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/tafsirs","label":"Tafsirs","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/tafsir-info","label":"Tafsir Info","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/recitation-styles","label":"Recitation Styles","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/languages","label":"Languages","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-info","label":"Chapter Infos","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/verse-media","label":"Verse Media","className":"api-method get"}]},{"type":"category","label":"Search","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/search","label":"Search verses and translations","className":"api-method get"}]},{"type":"category","label":"Translations","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/list-surah-translations","label":"Get translations for specific Surah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-page-translations","label":"Get translations for specific Madani Mushaf page","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-juz-translations","label":"Get translations for specific Juz","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-rub-el-hizb-translations","label":"Get translations for specific Rub el Hizb","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-hizb-translations","label":"Get translations for specific Hizb","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-manzil-translations","label":"Get translations for specific Manzil","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-ruku-translations","label":"Get translations for specific Ruku","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-ayah-translations","label":"Get translations for specific Ayah","className":"api-method get"}]},{"type":"category","label":"Tafsirs","items":[{"type":"doc","id":"content_apis_versioned/4.0.0/list-surah-tafsirs","label":"Get tafsirs for specific Surah","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-page-tafsirs","label":"Get tafsirs for specific Madani Mushaf page","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-juz-tafsirs","label":"Get tafsirs for specific Juz","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-rub-el-hizb-tafsirs","label":"Get tafsirs for specific Rub el Hizb","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-hizb-tafsirs","label":"Get tafsirs for specific Hizb","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-manzil-tafsirs","label":"Get tafsirs for specific Manzil","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-ruku-tafsirs","label":"Get tafsirs for specific Ruku","className":"api-method get"},{"type":"doc","id":"content_apis_versioned/4.0.0/list-ayah-tafsirs","label":"Get tafsirs for specific Ayah","className":"api-method get"}]}];
module.exports = [
{"type":"doc","id":"content_apis_versioned/4.0.0/content-apis"},
{"type":"category","label":"Audio","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-reciter-audio-file","label":"Get chapter's audio file of a reciter","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-reciter-audio-files","label":"List of all chapter audio files of a reciter","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/recitations","label":"Recitations","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/recitation-audio-files","label":"Get list of Audio files of single recitation","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-reciters","label":"List of Chapter Reciters","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-surah-recitation","label":"Get Ayah recitations for specific Surah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-juz-recitation","label":"Get Ayah recitations for specific Juz","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-page-recitation","label":"Get Ayah recitations for specific Madani Mushaf page","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-rub-el-hizb-recitation","label":"Get Ayah recitations for specific Rub el Hizb","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-hizb-recitation","label":"Get Ayah recitations for specific Hizb","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-ayah-recitation","label":"Get Ayah recitations for specific Ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-manzil-recitation","label":"Get Ayah recitations for specific Manzil","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-ruku-recitation","label":"Get Ayah recitations for specific Ruku","className":"api-method get"}
]},
{"type":"category","label":"Chapters","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/list-chapters","label":"List Chapters","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/get-chapter","label":"Get Chapter","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/get-chapter-info","label":"Get Chapter Info","className":"api-method get"}
]},
{"type":"category","label":"Verses","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-chapter-number","label":"By Chapter","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-page-number","label":"By Page","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-juz-number","label":"By Juz","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-hizb-number","label":"By Hizb number","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-rub-el-hizb-number","label":"By Rub el Hizb number","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-ruku-number","label":"By Ruku","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verses-by-verse-key","label":"By Specific Verse By Key","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/random-verse","label":"Get random ayah","className":"api-method get"}
]},
{"type":"category","label":"Juz","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/juzs","label":"Get All Juzs","className":"api-method get"}
]},
{"type":"category","label":"Quran","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-indopak","label":"Get Indopak Script of ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-uthmani-tajweed","label":"Get Uthmani Tajweed Script of ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-uthmani","label":"Get Uthmani Script of ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-uthmani-simple","label":"Get Uthmani simple script of ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-imlaei","label":"Get Imlaei Simple text of ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/translation","label":"Get a single translation","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/tafsir","label":"Get a single tafsir","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-code-v-1","label":"Get V1 Glyph codes of ayah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/quran-verses-code-v-2","label":"Get V2 Glyph codes of ayah","className":"api-method get"}
]},
{"type":"category","label":"Resources","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/recitation-info","label":"Recitation Info","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/translation-info","label":"Translation Info","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/translations","label":"Translations","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/tafsirs","label":"Tafsirs","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/tafsir-info","label":"Tafsir Info","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/recitation-styles","label":"Recitation Styles","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/languages","label":"Languages","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/chapter-info","label":"Chapter Infos","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/verse-media","label":"Verse Media","className":"api-method get"}
]},
{"type":"category","label":"Search","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/search","label":"Search verses and translations","className":"api-method get"}
]},
{"type":"category","label":"Translations","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/list-surah-translations","label":"Get translations for specific Surah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-page-translations","label":"Get translations for specific Madani Mushaf page","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-juz-translations","label":"Get translations for specific Juz","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-rub-el-hizb-translations","label":"Get translations for specific Rub el Hizb","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-hizb-translations","label":"Get translations for specific Hizb","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-manzil-translations","label":"Get translations for specific Manzil","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-ruku-translations","label":"Get translations for specific Ruku","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-ayah-translations","label":"Get translations for specific Ayah","className":"api-method get"}
]},
{"type":"category","label":"Tafsirs","items":[
{"type":"doc","id":"content_apis_versioned/4.0.0/list-surah-tafsirs","label":"Get tafsirs for specific Surah","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-page-tafsirs","label":"Get tafsirs for specific Madani Mushaf page","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-juz-tafsirs","label":"Get tafsirs for specific Juz","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-rub-el-hizb-tafsirs","label":"Get tafsirs for specific Rub el Hizb","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-hizb-tafsirs","label":"Get tafsirs for specific Hizb","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-manzil-tafsirs","label":"Get tafsirs for specific Manzil","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-ruku-tafsirs","label":"Get tafsirs for specific Ruku","className":"api-method get"},
{"type":"doc","id":"content_apis_versioned/4.0.0/list-ayah-tafsirs","label":"Get tafsirs for specific Ayah","className":"api-method get"}
]}
];
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.