Adding global tags element #227
Conversation
Adding global tags array
hdamker
left a comment
There was a problem hiding this comment.
One small correction necessary to make linting happy ;-)
Trailing spaces removed Co-authored-by: Herbert Damker <[email protected]>
jlurien
left a comment
There was a problem hiding this comment.
We should use same format for both tags, either both sessions and profiles in lowecase or uppercase. Tags per operation have to be adjusted accordingly
I looked over the documentation parts, and there we have also the same difference, it's more or less consequently "QoS session" and "QoS Profile". But I propose to not extend the scope of this PR to a cleanup of the documentation parts, and do it here only for the tags. I would tend to lowercase "QoS session" and "QoS profile", but that's just my view. Any other views? |
My preference is Title Case, but this is a style point and really one for Commonalities and the design guidelines., whose example tags are unfortunately ambiguous on this point. |
|
I do no think we need exact guidelines for tags style/format, as tags are helper properties to clearly describe and render OAS and are useful with large API specifications. |
|
If we want a common "look and feel" between CAMARA APIs, then we need an agreement in Commonalities on tag format style. |
QoS sessions --> QoS Sessions
RandyLevensalor
left a comment
There was a problem hiding this comment.
LGTM Thanks for adding this.
|
Good to go. Thanks @rartych ! |
What type of PR is this?
What this PR does / why we need it:
Operation tags should be defined in a top-level
tagselement.Which issue(s) this PR fixes:
Fixes #223
Special notes for reviewers:
Description field is rendered by Swagger this way:

Changelog input
Additional documentation