API Documentation Update #1
Conversation
I have no idea what is going on in line 2116 (https://api-docs.quran.com/docs/quran.com_versioned/translation). Very incoherent and the API request seems to fail no matter what I put into the required parameter
Basically done
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
openAPI/quran.com/v4.json
Outdated
| @@ -33,13 +33,13 @@ | |||
| "type": "number", | |||
| "minimum": 1, | |||
| "maximum": 114, | |||
| "description": "The number of the chapter" | |||
| "description": "The number of the chapter (surah)" | |||
There was a problem hiding this comment.
"Surah" and "Ayah" should be capitalized. This applies to all the changes so will leave just 1 comment for all.
There was a problem hiding this comment.
Semi-complete. I will triple check my work tomorrow
openAPI/quran.com/v4.json
Outdated
| "tags": [ | ||
| "Audio" | ||
| ], | ||
| "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Hizb.", | ||
| "description": "Get list of audio files for a verse (ayah) from a reciter, specified by their Reciter ID (see https://api-docs.quran.com/docs/quran.com_versioned/chapter-reciters)..", |
There was a problem hiding this comment.
There is an extra "." at the end.
openAPI/quran.com/v4.json
Outdated
| @@ -2113,12 +2113,12 @@ | |||
| "tags": [ | |||
| "Quran" | |||
| ], | |||
| "description": "Get a single #model:XCinMTfQdCrC3D3vH of all ayah.\n\nSee #endpoint:N4JAF8phDshhyrBHs endpoint to fetch available translations.\n\nYou can also include more fields of translation using `fields` query string.", | |||
| "description": "Get a single translation of the Qur'an\n\nUse https://api-docs.quran.com/docs/quran.com_versioned/translations to get the ID a desired translation", | |||
There was a problem hiding this comment.
Throughout the docs, we should use relative path and not full path and let Docusaurus resolve the link by itself which would be relative to the current directory for example, https://api-docs.quran.com/docs/quran.com_versioned/translations should be converted into [link](./translations) which would still be resolved to whatever directory and domain the current docs portal is one. This is more sustainable for the future.
Not done fixing, DO NOT MERGE PR
|
I made some fixes tonight, but IT IS NOT READY! PLEASE DON'T MERGE THE PR |
Made the API documentation for Quran.com more readable and easy to understand.