Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
55bae6e
docs: document support for location-based filters
basit3407 Jun 24, 2025
59f889c
fix: correct response schema for:
basit3407 Jun 24, 2025
cae8f61
fix(docs): correct response schema for
basit3407 Jun 24, 2025
07658bc
fix: correct tafsir typos
basit3407 Jun 24, 2025
b5acdb5
Fix Mushaf typo in content API docs
basit3407 Jun 24, 2025
ef9a858
regenerated api docs after fixing "Mushaf" typos
basit3407 Jun 25, 2025
c973ce2
Merge pull request #12 from basit3407/codex/check-v4.json-for-typos
basit3407 Jun 25, 2025
e957e7e
Merge pull request #13 from basit3407/codex/fix-typo--muhsaf--to--mus…
basit3407 Jun 25, 2025
e938b9c
Replace unrendered model placeholders
basit3407 Jun 25, 2025
048c6ef
Regenerated api docs after fixing model names
basit3407 Jun 25, 2025
6948ec3
Merge pull request #14 from basit3407/codex/count-unrendered-model-pl…
basit3407 Jun 25, 2025
72d1972
Replace placeholder endpoints in v4.json
basit3407 Jun 25, 2025
f00a7af
regenerated api docs after replacing endpoint
basit3407 Jun 25, 2025
f76b799
Merge pull request #15 from basit3407/codex/locate-and-count-endpoint…
basit3407 Jun 25, 2025
0969369
Merge branch 'quran:main' into main
basit3407 Jun 25, 2025
7fef2a6
docs: document mushafId param
basit3407 Jun 26, 2025
4ca124e
Regenerated the docs after the fix
basit3407 Jun 26, 2025
c498c43
Merge pull request #16 from basit3407/codex/update-docs-for-mushafid-…
basit3407 Jun 26, 2025
4dc69d5
Add field reference page and link in API spec
basit3407 Jun 27, 2025
30c9667
Regenerated api docs
basit3407 Jun 27, 2025
3457d65
Fix unicode escapes in field reference
basit3407 Jun 27, 2025
08305e0
Clarify qpc_uthmani_hafs description
basit3407 Jun 27, 2025
2c46663
Merge pull request #17 from basit3407/codex/locate-documentation-for-…
basit3407 Jun 27, 2025
8c804ac
docs: link resource references
basit3407 Jun 27, 2025
f532152
regenerated api docs
basit3407 Jun 27, 2025
2416d29
Merge pull request #18 from basit3407/codex/list-endpoints-referencin…
basit3407 Jun 27, 2025
25f0988
Revert "Merge pull request #16 from basit3407/codex/update-docs-for-m…
basit3407 Jul 1, 2025
e2533d6
Add SDK documentation
basit3407 Jul 3, 2025
049861f
Update SDK docs
basit3407 Jul 3, 2025
66e1279
Merge pull request #19 from basit3407/codex/generate-new-api-document…
basit3407 Jul 3, 2025
70bbc81
Merge branch 'quran:main' into main
basit3407 Jul 3, 2025
8fb8ef6
Merge branch 'quran:main' into main
basit3407 Jul 20, 2025
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
regenerated api docs after replacing endpoint
tokens with actual endpoints
  • Loading branch information
basit3407 committed Jun 25, 2025
commit f00a7af7bf97cba92764ff8b4db9f282e1967237

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/4.0.0/list-juz-recitation.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/4.0.0/list-surah-tafsirs.api.mdx

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/content_apis_versioned/4.0.0/search.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "search"
sidebar_label: "search"
hide_title: true
hide_table_of_contents: true
api: {"tags":["Search"],"operationId":"search","parameters":[{"name":"q","in":"query","description":"Search query, you can use *query* as well","schema":{"type":"string"}},{"name":"size","in":"query","description":"Results per page. *s* is also valid parameter.","schema":{"type":"number","default":20}},{"name":"page","in":"query","description":"Page number, well for pagination. You can use *p* as well","schema":{"type":"number","default":0}},{"name":"language","in":"query","description":"ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see #endpoint:8rjMCZEyPEZMHAKz9 endpoint.","schema":{"type":"string","default":"en"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"description":"search","method":"get","path":"/search","servers":[{"url":"https://apis-prelive.quran.foundation/content/api/v4","description":"Pre-production Server"},{"url":"https://apis.quran.foundation/content/api/v4","description":"Production Server"}],"security":[{"x-auth-token":[],"x-client-id":[]}],"securitySchemes":{"x-auth-token":{"type":"apiKey","description":"The JWT access token required for accessing the endpoints.","name":"x-auth-token","in":"header"},"x-client-id":{"type":"apiKey","description":"Your client Id","name":"x-client-id","in":"header"}},"info":{"title":"Content APIs","description":"Quran.Foundation Content APIs offer programmatic access to the Quran's core content like chapters, verses, recitations, translations, and more, distinct from user-specific data like notes and bookmarks provided by [User-related APIs](/docs/category/user-related-apis).\n\n ## How to get access \n\n We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to [get an access token](/docs/tutorials/oidc/getting-started-with-oauth2#obtaining-oauth-20-client-credentials) to make requests to our APIs. Since the APIs are not user-related, you will need to use the `client_credentials` grant type and [`content` scope](/docs/user_related_apis_versioned/scopes#content) when sending a request to [The OAuth 2.0 Token Endpoint](/docs/oauth2_apis_versioned/oauth-2-token-exchange) to get the access token. The below diagram shows the flow of getting an access token using the `client_credentials` grant type in a very simplified way.\n\n ![Client Credentials Flow](/img/client-credentials-flow.png) After getting a valid access token, each request to get resources will have to include 2 headers mentioned below: `x-auth-token` and `x-client-id`.","version":"v4"},"postman":{"name":"search","description":{"type":"text/plain"},"url":{"path":["search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Search query, you can use *query* as well","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Results per page. *s* is also valid parameter.","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"Page number, well for pagination. You can use *p* as well","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see #endpoint:8rjMCZEyPEZMHAKz9 endpoint.","type":"text/plain"},"key":"language","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
api: {"tags":["Search"],"operationId":"search","parameters":[{"name":"q","in":"query","description":"Search query, you can use *query* as well","schema":{"type":"string"}},{"name":"size","in":"query","description":"Results per page. *s* is also valid parameter.","schema":{"type":"number","default":20}},{"name":"page","in":"query","description":"Page number, well for pagination. You can use *p* as well","schema":{"type":"number","default":0}},{"name":"language","in":"query","description":"ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see /resources/languages endpoint.","schema":{"type":"string","default":"en"}}],"responses":{"default":{"description":"","content":{"application/json":{"schema":{"type":"object"}}}}},"description":"search","method":"get","path":"/search","servers":[{"url":"https://apis-prelive.quran.foundation/content/api/v4","description":"Pre-production Server"},{"url":"https://apis.quran.foundation/content/api/v4","description":"Production Server"}],"security":[{"x-auth-token":[],"x-client-id":[]}],"securitySchemes":{"x-auth-token":{"type":"apiKey","description":"The JWT access token required for accessing the endpoints.","name":"x-auth-token","in":"header"},"x-client-id":{"type":"apiKey","description":"Your client Id","name":"x-client-id","in":"header"}},"info":{"title":"Content APIs","description":"Quran.Foundation Content APIs offer programmatic access to the Quran's core content like chapters, verses, recitations, translations, and more, distinct from user-specific data like notes and bookmarks provided by [User-related APIs](/docs/category/user-related-apis).\n\n ## How to get access \n\n We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to [get an access token](/docs/tutorials/oidc/getting-started-with-oauth2#obtaining-oauth-20-client-credentials) to make requests to our APIs. Since the APIs are not user-related, you will need to use the `client_credentials` grant type and [`content` scope](/docs/user_related_apis_versioned/scopes#content) when sending a request to [The OAuth 2.0 Token Endpoint](/docs/oauth2_apis_versioned/oauth-2-token-exchange) to get the access token. The below diagram shows the flow of getting an access token using the `client_credentials` grant type in a very simplified way.\n\n ![Client Credentials Flow](/img/client-credentials-flow.png) After getting a valid access token, each request to get resources will have to include 2 headers mentioned below: `x-auth-token` and `x-client-id`.","version":"v4"},"postman":{"name":"search","description":{"type":"text/plain"},"url":{"path":["search"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Search query, you can use *query* as well","type":"text/plain"},"key":"q","value":""},{"disabled":false,"description":{"content":"Results per page. *s* is also valid parameter.","type":"text/plain"},"key":"size","value":""},{"disabled":false,"description":{"content":"Page number, well for pagination. You can use *p* as well","type":"text/plain"},"key":"page","value":""},{"disabled":false,"description":{"content":"ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see /resources/languages endpoint.","type":"text/plain"},"key":"language","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
Expand All @@ -26,7 +26,7 @@ import TabItem from "@theme/TabItem";

search

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"q","in":"query","description":"Search query, you can use *query* as well","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"size","in":"query","description":"Results per page. *s* is also valid parameter.","schema":{"type":"number","default":20}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"page","in":"query","description":"Page number, well for pagination. You can use *p* as well","schema":{"type":"number","default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"language","in":"query","description":"ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see #endpoint:8rjMCZEyPEZMHAKz9 endpoint.","schema":{"type":"string","default":"en"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"default"} value={"default"}><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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>
<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"q","in":"query","description":"Search query, you can use *query* as well","schema":{"type":"string"}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"size","in":"query","description":"Results per page. *s* is also valid parameter.","schema":{"type":"number","default":20}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"page","in":"query","description":"Page number, well for pagination. You can use *p* as well","schema":{"type":"number","default":0}}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"language","in":"query","description":"ISO code of language, use this query params if you want to boost translations for specific language. \nFor list of available language see /resources/languages endpoint.","schema":{"type":"string","default":"en"}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"default"} value={"default"}><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"}}><div style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}>

object

Expand Down
Loading