Skip to content

added additional properties changes #929

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

Draft
AyushShri wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

added additional properties changes #929

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 17 additions & 0 deletions libV2/schemaUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -815,6 +815,7 @@ let QUERYPARAM = 'query',
description: resolvedSchema.description,
example: resolvedSchema.example,
format: resolvedSchema.format,
additionalProperties: resolvedSchema.additionalProperties,
anyOf: resolvedSchema.anyOf.map((schema) => {
return processSchema(schema);
})
Expand All @@ -827,6 +828,7 @@ let QUERYPARAM = 'query',
description: resolvedSchema.description,
example: resolvedSchema.example,
format: resolvedSchema.format,
additionalProperties: resolvedSchema.additionalProperties,
oneOf: resolvedSchema.oneOf.map((schema) => {
return processSchema(schema);
})
Expand All @@ -839,6 +841,7 @@ let QUERYPARAM = 'query',
description: resolvedSchema.description,
example: resolvedSchema.example,
format: resolvedSchema.format,
additionalProperties: resolvedSchema.additionalProperties,
allOf: resolvedSchema.allOf.map((schema) => {
return processSchema(schema);
})
Expand All @@ -854,6 +857,12 @@ let QUERYPARAM = 'query',
format: resolvedSchema.format
};

if (resolvedSchema.hasOwnProperty('additionalProperties')) {
schemaDetails.additionalProperties = _.isObject(resolvedSchema.additionalProperties) ?
processSchema(resolvedSchema.additionalProperties) :
resolvedSchema.additionalProperties;
}

// Only include properties if they exist in the original schema
if (resolvedSchema.hasOwnProperty('properties')) {
schemaDetails.properties = {};
Expand All @@ -877,6 +886,12 @@ let QUERYPARAM = 'query',
format: propValue.format
};

if (propValue.hasOwnProperty('additionalProperties')) {
propertyDetails.additionalProperties = _.isObject(propValue.additionalProperties) ?
processSchema(propValue.additionalProperties) :
propValue.additionalProperties;
}

if (propValue.anyOf) {
propertyDetails.anyOf = propValue.anyOf.map((schema) => {
return processSchema(schema);
Expand Down Expand Up @@ -2200,6 +2215,7 @@ let QUERYPARAM = 'query',
title: schema.title,
type: resolvedType,
format: schema.format,
additionalProperties: schema.additionalProperties,
default: schema.default,
required: param.required,
deprecated: param.deprecated,
Expand Down Expand Up @@ -2551,6 +2567,7 @@ let QUERYPARAM = 'query',
description: schema.description,
title: schema.title,
format: schema.format,
additionalProperties: schema.additionalProperties,
default: schema.default,
required: schema.required,
deprecated: schema.deprecated,
Expand Down
44 changes: 42 additions & 2 deletions test/unit/convertV2WithTypes.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,13 +556,15 @@ describe('convertV2WithTypes', function() {
{
type: 'object',
example: { name: 'John Doe' },
additionalProperties: true,
properties: {
name: { type: 'string', format: 'email', example: 'Jane' }
}
},
{
type: 'object',
example: { id: 123 },
additionalProperties: true,
properties: {
id: { type: 'integer', format: 'int32', example: 456 }
}
Expand Down Expand Up @@ -605,10 +607,12 @@ describe('convertV2WithTypes', function() {
expect(parsedRequestBody.example).to.deep.equal({ name: 'default example' });
expect(parsedRequestBody.anyOf[0]).to.have.property('example');
expect(parsedRequestBody.anyOf[0].example).to.deep.equal({ name: 'John Doe' });
expect(parsedRequestBody.anyOf[0]).to.have.property('additionalProperties', true);
expect(parsedRequestBody.anyOf[0].properties.name).to.have.property('format', 'email');
expect(parsedRequestBody.anyOf[0].properties.name).to.have.property('example', 'Jane');
expect(parsedRequestBody.anyOf[1]).to.have.property('example');
expect(parsedRequestBody.anyOf[1].example).to.deep.equal({ id: 123 });
expect(parsedRequestBody.anyOf[1]).to.have.property('additionalProperties', true);
expect(parsedRequestBody.anyOf[1].properties.id).to.have.property('format', 'int32');
expect(parsedRequestBody.anyOf[1].properties.id).to.have.property('example', 456);

Expand Down Expand Up @@ -636,6 +640,7 @@ describe('convertV2WithTypes', function() {
{
type: 'object',
example: { message: 'OK' },
additionalProperties: true,
properties: {
message: { type: 'string', format: 'hostname', example: 'All good' }
}
Expand Down Expand Up @@ -672,6 +677,7 @@ describe('convertV2WithTypes', function() {
expect(parsedResponseBody.oneOf[1]).to.have.property('format', 'int64');
expect(parsedResponseBody.oneOf[2]).to.have.property('example');
expect(parsedResponseBody.oneOf[2].example).to.deep.equal({ message: 'OK' });
expect(parsedResponseBody.oneOf[2]).to.have.property('additionalProperties', true);
expect(parsedResponseBody.oneOf[2].properties.message).to.have.property('format', 'hostname');
expect(parsedResponseBody.oneOf[2].properties.message).to.have.property('example', 'All good');

Expand All @@ -695,13 +701,15 @@ describe('convertV2WithTypes', function() {
{
type: 'object',
example: { baseField: 'example base' },
additionalProperties: true,
properties: {
baseField: { type: 'string', format: 'uuid', example: 'field example' }
}
},
{
type: 'object',
example: { extensionField: 200 },
additionalProperties: true,
properties: {
extensionField: { type: 'integer', format: 'int32', example: 300 }
}
Expand All @@ -722,13 +730,15 @@ describe('convertV2WithTypes', function() {
{
type: 'object',
example: { id: '456' },
additionalProperties: true,
properties: {
id: { type: 'string', format: 'uuid', example: '789' }
}
},
{
type: 'object',
example: { timestamp: '2024-12-22T00:00:00Z' },
additionalProperties: true,
properties: {
timestamp: { type: 'string', format: 'date-time', example: '2025-01-01T00:00:00Z' }
}
Expand Down Expand Up @@ -761,10 +771,12 @@ describe('convertV2WithTypes', function() {
expect(parsedRequestBody.example).to.deep.equal({ baseField: 'base', extensionField: 100 });
expect(parsedRequestBody.allOf[0]).to.have.property('example');
expect(parsedRequestBody.allOf[0].example).to.deep.equal({ baseField: 'example base' });
expect(parsedRequestBody.allOf[0]).to.have.property('additionalProperties', true);
expect(parsedRequestBody.allOf[0].properties.baseField).to.have.property('format', 'uuid');
expect(parsedRequestBody.allOf[0].properties.baseField).to.have.property('example', 'field example');
expect(parsedRequestBody.allOf[1]).to.have.property('example');
expect(parsedRequestBody.allOf[1].example).to.deep.equal({ extensionField: 200 });
expect(parsedRequestBody.allOf[1]).to.have.property('additionalProperties', true);
expect(parsedRequestBody.allOf[1].properties.extensionField).to.have.property('format', 'int32');
expect(parsedRequestBody.allOf[1].properties.extensionField).to.have.property('example', 300);

Expand All @@ -781,10 +793,12 @@ describe('convertV2WithTypes', function() {
expect(parsedResponseBody.example).to.deep.equal({ id: 'res123', timestamp: '2024-01-01' });
expect(parsedResponseBody.allOf[0]).to.have.property('example');
expect(parsedResponseBody.allOf[0].example).to.deep.equal({ id: '456' });
expect(parsedResponseBody.allOf[0]).to.have.property('additionalProperties', true);
expect(parsedResponseBody.allOf[0].properties.id).to.have.property('format', 'uuid');
expect(parsedResponseBody.allOf[0].properties.id).to.have.property('example', '789');
expect(parsedResponseBody.allOf[1]).to.have.property('example');
expect(parsedResponseBody.allOf[1].example).to.deep.equal({ timestamp: '2024-12-22T00:00:00Z' });
expect(parsedResponseBody.allOf[1]).to.have.property('additionalProperties', true);
expect(parsedResponseBody.allOf[1].properties.timestamp).to.have.property('format', 'date-time');
expect(parsedResponseBody.allOf[1].properties.timestamp).to.have.property('example', '2025-01-01T00:00:00Z');

Expand Down Expand Up @@ -1506,6 +1520,15 @@ describe('convertV2WithTypes', function() {
description: 'Authorization header'
}
},
{
name: 'filters',
in: 'query',
schema: {
type: 'object',
additionalProperties: true,
description: 'Arbitrary key-value filters'
}
},
{
name: 'singleTypeParam',
in: 'query',
Expand Down Expand Up @@ -1539,6 +1562,13 @@ describe('convertV2WithTypes', function() {
type: ['string', 'number'] // Union type - should pick 'string' (first)
}
},
'x-meta': {
description: 'Additional metadata',
schema: {
type: 'object',
additionalProperties: true
}
},
'x-single-type-header': {
description: 'Simple header',
schema: {
Expand Down Expand Up @@ -1582,12 +1612,17 @@ describe('convertV2WithTypes', function() {

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

const formatParam = queryParams.find((p) => { return p.keyName === 'format'; });
expect(formatParam).to.be.an('object');
expect(formatParam.properties.type).to.equal('integer'); // First type from ['integer', 'string']

const filtersParam = queryParams.find((p) => { return p.keyName === 'filters'; });
expect(filtersParam).to.be.an('object');
expect(filtersParam.properties.type).to.equal('object');
expect(filtersParam.properties.additionalProperties).to.equal(true);

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

const firstResponseStatus = responseStatuses[0];
const responseHeaders = JSON.parse(requestTypes.response[firstResponseStatus].headers);
expect(responseHeaders).to.be.an('array').with.length(3);
expect(responseHeaders).to.be.an('array').with.length(4);

const rateLimitHeader = responseHeaders.find((h) => { return h.keyName === 'x-rate-limit'; });
expect(rateLimitHeader).to.be.an('object');
Expand All @@ -1620,6 +1655,11 @@ describe('convertV2WithTypes', function() {
expect(requestIdHeader).to.be.an('object');
expect(requestIdHeader.properties.type).to.equal('string'); // First type from ['string', 'number']

const metaHeader = responseHeaders.find((h) => { return h.keyName === 'x-meta'; });
expect(metaHeader).to.be.an('object');
expect(metaHeader.properties.type).to.equal('object');
expect(metaHeader.properties.additionalProperties).to.equal(true);

const singleTypeHeader = responseHeaders.find((h) => { return h.keyName === 'x-single-type-header'; });
expect(singleTypeHeader).to.be.an('object');
expect(singleTypeHeader.properties.type).to.equal('boolean'); // Single type should remain unchanged
Expand Down
Loading