Add a new command to search in api and get only a list of aya ids and keywords.

Alfanous-team / alfanous

Alfanous is an Arabic search engine API provides the simple and advanced search in Quran , more features and many interfaces...

http://www.alfanous.org/

GNU Affero General Public License v3.0

254 stars 89 forks source link

Add a new command to search in api and get only a list of aya ids and keywords. #458

Open assem-ch opened 8 years ago

assem-ch commented 8 years ago

This will help software looking only for search not all info. Generally the best ID is the tuple: Sura id and Aya id.

A list of keywords may be also mandatory in order to achieve highlight.

suggested keyword : search_min could be supported with another commands get_aya and get_aya_text.

sneetsher commented 7 years ago

search_min can create ambiguity, user need to look for doc
get_aya and get_aya_text I like the idea, it may not handle future enhancement with translations ... we can't create a command for each .

May be hard but generic, user can request a custom output format/filter. Like many gnu tool do (ex: date)

assem-ch commented 6 years ago

there are already custom filters and views but its not obvious for some one who is coming for alfanous to use it. I am thinking of building a swagger documentation.