fix: deserialize relationships filter from query params

[jcrossley3]

Fixes #1232

[chirino]

lgtm.

[chirino]

So the openapi client will genereate requests that look like:

http://localhost:3000/api/v2/analysis/component/test?ancestors=10&relationships[]=contains&relationships[]=dependency

Any chance we could parse that?

[chirino]

Ah shit maybe we just need to fix the test to do it the openapi way!..

[chirino]

@jcrossley3 I think you can close, #1257 is the simple fix.

[jcrossley3]

@jcrossley3 I think you can close, #1257 is the simple fix.

I agree that fix is simple, but it changes the test, and it forces me to remember to add [] after the field name. Does anyone really want that?

[carlosthe19916]

My understanding from the internal chat is that we need to pass an array of values through the query params.

From my experience:

• If the queries get to a very complex level we could consider migrating GET to POST. E.g. GET /myendpoint?complex_params to POST /myendpoint with a body . Main point, set multiple combination of queries in the body of the POST request
• We can use what we have already in all the search endpoints (my example is without encoding).

/api/v2/vulnerability?limit=10&offset=0&q=average_severity=low|medium|high|critical

Notice that there is a variable average_severity that is receiving an array of possible values.

[chirino]

@carlosthe19916 so the js openapi client can already pass the array with a js call like:

getComponent({
    path: { key: "test" },
    query: {
      ancestors: 10,
      relationships: ["contains", "dependency"],
    },
  });

where the relationships field is defined as: relationships?: Array<Relationship>; so you get a nice typesafe interface.

The above would generate this URL: http://localhost:3000/api/v2/analysis/component/test?ancestors=10&relationships[]=contains&relationships[]=dependency

But sadly this PR breaks the above but in exchange, users gain the ability to manually construct URLs easier.
This PR would require the URL to be : http://localhost:3000/api/v2/analysis/component/test?ancestors=10&relationships=contains,dependency

#1257 keeps the openapi interface working and also supports constructing the URL easy by adding a new field.
You could use http://localhost:3000/api/v2/analysis/component/test?ancestors=10&relationships[]=contains&relationships[]=dependency
to filter on multiple or
http://localhost:3000/api/v2/analysis/component/test?ancestors=10&relationship=contains to filter for a single relationship.

[JimFuller-RedHat]

LGTM! and thx for litigating the whole conversation on this!

Dismissing in light of 1257 being closed -- not sure this PR is our final answer but it's an evolutionary step.