search

quran / quran.com-frontend-v2

https://quran.com
GNU General Public License v3.0
452 stars 199 forks source link

API endpoint descriptions #530

Closed osamaramihafez closed 2 years ago

osamaramihafez commented 2 years ago

Firstly, wanted to say jazakumAllahukhairan to the team for working on this amazing project.

I noticed that some of the endpoints in the API docs aren't described very well. For example, I was looking at: https://quran.api-docs.io/v4/search/KfCmk4KQYbtyK9adj

I found it a bit confusing as to what exactly is being searched for and how the query should be structured.

Just curious if the endpoints could get better descriptions.

osamaramihafez commented 2 years ago

Realized that there is a repo specific to the frontend, this can be ignored.