Skip to content

Add support for array query parameter #17

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

Open
Ashraf-Ali-aa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for array query parameter #17

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
174 changes: 140 additions & 34 deletions src/N8NPropertiesBuilder.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import {N8NPropertiesBuilder, Override} from './N8NPropertiesBuilder';
import { N8NPropertiesBuilder, Override } from './N8NPropertiesBuilder';

import {BaseOperationsCollector} from "./OperationsCollector";
import {OpenAPIV3} from "openapi-types";
import {OperationContext} from "./openapi/OpenAPIVisitor";
import { BaseOperationsCollector } from "./OperationsCollector";
import { OpenAPIV3 } from "openapi-types";
import { OperationContext } from "./openapi/OpenAPIVisitor";
import * as lodash from "lodash";
import {DefaultOperationParser} from "./OperationParser";
import {DefaultResourceParser} from "./ResourceParser";
import { DefaultOperationParser } from "./OperationParser";
import { DefaultResourceParser } from "./ResourceParser";

export class CustomOperationParser extends DefaultOperationParser {
name(operation: OpenAPIV3.OperationObject, context: OperationContext): string {
Expand Down Expand Up @@ -58,7 +58,7 @@ test('query param - schema', () => {
},
};

const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
});
Expand Down Expand Up @@ -207,7 +207,7 @@ test('query param - content', () => {
},
};

const parser = new N8NPropertiesBuilder({paths, components}, {
const parser = new N8NPropertiesBuilder({ paths, components }, {
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
});
Expand Down Expand Up @@ -326,7 +326,7 @@ test('query param - dot in field name', () => {
},
};

const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
});
Expand Down Expand Up @@ -436,7 +436,7 @@ test('path param', () => {
},
};

const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
OperationsCollector: BaseOperationsCollector,
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
Expand Down Expand Up @@ -555,7 +555,7 @@ test('request body', () => {
},
};

const parser = new N8NPropertiesBuilder({paths, components}, {
const parser = new N8NPropertiesBuilder({ paths, components }, {
OperationsCollector: BaseOperationsCollector,
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
Expand Down Expand Up @@ -659,7 +659,7 @@ test('request body', () => {
operation: ['Create'],
},
},
default: JSON.stringify({foo: 'bar'}, null, 2),
default: JSON.stringify({ foo: 'bar' }, null, 2),
required: undefined,
routing: {
"send": {
Expand Down Expand Up @@ -701,7 +701,7 @@ test('enum schema', () => {
};

// @ts-ignore
const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
OperationsCollector: BaseOperationsCollector,
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
Expand Down Expand Up @@ -786,29 +786,29 @@ test('enum schema', () => {
});

test('body "array" param', () => {
const paths = {
'/api/entities': {
post: {
operationId: 'EntityController_create',
summary: 'Create entity',
requestBody: {
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'string',
},
const paths = {
'/api/entities': {
post: {
operationId: 'EntityController_create',
summary: 'Create entity',
requestBody: {
content: {
'application/json': {
schema: {
type: 'array',
items: {
type: 'string',
},
},
},
},
tags: ['🖥️ Entity'],
},
tags: ['🖥️ Entity'],
},
};
},
};

const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
OperationsCollector: BaseOperationsCollector,
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
Expand Down Expand Up @@ -880,8 +880,8 @@ test('body "array" param', () => {
"type": "string"
}
]
expect(result).toEqual(expected)
}
expect(result).toEqual(expected)
}
)

test('test overrides', () => {
Expand Down Expand Up @@ -955,7 +955,7 @@ test('test overrides', () => {
},
];

const parser = new N8NPropertiesBuilder({paths, components}, {
const parser = new N8NPropertiesBuilder({ paths, components }, {
OperationsCollector: BaseOperationsCollector,
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
Expand Down Expand Up @@ -1099,7 +1099,7 @@ test('multiple tags', () => {
},
};

const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
})
Expand Down Expand Up @@ -1297,7 +1297,7 @@ test('no tags - default tag', () => {
},
};

const parser = new N8NPropertiesBuilder({paths}, {
const parser = new N8NPropertiesBuilder({ paths }, {
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
});
Expand Down Expand Up @@ -1394,3 +1394,109 @@ test('no tags - default tag', () => {
]
);
});

test('array query parameters', () => {
const paths = {
'/api/locations': {
get: {
operationId: 'getLocations',
summary: 'Get locations within area',
parameters: [
{
name: 'sw_corner[]',
in: 'query',
required: true,
description: 'Southwest corner coordinates [latitude, longitude]',
schema: {
type: 'array',
items: {
type: 'number'
},
minItems: 2,
maxItems: 2
},
style: 'form',
explode: true,
example: [53.500403, -2.276471]
},
{
name: 'ne_corner[]',
in: 'query',
required: true,
description: 'Northeast corner coordinates [latitude, longitude]',
schema: {
type: 'array',
items: {
type: 'number'
},
minItems: 2,
maxItems: 2
},
style: 'form',
explode: true,
example: [53.521749, -2.259879]
},
{
name: 'tags',
in: 'query',
required: false,
description: 'Filter by tags',
schema: {
type: 'array',
items: {
type: 'string'
}
},
style: 'form',
explode: false
},
{
name: 'limit',
in: 'query',
schema: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 50
},
description: 'Maximum number of locations to return'
}
],
tags: ['Locations'],
},
},
};

const parser = new N8NPropertiesBuilder({ paths }, {
OperationsCollector: BaseOperationsCollector,
operation: new CustomOperationParser(),
resource: new CustomResourceParser(),
});
const result = parser.build();

// Find the sw_corner parameter
const swCornerField = result.find(field => field.name === 'sw_corner%5B%5D'); // URL encoded sw_corner[]
expect(swCornerField).toBeDefined();
expect(swCornerField?.type).toBe('fixedCollection');
expect(swCornerField?.typeOptions?.multipleValues).toBe(true);
expect(swCornerField?.required).toBe(true);
expect(swCornerField?.routing?.send?.type).toBe('query');
expect(swCornerField?.routing?.send?.property).toBe('sw_corner[]');

// Find the ne_corner parameter
const neCornerField = result.find(field => field.name === 'ne_corner%5B%5D');
expect(neCornerField).toBeDefined();
expect(neCornerField?.type).toBe('fixedCollection');

// Find the tags parameter (comma-separated)
const tagsField = result.find(field => field.name === 'tags');
expect(tagsField).toBeDefined();
expect(tagsField?.type).toBe('fixedCollection');
expect(tagsField?.routing?.send?.value).toContain('join(",")');

// Find the regular limit parameter
const limitField = result.find(field => field.name === 'limit');
expect(limitField).toBeDefined();
expect(limitField?.type).toBe('number');
expect(limitField?.routing?.send?.value).toBe('={{ $value }}');
});
Loading