Ability to search by using logical OR connective

[jsdelivr]

Ability to search by using logical OR connective

[bebraw]

It's AND, yes. Does it make sense to support OR on API level? What if you just performed multiple queried and then combined the results?

[gamtiq]

I suppose that support for OR is not absolutely necessary. But it is convenient in some situations.
To make multiple queries and to combine results is a possible approach. But it leads to extra request(s) which may cause growth of burden for network and server.

[bebraw]

Ok. Can you propose an approach? What it would look like on API level?

[gamtiq]

One way is to make it by using some special parameter. Maybe it is not the best way but at least it should be quite simple and understandable (I hope).

[tomByrer]

What it would look like on API level?

http://api.jsdelivr.com/v2/jsdelivr/libraries?or(name=*jquery*+description=*jquery*+mainfile=*jquery*)&not(name=jquery)
Should find all repos that use jQuery, but is not the jQuery distro itself.

Could use , as a deliminator instead of + (my preference is , but I used the jsDelivr multifile API. Perhaps always use wildcard search for long fields like description? Also, prose fields like URLs & description need to be lowercased.
Sound good?

[tomByrer]

oops, had to fix my API example

[gamtiq]

I like this proposal.
Maybe , as a separator is more readable.

[bebraw]

http://api.jsdelivr.com/v2/jsdelivr/libraries?or(name=*jquery*+description=*jquery*+mainfile=*jquery*)&not(name=jquery)
Should find all repos that use jQuery, but is not the jQuery distro itself.

Why would you want to exclude jQuery distro?

If we want to get away with the least effort, we can do just op=or to override default. Less API to remember and easier to implement but that won't be as powerful as what you are suggesting. This would look something like this:

http://api.jsdelivr.com/v2/jsdelivr/libraries?op=or&name=*jquery*&description=*jquery*&mainfile=*jquery*

In addition you would filter out jquery library itself on client side to match your use case. This seems like a special case to me and I'm not entirely convinced yet it would be a good idea to provide it on the API level. A lot added of complexity for little benefit.

[gamtiq]

I agree with op=or approach if it can be implemented without considerable efforts.

[bebraw]

@gamtiq It's a very small change. Given it's backwards compatible I can add it to v1 API even.

@tomByrer What do you think?

[tomByrer]

Honestly, I find the op=or harder to read; does op=or&name=*jquery*&description=*jquery*&mainfile=*jquery* mean

SELECT *
FROM libraries
WHERE name LIKE '%jquery%' OR description LIKE '%jquery%' AND mainfile LIKE '%jquery%'

or

SELECT name, description, mainfile
FROM libraries
WHERE (name LIKE '%jquery%' AND description LIKE '%jquery%') OR (name LIKE '%jquery%'  AND mainfile LIKE '%jquery%'

?
If parens are added to op=or then that will be easier to read by eyes, but if that is slower in server &/or client, then please do what is most efficient. Either way, thanks for asking for feedback!

NOT seems like a special case

If too much work, don't bother please :)

[bebraw]

op=or changes default behavior to OR so instead of having AND for all you get OR. So in case any of the query parameters matches, it will be returned.

It would be a very easy change to make. Just wondering if it would be useful.

@gamtiq Would that help in your use case?

[gamtiq]

I suppose that would be enough and quite useful.