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

docs/content_apis_versioned/4.0.0/get-pages-lookup.api.mdx

@@ -0,0 +1,31 @@
+---
+id: get-pages-lookup
+title: "Lookup Pages"
+description: "Get page boundaries for a chapter, juz, page, or verse range in the selected mushaf."
+sidebar_label: "Lookup Pages"
+hide_title: true
+hide_table_of_contents: true
+api: {"operationId":"GET-pages-lookup","tags":["Pages"],"description":"Get page boundaries for a chapter, juz, page, or verse range in the selected mushaf.","parameters":[{"name":"mushaf","in":"query","description":"Optional mushaf id. Defaults to the system default mushaf.","schema":{"type":"integer"}},{"name":"chapter_number","in":"query","schema":{"type":"integer"}},{"name":"juz_number","in":"query","schema":{"type":"integer"}},{"name":"page_number","in":"query","schema":{"type":"integer"}},{"name":"manzil_number","in":"query","schema":{"type":"integer"}},{"name":"rub_el_hizb_number","in":"query","schema":{"type":"integer"}},{"name":"hizb_number","in":"query","schema":{"type":"integer"}},{"name":"ruku_number","in":"query","schema":{"type":"integer"}},{"name":"from","in":"query","description":"Starting verse key or verse id.","schema":{"type":"string"}},{"name":"to","in":"query","description":"Ending verse key or verse id.","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"total_page":{"type":"integer"},"lookup_range":{"type":"object","properties":{"from":{"type":"string"},"to":{"type":"string"}}},"pages":{"type":"object","additionalProperties":{"type":"object","properties":{"first_verse_key":{"type":"string"},"last_verse_key":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"}}}}}},"examples":{"response":{"value":{"total_page":2,"lookup_range":{"from":"47:1","to":"47:5"},"pages":{"507":{"first_verse_key":"47:1","last_verse_key":"47:3","from":"47:1","to":"47:3"},"508":{"first_verse_key":"47:4","last_verse_key":"47:5","from":"47:4","to":"47:5"}}}}}}}}},"method":"get","path":"/pages/lookup","servers":[{"url":"https://api.quran.com/api/v4"},{"url":"http://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"Lookup Pages","description":{"content":"Get page boundaries for a chapter, juz, page, or verse range in the selected mushaf.","type":"text/plain"},"url":{"path":["pages","lookup"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Optional mushaf id. Defaults to the system default mushaf.","type":"text/plain"},"key":"mushaf","value":""},{"disabled":false,"key":"chapter_number","value":""},{"disabled":false,"key":"juz_number","value":""},{"disabled":false,"key":"page_number","value":""},{"disabled":false,"key":"manzil_number","value":""},{"disabled":false,"key":"rub_el_hizb_number","value":""},{"disabled":false,"key":"hizb_number","value":""},{"disabled":false,"key":"ruku_number","value":""},{"disabled":false,"description":{"content":"Starting verse key or verse id.","type":"text/plain"},"key":"from","value":""},{"disabled":false,"description":{"content":"Ending verse key or verse id.","type":"text/plain"},"key":"to","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
+sidebar_class_name: "get api-method"
+info_path: docs/content_apis_versioned/4.0.0/content-apis
+custom_edit_url: null
+displayed_sidebar: apiVersionedSidebar
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import TabItem from "@theme/TabItem";
+
+## Lookup Pages
+
+
+
+Get page boundaries for a chapter, juz, page, or verse range in the selected mushaf.
+
+<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"mushaf","in":"query","description":"Optional mushaf id. Defaults to the system default mushaf.","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"chapter_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"juz_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"page_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"manzil_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"rub_el_hizb_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"hizb_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"ruku_number","in":"query","schema":{"type":"integer"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"from","in":"query","description":"Starting verse key or verse id.","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"to","in":"query","description":"Ending verse key or verse id.","schema":{"type":"string"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div></div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"total_page"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>lookup_range</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"from"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"to"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>pages</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>property name*</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"first_verse_key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"last_verse_key"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"from"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"to"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"total_page\": 0,\n  \"lookup_range\": {\n    \"from\": \"string\",\n    \"to\": \"string\"\n  },\n  \"pages\": {}\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"response"} value={"response"}><ResponseSamples responseExample={"{\n  \"total_page\": 2,\n  \"lookup_range\": {\n    \"from\": \"47:1\",\n    \"to\": \"47:5\"\n  },\n  \"pages\": {\n    \"507\": {\n      \"first_verse_key\": \"47:1\",\n      \"last_verse_key\": \"47:3\",\n      \"from\": \"47:1\",\n      \"to\": \"47:3\"\n    },\n    \"508\": {\n      \"first_verse_key\": \"47:4\",\n      \"last_verse_key\": \"47:5\",\n      \"from\": \"47:4\",\n      \"to\": \"47:5\"\n    }\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
+

docs/content_apis_versioned/4.0.0/get-pages-page-number.api.mdx

@@ -0,0 +1,31 @@
+---
+id: get-pages-page-number
+title: "Get Page"
+description: "Get metadata for a single page in the selected mushaf."
+sidebar_label: "Get Page"
+hide_title: true
+hide_table_of_contents: true
+api: {"operationId":"GET-pages-page_number","tags":["Pages"],"description":"Get metadata for a single page in the selected mushaf.","parameters":[{"name":"mushaf","in":"query","description":"Optional mushaf id. Defaults to the system default mushaf.","schema":{"type":"integer"}},{"name":"id","in":"path","description":"Page number in the selected mushaf.","required":true,"schema":{"type":"integer","minimum":1}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"page":{"type":"object","properties":{"id":{"type":"integer"},"page_number":{"type":"integer"},"verse_mapping":{"type":"object"},"first_verse_id":{"type":"integer"},"last_verse_id":{"type":"integer"},"verses_count":{"type":"integer"}}}}},"examples":{"response":{"value":{"page":{"id":1,"page_number":507,"verse_mapping":{"47:1":"47:3"},"first_verse_id":4787,"last_verse_id":4789,"verses_count":3}}}}}}}},"method":"get","path":"/pages/{id}","servers":[{"url":"https://api.quran.com/api/v4"},{"url":"http://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"Get Page","description":{"content":"Get metadata for a single page in the selected mushaf.","type":"text/plain"},"url":{"path":["pages",":id"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Optional mushaf id. Defaults to the system default mushaf.","type":"text/plain"},"key":"mushaf","value":""}],"variable":[{"disabled":false,"description":{"content":"(Required) Page number in the selected mushaf.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
+sidebar_class_name: "get api-method"
+info_path: docs/content_apis_versioned/4.0.0/content-apis
+custom_edit_url: null
+displayed_sidebar: apiVersionedSidebar
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import TabItem from "@theme/TabItem";
+
+## Get Page
+
+
+
+Get metadata for a single page in the selected mushaf.
+
+<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"id","in":"path","description":"Page number in the selected mushaf.","required":true,"schema":{"type":"integer","minimum":1}}}></ParamsItem></ul></div></details><details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"mushaf","in":"query","description":"Optional mushaf id. Defaults to the system default mushaf.","schema":{"type":"integer"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div></div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>page</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"page_number"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"verse_mapping"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object"}}></SchemaItem><SchemaItem collapsible={false} name={"first_verse_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"last_verse_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"verses_count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"page\": {\n    \"id\": 0,\n    \"page_number\": 0,\n    \"verse_mapping\": {},\n    \"first_verse_id\": 0,\n    \"last_verse_id\": 0,\n    \"verses_count\": 0\n  }\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"response"} value={"response"}><ResponseSamples responseExample={"{\n  \"page\": {\n    \"id\": 1,\n    \"page_number\": 507,\n    \"verse_mapping\": {\n      \"47:1\": \"47:3\"\n    },\n    \"first_verse_id\": 4787,\n    \"last_verse_id\": 4789,\n    \"verses_count\": 3\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
+

docs/content_apis_versioned/4.0.0/list-pages.api.mdx

@@ -0,0 +1,31 @@
+---
+id: list-pages
+title: "List Pages"
+description: "Get all pages for the selected mushaf."
+sidebar_label: "List Pages"
+hide_title: true
+hide_table_of_contents: true
+api: {"operationId":"LIST-pages","tags":["Pages"],"description":"Get all pages for the selected mushaf.","parameters":[{"name":"mushaf","in":"query","description":"Optional mushaf id. Defaults to the system default mushaf.","schema":{"type":"integer"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"pages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"page_number":{"type":"integer"},"verse_mapping":{"type":"object"},"first_verse_id":{"type":"integer"},"last_verse_id":{"type":"integer"},"verses_count":{"type":"integer"}}}}}},"examples":{"response":{"value":{"pages":[{"id":1,"page_number":507,"verse_mapping":{"47:1":"47:3"},"first_verse_id":4787,"last_verse_id":4789,"verses_count":3}]}}}}}}},"method":"get","path":"/pages","servers":[{"url":"https://api.quran.com/api/v4"},{"url":"http://api.quran.com/api/v4"}],"info":{"version":"v4","title":"Quran.com API","description":" Documentation of Quran.com v4 API"},"postman":{"name":"List Pages","description":{"content":"Get all pages for the selected mushaf.","type":"text/plain"},"url":{"path":["pages"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Optional mushaf id. Defaults to the system default mushaf.","type":"text/plain"},"key":"mushaf","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
+sidebar_class_name: "get api-method"
+info_path: docs/content_apis_versioned/4.0.0/content-apis
+custom_edit_url: null
+displayed_sidebar: apiVersionedSidebar
+---
+
+import ApiTabs from "@theme/ApiTabs";
+import MimeTabs from "@theme/MimeTabs";
+import ParamsItem from "@theme/ParamsItem";
+import ResponseSamples from "@theme/ResponseSamples";
+import SchemaItem from "@theme/SchemaItem";
+import SchemaTabs from "@theme/SchemaTabs";
+import DiscriminatorTabs from "@theme/DiscriminatorTabs";
+import TabItem from "@theme/TabItem";
+
+## List Pages
+
+
+
+Get all pages for the selected mushaf.
+
+<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"mushaf","in":"query","description":"Optional mushaf id. Defaults to the system default mushaf.","schema":{"type":"integer"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div></div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>pages</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"page_number"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"verse_mapping"} required={false} schemaName={"object"} qualifierMessage={undefined} schema={{"type":"object"}}></SchemaItem><SchemaItem collapsible={false} name={"first_verse_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"last_verse_id"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><SchemaItem collapsible={false} name={"verses_count"} required={false} schemaName={"integer"} qualifierMessage={undefined} schema={{"type":"integer"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"pages\": [\n    {\n      \"id\": 0,\n      \"page_number\": 0,\n      \"verse_mapping\": {},\n      \"first_verse_id\": 0,\n      \"last_verse_id\": 0,\n      \"verses_count\": 0\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"response"} value={"response"}><ResponseSamples responseExample={"{\n  \"pages\": [\n    {\n      \"id\": 1,\n      \"page_number\": 507,\n      \"verse_mapping\": {\n        \"47:1\": \"47:3\"\n      },\n      \"first_verse_id\": 4787,\n      \"last_verse_id\": 4789,\n      \"verses_count\": 3\n    }\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
+