Skip to content

Align chapter endpoint OpenAPI docs with actual responses#28

Merged
osamasayed merged 2 commits intomainfrom
metadata_endpoints
Nov 1, 2025
Merged

Align chapter endpoint OpenAPI docs with actual responses#28
osamasayed merged 2 commits intomainfrom
metadata_endpoints

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

  • expand the chapter schema to list every field returned (incl. name_simple) and mark them required
  • update /chapters 200 response to reference the shared chapter schema for array items
  • correct /chapters/{id}/info path params, add optional locale, and require the full chapter-info payload shape
responses

* expand the chapter schema to list every field returned (incl. name_simple) and mark them required
* update /chapters 200 response to reference the shared chapter schema for array items
* correct /chapters/{id}/info path params, add optional locale, and require the full chapter-info payload shape
@basit3407 basit3407 requested a review from osamasayed November 1, 2025 05:22
@basit3407 basit3407 requested a review from osamasayed November 1, 2025 07:45
@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: ae61cd0
Status: ✅  Deploy successful!
Preview URL: https://a0c13daf.qf-api-docs.pages.dev
Branch Preview URL: https://metadata-endpoints.qf-api-docs.pages.dev

View logs

@osamasayed osamasayed merged commit 741ef0d into main Nov 1, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants