Clarify v4 chapter info resource discovery#146
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Content API v4 OpenAPI documentation to clearly distinguish chapter-info resource discovery via include_resources=true (chapter-specific) from the /resources/chapter_infos endpoint (global catalog), aligning consumer expectations with backend behavior.
Changes:
- Revised
GET /chapters/{id}/infodescriptions to recommendinclude_resources=truefor chapter-specific chapter-info resource discovery. - Clarified that
/resources/chapter_infosis a global catalog and may list resources that yieldchapter_info: nullfor a given chapter. - Updated the
resourcesfield description to explicitly describe chapter-specific filtering.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Deploying qf-api-docs with
|
| Latest commit: |
a308b36
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://9919492d.qf-api-docs.pages.dev |
| Branch Preview URL: | https://basit-v4-chapter-info-discov.qf-api-docs.pages.dev |
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
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.
Summary
Clarifies the v4 chapter info docs so they no longer imply that
/resources/chapter_infosandinclude_resources=trueare equivalent discovery paths.What changed
GET /chapters/{id}/infowording to recommendinclude_resources=truefor chapter-specific resource discovery/resources/chapter_infosis a global catalog and may include resources that returnchapter_info: nullfor a specific surahresourcesresponse description to state that it is chapter-specificWhy
The backend currently treats
/resources/chapter_infosas a global resource catalog, whileinclude_resources=truereturns only resources that actually have chapter-info content for the resolved chapter and language. The docs should reflect that distinction clearly.