diff --git a/openAPI/quran.com/v4.json b/openAPI/quran.com/v4.json index 9665ea4..2ff7bed 100644 --- a/openAPI/quran.com/v4.json +++ b/openAPI/quran.com/v4.json @@ -22,7 +22,7 @@ { "name": "id", "in": "path", - "description": "The Id of the reciter", + "description": "The ID of the reciter, in numerical value", "required": true, "type": "number" }, @@ -33,13 +33,13 @@ "type": "number", "minimum": 1, "maximum": 114, - "description": "The number of the chapter" + "description": "The number of the chapter (Surah)" } ], "get": { "operationId": "chapter-reciter-audio-file", "summary": "Get chapter's audio file of a reciter", - "description": "Get chapter's audio file of a reciter ", + "description": "Get the audio file of a chapter (Surah) recited by a specific reciter, in MP3 format ", "responses": { "200": { "description": "", @@ -76,7 +76,7 @@ { "name": "id", "in": "path", - "description": "The Id of the reciter", + "description": "The ID of the reciter, in numerical value", "required": true, "type": "number" } @@ -87,7 +87,7 @@ "tags": [ "Audio" ], - "description": "Get list of chapters' audio files of a reciter", + "description": "Get a complete list of recitations by a reciter, per chapter (Surah)", "parameters": [ { "name": "language", @@ -146,7 +146,7 @@ "tags": [ "Chapters" ], - "description": "Get list of #model:aC7ed7aoTAZEKLCGF.", + "description": "Get a complete list of chapters (Surah) in the Qur'an, along with the place and order of revelation, the name in Arabic and transliteration of the name using Romanized characters, the amount of verses contained and the pages that it occupies", "parameters": [ { "name": "language", @@ -200,7 +200,7 @@ { "name": "id", "in": "path", - "description": "Chapter ID ( 1-114)", + "description": "Chapter (Surah) ID (1-114)", "required": true, "type": "integer", "minimum": 1, @@ -213,7 +213,7 @@ "tags": [ "Chapters" ], - "description": "Get details of a single #model:aC7ed7aoTAZEKLCGF.", + "description": "Get details of a single chapter (Surah) in the Qur'an, along with the place and order of revelation, the name in Arabic and transliteration of the name using Romanized characters, the amount of verses contained and the pages that it occupies", "parameters": [ { "name": "language", @@ -277,7 +277,7 @@ "tags": [ "Chapters" ], - "description": "Get #model:wc8vsnXdQpa7bpWa4 in specific language. Default to `English`.", + "description": "Get a description of a chapter (Surah) in the Qur'an, defaults to `English`", "parameters": [ { "name": "language", @@ -318,7 +318,7 @@ { "name": "chapter_number", "in": "path", - "description": "Chapter number ( 1 - 114 )", + "description": "Chapter number (1-114)", "required": true, "type": "integer", "minimum": 1, @@ -331,7 +331,7 @@ "tags": [ "Verses" ], - "description": "Get list of #model:J83wDRc48FrARPHBY(s) by Chapter / Surah number.", + "description": "Get list of information for a chapter (Surah), along with verse by verse information such as the Juz, Hizb and Rub el Hizb that the verse is contained within, as well as the key of the verse in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1)", "parameters": [ { "name": "language", @@ -343,7 +343,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -354,37 +354,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" }, { @@ -397,7 +397,7 @@ { "name": "per_page", "in": "query", - "description": "records per api call, you can get maximum 50 records. ", + "description": "Records per API call, you can get a maximum of 50 records. ", "type": "integer", "default": 10, "minimum": 1, @@ -487,7 +487,7 @@ { "name": "page_number", "in": "path", - "description": "Madani Mushaf page number. Valid range is 1-604 ", + "description": "Madani Mushaf page number (from pages 1 to 604). ", "required": true, "type": "integer", "minimum": 1, @@ -502,7 +502,7 @@ "tags": [ "Verses" ], - "description": "Get all verses of a specific Madani Mushaf page(1 to 604)", + "description": "Get all verses (Ayah) of a specific Madani Mushaf page (1 to 604)", "parameters": [ { "name": "language", @@ -514,7 +514,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -525,37 +525,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" }, { @@ -568,7 +568,7 @@ { "name": "per_page", "in": "query", - "description": "records per api call, you can get maximum 50 records. ", + "description": "Records per API call, you can get a maximum of 50 records. ", "type": "integer", "default": 10, "minimum": 1, @@ -670,7 +670,7 @@ "tags": [ "Verses" ], - "description": "Get all verses from a specific juz(1-30).", + "description": "Get all verses from a specific Juz of the Qur'an (1 to 30).", "parameters": [ { "name": "language", @@ -682,7 +682,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -693,37 +693,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" }, { @@ -736,7 +736,7 @@ { "name": "per_page", "in": "query", - "description": "records per api call, you can get maximum 50 records. ", + "description": "Records per API call, you can get a maximum of 50 records. ", "type": "integer", "default": 10, "minimum": 1, @@ -826,7 +826,7 @@ { "name": "hizb_number", "in": "path", - "description": "Hizb number(1-60)", + "description": "Hizb number (1-60)", "required": true, "type": "integer", "minimum": 1, @@ -839,7 +839,7 @@ "tags": [ "Verses" ], - "description": "Get all verses from a specific Hizb( half(1-60).", + "description": "Get all verses from a specific Hizb (One half of a Juz, from 1 to 60).", "parameters": [ { "name": "language", @@ -851,7 +851,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -862,37 +862,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" }, { @@ -905,7 +905,7 @@ { "name": "per_page", "in": "query", - "description": "records per api call, you can get maximum 50 records. ", + "description": "Records per API call, you can get a maximum of 50 records. ", "type": "integer", "default": 10, "minimum": 1, @@ -995,7 +995,7 @@ { "name": "rub_el_hizb_number", "in": "path", - "description": "Rub el Hizb number(1-240)", + "description": "Rub el Hizb number (1-240)", "required": true, "type": "integer", "minimum": 1, @@ -1008,7 +1008,7 @@ "tags": [ "Verses" ], - "description": "Get all verses of a specific Rub el Hizb number(1-240).", + "description": "Get all verses from a specific Rub el Hizb (One quarter of a Hizb, from 1 to 240).", "parameters": [ { "name": "language", @@ -1020,7 +1020,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -1031,37 +1031,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" } ], @@ -1159,7 +1159,7 @@ "tags": [ "Verses" ], - "description": "Get a specific ayah with key. Key is combination of surah number and ayah number. 1:1 is first ayah offirst surah for exampke.\n\n10:5 is 5th ayah of 10th surah.", + "description": "Get a specific verse (Ayah) by its key, in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1)", "parameters": [ { "name": "language", @@ -1171,7 +1171,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -1182,37 +1182,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" } ], @@ -1289,7 +1289,7 @@ "tags": [ "Verses" ], - "description": "Get a random verse. You can get random verse from a specific `chapter`,`page`, `juz`, `hizb`, `rub-el-hizb`, `ruku`, `manzil`, or from whole Quran.", + "description": "Get a random verse. You can get random verse from a specific `chapter`,`page`, `juz`, `hizb`, `rub-el-hizb`, `ruku`, `manzil`, or from whole Qur'an.", "parameters": [ { "name": "language", @@ -1301,7 +1301,7 @@ { "name": "words", "in": "query", - "description": "Include words of each ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", + "description": "Include words of each Ayah? \n\n0 or false will not include words.\n\n1 or true will include the words.", "type": "string", "default": true, "enum": [ @@ -1312,37 +1312,37 @@ { "name": "translations", "in": "query", - "description": "comma separated ids of translations to load for each ayah.", + "description": "IDs of translations to load for each verse (Ayah), separated by commas (`,`).", "type": "string" }, { "name": "audio", "in": "query", - "description": "Id of recitation if you want to load audio of each ayah.", + "description": "ID of recitation if you want to load audio of each verse (Ayah).", "type": "integer" }, { "name": "tafsirs", "in": "query", - "description": "Comma separated ids of tafisrs to load for each ayah if you want to load tafisrs.", + "description": "IDs of Tafsirs to load for each verse (Ayah) if you want to load tafisrs, separated by commas (`,`).", "type": "string" }, { "name": "word_fields", "in": "query", - "description": "Comma separated list of word fields if you want to add more fields for each word. ", + "description": "List of word fields if you want to add more fields for each word, separated by commas (`,`). ", "type": "string" }, { "name": "translation_fields", "in": "query", - "description": "Comma separated list of translation fields if you want to add more fields for each translation. ", + "description": "List of translation fields if you want to add more fields for each translation, separated by commas (`,`). ", "type": "string" }, { "name": "fields", "in": "query", - "description": "comma separated list of ayah fields.", + "description": "List of verse (Ayah) fields, separated by commas (`,`).", "type": "string" } ], @@ -1419,7 +1419,7 @@ "tags": [ "Juz" ], - "description": "Get list of all #model:XwogxNra8JdvchxBE", + "description": "Get list of all Juzs, mapped by the verses that occupy each Juz", "responses": { "default": { "description": "", @@ -1431,16 +1431,16 @@ "/quran/verses/indopak": { "get": { "operationId": "QURAN-verses-indopak", - "summary": "Get Indopak Script of ayah", + "summary": "Get Indopak Script of Ayah", "tags": [ "Quran" ], - "description": "Get Indopak script of ayah. Use query strings to filter results, leave all query string blank if you want to fetch Indopak script of whole Quran.", + "description": "Get Indopak script of Ayah. Use query strings to filter results, leave all query string blank if you want to fetch Indopak script of whole Quran.", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get indopak script of a specific surah.", + "description": "If you want to get indopak script of a specific Surah.", "type": "integer", "minimum": 1, "maximum": 114 @@ -1448,7 +1448,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get indopak script of a specific juz.", + "description": "If you want to get Indopak script of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -1456,7 +1456,7 @@ { "name": "page_number", "in": "query", - "description": "If you want to get indopak script of a Madani Muhsaf page", + "description": "If you want to get Indopak script of a Madani Muhsaf page", "type": "integer", "minimum": 1, "maximum": 604 @@ -1464,7 +1464,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get indopak script of a specific hizb.", + "description": "If you want to get Indopak script of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -1472,7 +1472,7 @@ { "name": "rub_el_hizb_number", "in": "query", - "description": "If you want to get indopak script of a specific Rub el Hizb.", + "description": "If you want to get Indopak script of a specific Rub el Hizb.", "type": "integer", "minimum": 1, "maximum": 240 @@ -1480,7 +1480,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get indopak script of a specific ayah.", + "description": "If you want to get Indopak script of a specific Ayah.", "type": "string" } ], @@ -1527,16 +1527,16 @@ "/quran/verses/uthmani_tajweed": { "get": { "operationId": "QURAN-verses-uthmani-tajweed", - "summary": "Get Uthmani Tajweed Script of ayah", + "summary": "Get Uthmani Tajweed Script of Ayah", "tags": [ "Quran" ], - "description": "Get Uthmani color coded tajweed text of ayah. Tajweed rules are embeded in text as `tajweed` html tags.", + "description": "Get Uthmani color coded tajweed text of Ayah. Tajweed rules are embeded in text as `tajweed` html tags.", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get text of a specific surah.", + "description": "If you want to get text of a specific Surah.", "type": "integer", "minimum": 1, "maximum": 114 @@ -1544,7 +1544,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get text of a specific juz.", + "description": "If you want to get text of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -1560,7 +1560,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get text of a specific hizb.", + "description": "If you want to get text of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -1576,7 +1576,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get text of a specific ayah.", + "description": "If you want to get text of a specific Ayah.", "type": "string" } ], @@ -1623,16 +1623,16 @@ "/quran/verses/uthmani": { "get": { "operationId": "QURAN-verses-uthmani", - "summary": "Get Uthmani Script of ayah", + "summary": "Get Uthmani Script of Ayah", "tags": [ "Quran" ], - "description": "Get Uthmani script of ayah. Use query strings to filter results, leave all query string blank if you want to fetch Uthmani script of whole Quran.", + "description": "Get Uthmani script of Ayah. Use query strings to filter results, leave all query string blank if you want to fetch Uthmani script of whole Quran.", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get Uthmani script of a specific surah.", + "description": "If you want to get Uthmani script of a specific Surah.", "type": "integer", "minimum": 1, "maximum": 114 @@ -1640,7 +1640,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get Uthmani script of a specific juz.", + "description": "If you want to get Uthmani script of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -1656,7 +1656,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get Uthmani script of a specific hizb.", + "description": "If you want to get Uthmani script of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -1672,7 +1672,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get Uthmani script of a specific ayah.", + "description": "If you want to get Uthmani script of a specific Ayah.", "type": "string" } ], @@ -1719,16 +1719,16 @@ "/quran/verses/uthmani_simple": { "get": { "operationId": "QURAN-verses-uthmani_simple", - "summary": "Get Uthmani simple script of ayah", + "summary": "Get Uthmani simple script of Ayah", "tags": [ "Quran" ], - "description": "Get Uthmani simple script(without tashkiq/diacritical marks) of ayah. Use query strings to filter results, leave all query string blank if you want to fetch script of whole Quran.", + "description": "Get Uthmani simple script(without tashkiq/diacritical marks) of Ayah. Use query strings to filter results, leave all query string blank if you want to fetch script of whole Quran.", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get Uthmani script of a specific surah.", + "description": "If you want to get Uthmani script of a specific Surah.", "type": "integer", "minimum": 1, "maximum": 114 @@ -1736,7 +1736,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get Uthmani script of a specific juz.", + "description": "If you want to get Uthmani script of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -1752,7 +1752,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get Uthmani script of a specific hizb.", + "description": "If you want to get Uthmani script of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -1768,7 +1768,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get Uthmani script of a specific ayah.", + "description": "If you want to get Uthmani script of a specific Ayah.", "type": "string" } ], @@ -1815,16 +1815,16 @@ "/quran/verses/imlaei": { "get": { "operationId": "QURAN-verses-Imlaei", - "summary": "Get Imlaei Simple text of ayah", + "summary": "Get Imlaei Simple text of Ayah", "tags": [ "Quran" ], - "description": "Get Imlaei simple script(without tashkiq/diacritical marks) of ayah.", + "description": "Get Imlaei simple script(without tashkiq/diacritical marks) of Ayah.", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get text of a specific surah.", + "description": "If you want to get text of a specific Surah.", "type": "integer", "minimum": 1, "maximum": 114 @@ -1832,7 +1832,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get text of a specific juz.", + "description": "If you want to get text of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -1848,7 +1848,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get text of a specific hizb.", + "description": "If you want to get text of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -1864,7 +1864,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get text of a specific ayah.", + "description": "If you want to get text of a specific Ayah.", "type": "string" } ], @@ -1949,7 +1949,7 @@ } }, "tags": [ - "Audio" + "Resources" ] } }, @@ -1965,19 +1965,19 @@ ], "get": { "operationId": "recitation-autio-files", - "summary": "Get list of Audio files of single recitation", - "description": "Get list of #model:knzdXGgyjYnAqbhGX for a single recitation. See #endpoint:HLbauN2sdGitPQPPL endpoint to fetch available recitations.\n\nYou can also include more fields of audio files using `fields` query string.", + "summary": "Get list of audio files of single recitation", + "description": "Get list of audio files for a single recitation, in MP3 format.", "parameters": [ { "name": "fields", "in": "query", - "description": "comma seperated field of audio files.", + "description": "Field of audio files, separated by commas (`,`).", "type": "string" }, { "name": "chapter_number", "in": "query", - "description": "If you want to get audio file of a specific surah.", + "description": "If you want to get audio file of a specific chapter (Surah).", "type": "integer", "minimum": 1, "maximum": 114 @@ -1985,7 +1985,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get audio file of a specific juz.", + "description": "If you want to get audio file of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -2001,7 +2001,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get audio file of a specific hizb.", + "description": "If you want to get audio file of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -2017,7 +2017,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get audio file of a specific ayah.", + "description": "If you want to get audio file of a specific verse (Ayah), in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1).", "type": "string" } ], @@ -2102,7 +2102,7 @@ { "name": "translation_id", "in": "path", - "description": "Recitation id", + "description": "The ID of the translation", "required": true, "type": "number" } @@ -2113,18 +2113,18 @@ "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\nLook [here](./translations) to get the ID of a desired translation", "parameters": [ { "name": "fields", "in": "query", - "description": "comma seperated fields of translation.", + "description": "List of translation fields, separated by commas (`,`).", "type": "string" }, { "name": "chapter_number", "in": "query", - "description": "If you want to get translation of a specific surah.", + "description": "If you want to get translation of a specific Surah.", "type": "integer", "minimum": 1, "maximum": 114 @@ -2132,7 +2132,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get translation of a specific juz.", + "description": "If you want to get translation of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -2148,7 +2148,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get translation of a specific hizb.", + "description": "If you want to get translation of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -2164,7 +2164,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get translation of a specific ayah.", + "description": "If you want to get translation of a specific verse (Ayah), in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1).", "type": "string" } ], @@ -2221,7 +2221,7 @@ "get": { "operationId": "chapter-reciters", "summary": "List of Chapter Reciters", - "description": "Get list of #model:Q4runBANeeCjwqfcT.", + "description": "Get list of Qur'an reciters and their Reciter IDs", "parameters": [ { "name": "language", @@ -2298,18 +2298,18 @@ "tags": [ "Quran" ], - "description": "Get a single #model:D7oy5DF6aGMhfLwDB of all ayah.\n\nSee #endpoint:5YnxJJGPMCLnM6PNE\nendpoint to fetch available tafsirs.\n\nYou can also include more fields of tafsir using `fields` query string.", + "description": "Get a single Tafsir\n\nLook [here](./tafsirs) to fetch available tafsirs.", "parameters": [ { "name": "fields", "in": "query", - "description": "comma seperated fields of tafsir.", + "description": "List of Tafsir fields, separated by commas (`,`).", "type": "string" }, { "name": "chapter_number", "in": "query", - "description": "If you want to get tafsir of a specific surah.", + "description": "If you want to get Tafsir of a specific chapter (Surah).", "type": "integer", "minimum": 1, "maximum": 114 @@ -2317,7 +2317,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get tafsir of a specific juz.", + "description": "If you want to get Tafsir of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -2325,7 +2325,7 @@ { "name": "page_number", "in": "query", - "description": "If you want to get tafsir of a Madani Muhsaf page", + "description": "If you want to get Tafsir of a Madani Muhsaf page", "type": "integer", "minimum": 1, "maximum": 604 @@ -2333,7 +2333,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get tafsir of a specific hizb.", + "description": "If you want to get Tafsir of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -2341,7 +2341,7 @@ { "name": "rub_el_hizb_number", "in": "query", - "description": "If you want to get tafsir of a specific Rub el Hizb.", + "description": "If you want to get Tafsir of a specific Rub el Hizb.", "type": "integer", "minimum": 1, "maximum": 240 @@ -2349,7 +2349,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get tafsir of a specific ayah.", + "description": "If you want to get Tafsir of a specific verse (Ayah), in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1).", "type": "string" } ], @@ -2362,7 +2362,7 @@ "tafsirs": { "type": "array", "items": { - "$ref": "#/definitions/tafsir" + "$ref": "#/definitions/Tafsir" } }, "meta": { @@ -2405,16 +2405,16 @@ "/quran/verses/code_v1": { "get": { "operationId": "QURAN-verses-code_v1", - "summary": "Get V1 Glyph codes of ayah", + "summary": "Get V1 Glyph codes of Ayah", "tags": [ "Quran" ], - "description": "Get glyph codes of ayah for QCF v1 font", + "description": "Get glyph codes of a verse (Ayah) for QCF v1 font", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get text of a specific surah.", + "description": "If you want to get text of a specific chapter (Surah).", "type": "integer", "minimum": 1, "maximum": 114 @@ -2422,7 +2422,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get text of a specific juz.", + "description": "If you want to get text of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -2438,7 +2438,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get text of a specific hizb.", + "description": "If you want to get text of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -2454,7 +2454,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get text of a specific ayah.", + "description": "If you want to get text of a specific verse (Ayah), in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1).", "type": "string" } ], @@ -2483,7 +2483,7 @@ "type": "integer", "minimum": 1, "maximum": 604, - "description": "Madani Muhsaf page number. You can use `v1_page` to generate css and font faces for QCF page font. " + "description": "Madani Muhsaf page number. You can use `v1_page` to generate CSS and font faces for QCF page font. " } } } @@ -2509,16 +2509,16 @@ "/quran/verses/code_v2": { "get": { "operationId": "QURAN-verses-code_v2", - "summary": "Get V2 Glyph codes of ayah", + "summary": "Get V2 Glyph codes of Ayah", "tags": [ "Quran" ], - "description": "Get glyph codes of ayah for QCF v2 font", + "description": "Get glyph codes of verse (Ayah) for QCF v2 font", "parameters": [ { "name": "chapter_number", "in": "query", - "description": "If you want to get text of a specific surah.", + "description": "If you want to get text of a specific chapter (Surah).", "type": "integer", "minimum": 1, "maximum": 114 @@ -2526,7 +2526,7 @@ { "name": "juz_number", "in": "query", - "description": "If you want to get text of a specific juz.", + "description": "If you want to get text of a specific Juz.", "type": "integer", "minimum": 1, "maximum": 30 @@ -2542,7 +2542,7 @@ { "name": "hizb_number", "in": "query", - "description": "If you want to get text of a specific hizb.", + "description": "If you want to get text of a specific Hizb.", "type": "integer", "minimum": 1, "maximum": 60 @@ -2558,7 +2558,7 @@ { "name": "verse_key", "in": "query", - "description": "If you want to get text of a specific ayah.", + "description": "If you want to get text of a specific verse (Ayah), in the format chapter:verse (e.g. 1:1 -> Chapter 1, Verse 1).", "type": "string" } ], @@ -2619,7 +2619,7 @@ { "name": "recitation_id", "in": "path", - "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", + "description": "Recitation ID, you can get list of all Ayah by Ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "type": "number" }, @@ -2638,7 +2638,7 @@ "tags": [ "Audio" ], - "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Surah.", + "description": "Get list of audio files for a chapter (Surah) from a reciter, specified by their Reciter ID (Look [here](./chapter-reciters)).", "responses": { "200": { "description": "", @@ -2690,7 +2690,7 @@ { "name": "recitation_id", "in": "path", - "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", + "description": "Recitation ID, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "type": "number" }, @@ -2705,11 +2705,11 @@ ], "get": { "operationId": "list-juz-recitaiton", - "summary": "Get Ayah recitations for specific Juz", + "summary": "Get verse (Ayah) recitations for specific Juz", "tags": [ "Audio" ], - "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a juz.", + "description": "Get list of audio files for a Juz by verse (Ayah) from a reciter, specified by their Reciter ID (Look [here](./chapter-reciters)).", "responses": { "200": { "description": "", @@ -2765,7 +2765,7 @@ { "name": "recitation_id", "in": "path", - "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", + "description": "Recitation ID, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "type": "number" }, @@ -2780,11 +2780,11 @@ ], "get": { "operationId": "list-page-recitaiton", - "summary": "Get Ayah recitations for specific Madani Mushaf page", + "summary": "Get verse (Ayah) recitations for specific Madani Mushaf page", "tags": [ "Audio" ], - "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Madani Mushaf page.", + "description": "Get list of audio files for a Madani Mushaf page by verse (Ayah) from a reciter, specified by their Reciter ID (Look [here](./chapter-reciters)).", "responses": { "200": { "description": "", @@ -2840,7 +2840,7 @@ { "name": "recitation_id", "in": "path", - "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", + "description": "Recitation ID, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "type": "number" }, @@ -2855,11 +2855,11 @@ ], "get": { "operationId": "list-rub-el-hizb-recitaiton", - "summary": "Get Ayah recitations for specific Rub el Hizb", + "summary": "Get verse (Ayah) recitations for specific Rub el Hizb", "tags": [ "Audio" ], - "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Rub el Hizb.", + "description": "Get list of audio files for a Rub el Hizb by verse (Ayah) from a reciter, specified by their Reciter ID (Look [here](./chapter-reciters)).", "responses": { "200": { "description": "", @@ -2915,7 +2915,7 @@ { "name": "recitation_id", "in": "path", - "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", + "description": "Recitation ID, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "type": "number" }, @@ -2930,11 +2930,11 @@ ], "get": { "operationId": "list-hizb-recitaiton", - "summary": "Get Ayah recitations for specific Hizb", + "summary": "Get verse (Ayah) recitations for specific Hizb", "tags": [ "Audio" ], - "description": "Get list of ayah #model:knzdXGgyjYnAqbhGX for a Hizb.", + "description": "Get list of audio files for a Hizb by verse (Ayah) from a reciter, specified by their Reciter ID (Look [here](./chapter-reciters)).", "responses": { "200": { "description": "", @@ -2990,14 +2990,14 @@ { "name": "recitation_id", "in": "path", - "description": "Recitation Id, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", + "description": "Recitation ID, you can get list of all ayah by ayah recitations using this endpoint #endpoint:HLbauN2sdGitPQPPL", "required": true, "type": "number" }, { "name": "ayah_key", "in": "path", - "description": "Ayah key is combination of surah number and ayah number. e.g 1:1 will be first Ayah of first Surah", + "description": "Ayah key is combination of chapter (Surah) number and verse (Ayah) number (e.g 1:1 -> Chapter 1, Verse 1).", "required": true, "type": "string", "minimum": 1, @@ -3006,11 +3006,11 @@ ], "get": { "operationId": "list-ayah-recitaiton", - "summary": "Get Ayah recitations for specific Ayah", + "summary": "Get recitations for specific Ayah", "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 (Look [here](./chapter-reciters)).", "responses": { "200": { "description": "", @@ -3076,7 +3076,7 @@ "tags": [ "Resources" ], - "description": "Get information of a specific recitation. Could include detail about the reciter, recitation style. When and who recorded it etc.", + "description": "Get information of a specific recitation. Could include details about the reciter, recitation style, when and who recorded it, etc.", "responses": { "200": { "description": "", @@ -3126,7 +3126,7 @@ "tags": [ "Resources" ], - "description": "Get information of a specific translation. Could include detail about the author, publishing date and publisher etc.", + "description": "Get information of a specific translation. Could include details about the author, publishing date and publisher, etc.", "responses": { "200": { "description": "", @@ -3278,7 +3278,7 @@ "tags": [ "Resources" ], - "description": "Get the information of a specific tafsir. Could include information about the author, when it was published etc.", + "description": "Get the information of a specific tafsir. Could include information about the author, when it was published, etc.", "responses": { "200": { "description": "", @@ -3372,7 +3372,7 @@ "tags": [ "Resources" ], - "description": "Get list of chaper info we've in different languages.", + "description": "Get list of chaper info we have in different languages.", "responses": { "200": { "description": "", @@ -3506,7 +3506,7 @@ }, "/search": { "get": { - "operationId": "search", + "operationId": "Search", "tags": [ "Search" ], @@ -3946,7 +3946,7 @@ }, "verse_key": { "type": "string", - "description": "key of the verse, key is generated using chapter number and ayah number. e.g 1:1 is first ayah of first surah." + "description": "Key of the verse, generated using chapter (Surah) number and verse (Ayah) number (e.g 1:1 -> Chapter 1, Verse 1)." }, "verse_index": { "type": "integer"