docs: sync content v4 pages endpoints and fix page layout tutorial contract#91
Draft
docs: sync content v4 pages endpoints and fix page layout tutorial contract#91
Conversation
…-sync-and-page-layout-auth
Deploying qf-api-docs with
|
| 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 |
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
This replaces #78 now that the API exposes public
v4/pages*endpoints.It does two things:
/pages,/pages/lookup, and/pages/{id}docs/tutorials/fonts/page-layout.mdso its examples match the current publicv4contractWhat Changed
openAPI/content/v4.jsonfrom the API repo�s current contract/pages,/pages/lookup, and/pages/{id}in both latest and4.0.0verses/by_pagedocs to reflect the current mushaf-aware public contractpage-layout.mdto use:x-auth-tokenx-client-idfrom/tousage fromverses/by_pageexamplesPagesdocs are visible in both latest and4.0.0Files To Review
docs/tutorials/fonts/page-layout.mdopenAPI/content/v4.jsonsidebars.jsdocs/content_apis_versioned/verses-by-page-number.api.mdxdocs/content_apis_versioned/get-pages-lookup.api.mdxdocs/content_apis_versioned/get-pages-page-number.api.mdxdocs/content_apis_versioned/list-pages.api.mdxdocs/content_apis_versioned/4.0.0/verses-by-page-number.api.mdxdocs/content_apis_versioned/4.0.0/get-pages-lookup.api.mdxdocs/content_apis_versioned/4.0.0/get-pages-page-number.api.mdxdocs/content_apis_versioned/4.0.0/list-pages.api.mdxWhy 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
Authorization: Bearerfrom/toonverses/by_pageopenAPI/content/v4.jsonincludes:/pages/pages/lookup/pages/{id}Pagesdocs are wired into the Content API sidebar for latest and4.0.0yarn build; the repo�s Windows build path rerunsyarn gen-all, so I kept the committed diff scoped to the intended Content API docs changes only