Skip to content

docs: sync content v4 pages endpoints and fix page layout tutorial contract#91

Draft
basit3407 wants to merge 2 commits intomainfrom
docs/content-v4-pages-sync-and-page-layout-auth
Draft

docs: sync content v4 pages endpoints and fix page layout tutorial contract#91
basit3407 wants to merge 2 commits intomainfrom
docs/content-v4-pages-sync-and-page-layout-auth

Conversation

@basit3407
Copy link
Copy Markdown
Collaborator

Summary

This replaces #78 now that the API exposes public v4/pages* endpoints.

It does two things:

  • syncs the public Content API contract and generated docs for /pages, /pages/lookup, and /pages/{id}
  • fixes docs/tutorials/fonts/page-layout.md so its examples match the current public v4 contract

What Changed

  • updated openAPI/content/v4.json from the API repo�s current contract
  • added public Content API docs for /pages, /pages/lookup, and /pages/{id} in both latest and 4.0.0
  • updated the existing verses/by_page docs to reflect the current mushaf-aware public contract
  • fixed page-layout.md to use:
    • x-auth-token
    • x-client-id
    • snake_case lookup response fields
  • removed undocumented from / to usage from verses/by_page examples
  • extended the Content API sidebar so the new Pages docs are visible in both latest and 4.0.0

Files To Review

  1. docs/tutorials/fonts/page-layout.md
  2. openAPI/content/v4.json
  3. sidebars.js
  4. docs/content_apis_versioned/verses-by-page-number.api.mdx
  5. docs/content_apis_versioned/get-pages-lookup.api.mdx
  6. docs/content_apis_versioned/get-pages-page-number.api.mdx
  7. docs/content_apis_versioned/list-pages.api.mdx
  8. docs/content_apis_versioned/4.0.0/verses-by-page-number.api.mdx
  9. docs/content_apis_versioned/4.0.0/get-pages-lookup.api.mdx
  10. docs/content_apis_versioned/4.0.0/get-pages-page-number.api.mdx
  11. docs/content_apis_versioned/4.0.0/list-pages.api.mdx

Why This Change

PR #78 documented the pre-parity public state. Now that the API PR has added public v4/pages* endpoints, the docs should expose the actual contract instead of narrowing around the older gap.

Validation

  • checked the tutorial for:
    • no Authorization: Bearer
    • no camelCase lookup fields
    • no from / to on verses/by_page
  • verified openAPI/content/v4.json includes:
    • /pages
    • /pages/lookup
    • /pages/{id}
  • verified the new Pages docs are wired into the Content API sidebar for latest and 4.0.0
  • attempted yarn build; the repo�s Windows build path reruns yarn gen-all, so I kept the committed diff scoped to the intended Content API docs changes only
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Mar 31, 2026

Deploying qf-api-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 486ce75
Status: ✅  Deploy successful!
Preview URL: https://ce4c7f86.qf-api-docs.pages.dev
Branch Preview URL: https://docs-content-v4-pages-sync-a.qf-api-docs.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

1 participant