Skip to content

Handle union types in parameters #888

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Oct 14, 2025
Merged

Handle union types in parameters #888

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f774bfe
Handle union types in parameters by picking the first type
Oct 10, 2025
195f877
Merge branch 'develop' into fix/params-union-types
animeshjajoopostman Oct 10, 2025
0411f37
Fix merge conflicts
Oct 10, 2025
f6fc421
Handle union types in response headers
Oct 14, 2025
673fd01
Fix handling of empty union types in schema resolution and update tests
Oct 14, 2025
7d82865
Revert to return statement in schema property resolution
Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions libV2/schemaUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2147,10 +2147,12 @@ let QUERYPARAM = 'query',
const { schema } = param;

// Handle union types (OpenAPI 3.1.x supports arrays of types like ["string", "integer"])
// Pick the first type if it's a union of types
const resolvedType = Array.isArray(schema.type) ? schema.type[0] : schema.type;
// Pick the first type if it's a union of types, but only if array is not empty
const resolvedType = Array.isArray(schema.type) ?
(schema.type.length > 0 ? schema.type[0] : undefined) :
schema.type;

return {
const properties = {
Copy link
Collaborator

@AyushShri AyushShri Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any reason to change this ?

Copy link
Collaborator Author

@animeshjajoopostman animeshjajoopostman Oct 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, had changed it when trying something out. Let me revert

description: schema.description,
title: schema.title,
type: resolvedType,
Expand All @@ -2166,6 +2168,8 @@ let QUERYPARAM = 'query',
pattern: schema.pattern,
example: schema.example
};

return properties;
},

resolveQueryParamsForPostmanRequest = (context, operationItem, method) => {
Expand Down Expand Up @@ -2496,8 +2500,10 @@ let QUERYPARAM = 'query',
}

// Handle union types (OpenAPI 3.1.x supports arrays of types like ["string", "integer"])
// Pick the first type if it's a union of types
const resolvedType = Array.isArray(schema.type) ? schema.type[0] : schema.type;
// Pick the first type if it's a union of types, but only if array is not empty
const resolvedType = Array.isArray(schema.type) ?
(schema.type.length > 0 ? schema.type[0] : undefined) :
schema.type;

properties = {
type: resolvedType,
Expand All @@ -2515,6 +2521,7 @@ let QUERYPARAM = 'query',
pattern: schema.pattern,
example: schema.example
};

headerTypeInfo = { keyName: headerData.name, properties };
headerTypes.push(headerTypeInfo);
}
Expand Down
14 changes: 13 additions & 1 deletion test/unit/convertV2WithTypes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1206,6 +1206,14 @@ describe('convertV2WithTypes', function() {
type: 'string', // Single type - should remain 'string'
description: 'Simple string parameter'
}
},
{
name: 'emptyUnionParam',
in: 'query',
schema: {
type: [], // Empty union type - should not have type property
description: 'Empty union type parameter'
}
}
],
responses: {
Expand Down Expand Up @@ -1267,7 +1275,7 @@ describe('convertV2WithTypes', function() {

// Check query parameters
const queryParams = JSON.parse(requestTypes.request.queryParam);
expect(queryParams).to.be.an('array').with.length(2);
expect(queryParams).to.be.an('array').with.length(3);

const formatParam = queryParams.find((p) => { return p.keyName === 'format'; });
expect(formatParam).to.be.an('object');
Expand All @@ -1277,6 +1285,10 @@ describe('convertV2WithTypes', function() {
expect(singleTypeParam).to.be.an('object');
expect(singleTypeParam.properties.type).to.equal('string'); // Single type should remain unchanged

const emptyUnionParam = queryParams.find((p) => { return p.keyName === 'emptyUnionParam'; });
expect(emptyUnionParam).to.be.an('object');
expect(emptyUnionParam.properties).to.not.have.property('type'); // Empty union should not have type property

// Check request header parameters
const headerParams = JSON.parse(requestTypes.request.headers);
expect(headerParams).to.be.an('array').with.length(1);
Expand Down
Loading