New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
assem-ch opened this Issue Jan 13, 2016 · 2 comments

Comments

Projects
None yet
2 participants
@assem-ch
Copy link
Member

assem-ch commented Jan 13, 2016

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.

@assem-ch assem-ch added the api label Jan 13, 2016

@assem-ch assem-ch self-assigned this Jan 13, 2016

@assem-ch assem-ch removed their assignment Jan 13, 2016

@assem-ch assem-ch added the ready label Jun 3, 2016

@sneetsher

This comment has been minimized.

Copy link
Member

sneetsher commented May 9, 2017

  • 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

This comment has been minimized.

Copy link
Member Author

assem-ch commented May 26, 2018

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment