Are tag.{name} parameters valid in OpenAPI?

[alanb-sony]

Is the usage of tag.{name} in a OpenAPI parameter name valid OpenAPI? I can't see an explicit reference to it in the OpenAPI specification.

The express-openapi-validator expects a parameter literally named "tag.{name}" and rejects any other name e.g. tag.foo is rejected as an invalid parameter.

The stoplight API docs also don't allow you to set the tag name in the query: https://bbc.github.io/tams/main/index.html#/operations/GET_sources

[j616]

Hello. Sorry for the slow response. We somehow didn't have notifications on for issues!

Unfortunately, swagger doesn't have a nice means of specifying templated parameter names. The format described here OAI/OpenAPI-Specification#2622 (comment) will validate as we intend. But it results in somewhat unhelpful documentation when rendered, with the parameter being an object.

Current implementations such as AWS' open source one handle tags in manually written code, rather than automated solutions generated from the OpenAPI spec https://github.com/awslabs/time-addressable-media-store/blob/main/layers/utils/utils.py#L205

I'll start a discussion on the CNAP slack too see if we can decide on a suitable solution to this.

[j616]

Hello.
I've done some further exploration and experimentation on this. Unfortunately, the pattern described in OAI/OpenAPI-Specification#2622 (comment) does not seem to work consistently across OpenAPI tools and libraries. I have reached out on the OpenAPI slack for advice on the best approach to this, but have yet to hear back. We'll continue to think about this, including alternative forms for the query string.