Make "tag" an available field to search for components in query_string

[hugomcfonseca]

Current API does not support to query for components using tags as a querystring field.

Is it expectable to have this implemented? I can help with a pull request.

[nalysius]

Hello,

The idea of querying for components using tags may be useful. But the question that I am wondering is: a component may have many tags, so in the query string we may give many tags too. Should they be combined with an AND and OR? And if an OR, should he be exclusive or not?

Example:

http://cachet.dev/api/v1/components?tags[]=tag1&tags[]=tag2

Are we looking for components that have tag1 && tag2, or those that have tag1 || tag2?

[hugomcfonseca]

@anthonybocci I would vote in option A because to be consistent with current API. For example, if you get info from http://cachet.dev/api/v1/components?status=1&name=XYZ, it would return an AND operation, not an OR.

[nalysius]

@hugomcfonseca I agree, indeed the other criterias are an AND operation, so the components that are returned in your example have the status 1 && the name XYZ.

So it would be something like:

http://cachet.dev/api/v1/components?tags[]=ABC&tags[]=DEF&name=XYZ
The returned component(s) will have the name XYZ && the both tags ABC && DEF.

[hugomcfonseca]

Yes, exactly @anthonybocci.

[nalysius]

@hugomcfonseca if you implement it I can contribute if necessary, either by coding or testing.

[hugomcfonseca]

ok @anthonybocci, I am already on it. Once I finish it, I'll do a pull request

[nalysius]

👍
It could be great if the documentation was updated automatically. Otherwise nobody will be able to use the updated API.

[hugomcfonseca]

I created an issue related to that a few days ago (issue #2903), but still without any feedback at the moment.

[jbrooksuk]

Since tags can technically be applied to any model now, I'd be keen on having this built into Cachet :)

[jbrooksuk]

I started working on this last night for a "proof of concept", I don't think it's too much work honestly.