|
728 | 728 | "Chapters" |
729 | 729 | ], |
730 | 730 | "summary": "Get Chapter Info", |
731 | | - "description": "Get Chapter Info in specific language. Default to `English`. Supports selecting a specific resource via `resource_id` and listing available resources via `include_resources=true`. Use this to fetch author-specific surah info, such as Ibn Ashur, after discovering the resource id or slug from [`/resources/chapter_infos`](/docs/content_apis_versioned/chapter-info) or from `include_resources=true`.", |
| 731 | + "description": "Get Chapter Info in specific language. Default to `English`. Supports selecting a specific resource via `resource_id` and listing available resources via `include_resources=true`. Use `include_resources=true` to discover the resource ids or slugs that actually have chapter-info content for the resolved chapter and language. The [`/resources/chapter_infos`](/docs/content_apis_versioned/chapter-info) endpoint is a global catalog of chapter-info resources and may include resources that return `chapter_info: null` for a specific chapter.", |
732 | 732 | "operationId": "get-chapter-info", |
733 | 733 | "parameters": [ |
734 | 734 | { |
|
765 | 765 | "schema": { |
766 | 766 | "type": "string" |
767 | 767 | }, |
768 | | - "description": "Resource id or slug of the chapter info resource to fetch. Use this to request a specific author, such as Ibn Ashur, after discovering the identifier from [`/resources/chapter_infos`](/docs/content_apis_versioned/chapter-info) or from `include_resources=true`." |
| 768 | + "description": "Resource id or slug of the chapter info resource to fetch. Prefer identifiers returned by `include_resources=true` for the current chapter. The [`/resources/chapter_infos`](/docs/content_apis_versioned/chapter-info) endpoint is a global catalog and may include resources that do not have chapter-info content for this specific chapter, which would return `chapter_info: null`." |
769 | 769 | }, |
770 | 770 | { |
771 | 771 | "name": "include_resources", |
|
778 | 778 | "false" |
779 | 779 | ] |
780 | 780 | }, |
781 | | - "description": "Include the ordered list of available chapter info resources for the resolved language. This is useful for discovering the id or slug to pass as `resource_id` for a specific author such as Ibn Ashur." |
| 781 | + "description": "Include the ordered list of available chapter info resources that actually have content for the resolved chapter and language. This is the safest discovery path for the id or slug to pass as `resource_id` for a specific author such as Ibn Ashur." |
782 | 782 | } |
783 | 783 | ], |
784 | 784 | "responses": { |
|
796 | 796 | } |
797 | 797 | ], |
798 | 798 | "nullable": true, |
799 | | - "description": "Resolved chapter info resource. Returns `null` when the requested `resource_id` does not match an approved chapter info resource for the resolved language." |
| 799 | + "description": "Resolved chapter info resource. Returns `null` when the requested `resource_id` does not match an approved chapter info resource for the resolved chapter and language, or when the selected resource has no chapter-info content for that chapter after language resolution." |
800 | 800 | }, |
801 | 801 | "resources": { |
802 | | - "description": "Only returned when `include_resources=true`. Contains approved chapter info resources for the resolved language, ordered by the API's preferred resource order for selection.", |
| 802 | + "description": "Only returned when `include_resources=true`. Contains approved chapter info resources that have chapter-info content for the resolved chapter and language, ordered by the API's preferred resource order for selection.", |
803 | 803 | "type": "array", |
804 | 804 | "items": { |
805 | 805 | "$ref": "#/components/schemas/resource" |
|
9829 | 9829 | "Resources" |
9830 | 9830 | ], |
9831 | 9831 | "summary": "Chapter Infos", |
9832 | | - "description": "Get list of chapter info we've in different languages.", |
| 9832 | + "description": "Get the global catalog of chapter info resources in different languages. This endpoint lists resource definitions and is not filtered by chapter, so some returned ids may not have chapter-info content for a specific surah.", |
9833 | 9833 | "operationId": "chapter-info", |
9834 | 9834 | "responses": { |
9835 | 9835 | "200": { |
|
0 commit comments