Document Juz, Ruku, Hizb, Rubʿ al-Ḥizb, Manzil, and Footnote endpoints#29
Merged
osamasayed merged 3 commits intomainfrom Nov 1, 2025
Merged
Document Juz, Ruku, Hizb, Rubʿ al-Ḥizb, Manzil, and Footnote endpoints#29osamasayed merged 3 commits intomainfrom
osamasayed merged 3 commits intomainfrom
Conversation
Footnote endpoints * add list/get operations for juz, hizb, rubʿ al-ḥizb, manzil, and footnote routes to v4 OpenAPI * define shared schemas for each resource and wire them into 200 responses with concrete examples * document the optional mushaf selector and standardize error references for the new endpoints
* add /rukus and /rukus/{id} operations with full response shape, path params, and shared error references
* define a reusable ruku schema mirroring the Rails serializer and reuse it across both responses
basit3407
changed the title
Deploying qf-api-docs with
|
| Latest commit: |
9f09544
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://21a34ed5.qf-api-docs.pages.dev |
| Branch Preview URL: | https://document-metadata-endpoints.qf-api-docs.pages.dev |
osamasayed
approved these changes
Nov 1, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.