fix(APIv2): RHINENG-13402 enable multidimensional sort in OpenAPI spec

[romanblanco]

Secure Coding Practices Checklist GitHub Link

• https://github.com/RedHatInsights/secure-coding-checklist

Secure Coding Checklist

• Input Validation
• Output Encoding
• Authentication and Password Management
• Session Management
• Access Control
• Cryptographic Practices
• Error Handling and Logging
• Data Protection
• Communication Security
• System Configuration
• Database Security
• File Management
• Memory Management
• General Coding Practices

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.83%. Comparing base (8a9fdda) to head (c08616c).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2232   +/-   ##
=======================================
  Coverage   98.83%   98.83%           
=======================================
  Files         232      232           
  Lines        5082     5082           
=======================================
  Hits         5023     5023           
  Misses         59       59           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[skateman]

Why is the style: :form needed?

[romanblanco]

Following rswag documentation: https://github.com/rswag/rswag/wiki/FAQ#for-openapi-3

https://swagger.io/docs/specification/v3_0/serialization/#query-parameters

[skateman]

Okay, still don't understand why is this needed.

[romanblanco]

form – (default) ampersand-separated values, also known as form-style query expansion. Corresponds to the {?param_name} URI template.

I believe this is the option we want to use.

[skateman]

If it's default, why do we need this now? The format checks out, we only need the explode as far as I understand.

[skateman]

And why just here be explicit? If it's a default value, it should be consistent across all parameters in the whole specification. So either change it everywhere to style: form or please delete this.

[romanblanco]

We want this to be applied on those parameters of type: :array. Where else do you see this missing?

[skateman]

If this is default (which is), it means it is applied to everything, not just the type: :array so I am asking again, why is this case so special that you want to have an explicit setting that is already implicitly set on it? Why and how is this one single case different from all the other parameters that may or may not have a type: :array which is not connected to the formatting that you are trying to set now explicitly?

[romanblanco]

The referenced ticket answers your question.

[skateman]

No it doesn't, you have 2 independent attributes that you are for some reason try to bind into a single context. One of them is default, so its setting is irrelevant and to maintain consistency across the OpenAPI spec, it makes no sense to explicitly specify in a single location.

[romanblanco]

/retest