fix(execute): empty field added to multi-value parameters

[glowcloud]

Refs swagger-api/swagger-ui#5176

Fixes the issue for when no value is selected, sending an empty string in an array after selecting the '--' option is a separate issue in Swagger UI.

[glowcloud]

Let me know if the same changes should also be made for query and header here https://github.com/swagger-api/swagger-js/blob/fix-empty-field-for-multi-value-parameters/src/execute/swagger2/parameter-builders.js

[char0n]

Please add a test as well for the cases we're trying to fix with this change.

[char0n]

Added the same check for query despite it working without it - when we had an empty array, it would go inside the if block but we somehow wouldn't have the empty field. Not sure if this change is needed

We need to know for sure, why this happens.

Let me know if the same changes should also be made for query and header here https://github.com/swagger-api/swagger-js/blob/fix-empty-field-for-multi-value-parameters/src/execute/swagger2/parameter-builders.js

I think it will be related to the result of analysis related to the previous quote

[glowcloud]

The if (value) check is fine for query and OAS3, because of how we format queries later. At some point we use formatKeyValue, which in case of OAS3 will also go into formatKeyValueBySerializationOption, where here

swagger-js/src/http/index.js

Line 331 in e0c96b0

if (Array.isArray(value)) {

it will format the params as [ 'fields', [] ].

In case of OAS2, we will go in here

swagger-js/src/http/index.js

Line 296 in e0c96b0

if (Array.isArray(value)) {

where the params will become [ 'fields', '' ].

Because of this, the string that we get to add to the base URL in encodeFormOrQuery, the result of this line

swagger-js/src/http/index.js

Line 419 in e0c96b0

return qs.stringify(encodedQuery, { encode: false, indices: false }) || '';

in case of OAS3 will be just an empty string, while for OAS2 it will be fields=.

Perhaps we could change this check here

swagger-js/src/http/index.js

Line 297 in e0c96b0

if (collectionFormat === 'multi') {

to if (collectionFormat === 'multi' || value.length === 0) to get an empty array for OAS2 as well? Otherwise we can stay with if (value && !(Array.isArray(value) && value.length === 0)) in query parameter builder.

[char0n]

LGTM. Nicely done!

[swagger-bot]

🎉 This PR is included in version 3.25.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀