[almighty] How would the 'search' URLs look like for the ALM Search service ?

[Monica Granfield]

On Thu, Oct 20, 2016 at 3:23 AM, Shoubhik Bose <shbose at redhat.com> wrote:

> Hi folks,
>
> Wanted to discuss how the /api/search URL(s) would look like.
>
> To set the scope of the discussion right, I must mention that in this
> sprint we are working on supporting search on ID , URL and full text ( for
> title and description only ) of a workitem.
>

** Am curious what is driving the need for these attributes to search by? I
would have thought that search by assigned to would be a top candidate as
these three attributes all focus on the work item only. Can we replace
string with Assignee, as to address this issue?

>
>
>
>    1. The ID search is currently only on workitems. ( But in future it
>    would be supported for other objects as well. Example, Users,etc. )
>
>    To search by ID --
>
>    /api/search/q*=id:4324*
>    This is going to look up the workitem table *only*.
>
>
>    2.
>    To search by URL --
>
>    /api/search/q*=url:http://demo.almighty.io/#/detail/71
>    <http://demo.almighty.io/#/detail/71>*
>
>
>
>    3.
>    Search by ID *AND* URL is not supported.
>    If a q=xxyzz  contains both URL and ID, we only pickup the URL and
>    discard the rest.
>
>    Example.
>    /api/search/q=*id:4324*+
>
> *url:http://demo.almighty.io/#/detail/71
>    <http://demo.almighty.io/#/detail/71> *is effectively
>
>    /api/search/q=*url:http://demo.almighty.io/#/detail/71
>    <http://demo.almighty.io/#/detail/71>*
>
>
Behaviorally if I typed in 731 http://..../......

I would expect it to pick up the ID first, as it is first in order. I am
also wondering about the fuzzy type ahead that Max mentioned and if any
thought has been given around that?

>
>    1.
>
>
> 2.
>    Free text search is supported only on workitem title and description
>
>    /api/search/q:=*title:some title substring*+
> *description:some description substring *
>
> 3.
>    The delimiter for multiple clauses ( we shall support "AND" now ) will
>    be "+" . ( inspired from Github ) as already used above. We need to
>    consider situations where the string itself contains a "+" by escaping them
>    properly.
>
>
>    4. if the search query contains a mix of ID, URL , title,description :
>    The order in which we are going to look for fields to make a decision
>    on the search is:
>
>    1. URL
>    2. ID
>    3. title and description ( for free text search )
>
>
>
>
>    Let me know your thoughts :)
>
>
>    -
>    Shoubhik
>
>
>
>
> _______________________________________________
> almighty-public mailing list
> almighty-public at redhat.com
> https://www.redhat.com/mailman/listinfo/almighty-public
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/almighty-public/attachments/20161020/6080c110/attachment.htm>