Add option to disable rendering service level tags

[kkolur]

🚀 Feature

here it looks like tags at the root level are still TODO. Is this planned to be prioritized?Right now, in the output, the tags are automatically generated with the service(s) names but I would prefer to override that behavior by defining my own set of tags at the root level. OR, we can make the rendering of service tags optional and defaulted to true through command line flags?

Also, according to OpenAPI docs, extensions are supported for tags as well. Could we add this as well?

How difficult would this be overall?

[johanbrandhorst]

There are a few settings already for how the tags are generated I believe:

grpc-gateway/protoc-gen-openapiv2/main.go

Line 31 in b2fed3c

openAPINamingStrategy = flag.String("openapi_naming_strategy", "", "use the given OpenAPI naming strategy. Allowed values are `legacy`, `fqn`, `simple`. If unset, either `legacy` or `fqn` are selected, depending on the value of the `fqn_for_openapi_name` flag")

. I'm not sure exactly what you're asking for. Do you want the ability add tags? How do you want to map those tags to objects? What do you want to do with extensions in tags? I think the use case has to be compelling enough that I could see it being useful to many of our users. Notably, you are the first to ask for this, which is not a great indicator of the need.

[kkolur]

@johanbrandhorst I want the option to not automatically render service tags. RIght now the service tags are automatically generated here. If we could have some sort of command line flag that could let us disable that is what I was asking for.

Using ReDoc, after we added tags to each endpoint, the service level tags were still displayed in the left hand side nav bar which we dont want to display for the users of the docs. We could write a post process script that removes the root level tags object, but I figured it wouldn't hurt if we added a cli flag thats defaulted to true but have the option to set it to false

[johanbrandhorst]

I see, thanks for clarifying. I could see a flag that disables tags altogether, but I'm not convinced the need is good enough yet. Maybe we can leave this issue open and see if there are more users who want this functionality before we decide to add it?

[kkolur]

@johanbrandhorst I wouldn't want to disable tags altogether, I just would want an option to disable the rendering of service tags. I think such an option thats defaulted to true wouldn't hurt too much and would only serve as an extra layer of customization that we already have available through the cli flags 😃

Thoughts?

[davix]

We have the same requirement. (asked in slack before https://gophers.slack.com/archives/CBATURP1D/p1653487121966699)
We use the swagger at API gateway which exposes a few backend grpc services. Because backend services' name are inappropriate to be exposed, we define custom tags for the APIs with different grouping strategy. But the service tags still exist now.
May contribute if there are guidance.

[kkolur]

I think I have a decent idea of what to do while perusing the codebase so I can take the task on as well @davix 🙂

[kkolur]

@johanbrandhorst PR here 😊