Skip to content

Add support for multiple @QueryParams #131

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add support for multiple @QueryParams #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50611c8
add support for multiple @QueryParams
filipjezek Dec 20, 2022
cb9a2d1
Merge branch 'epiphone:master' into master
filipjezek Jul 22, 2024
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
28 changes: 27 additions & 1 deletion __tests__/parameters.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,15 @@ describe('parameters', () => {
@IsString({ each: true })
types: string[]
}
class AdditionalQueryParams {
@IsBoolean()
@IsOptional()
includeRelationships: boolean

@IsBoolean()
@IsOptional()
includePets: boolean
}

@JsonController('/users')
// @ts-ignore: not referenced
Expand All @@ -53,6 +62,7 @@ describe('parameters', () => {
@HeaderParam('Authorization', { required: true })
_authorization: string,
@QueryParams() _queryRef?: ListUsersQueryParams,
@QueryParams() _queryRef2?: AdditionalQueryParams,
@HeaderParams() _headerParams?: ListUsersHeaderParams
) {
return
Expand Down Expand Up @@ -161,7 +171,7 @@ describe('parameters', () => {
})
})

it('parses query param ref from @QueryParams decorator', () => {
it('parses query param refs from @QueryParams decorator', () => {
expect(getQueryParams(route, schemas)).toEqual([
// limit comes from @QueryParam
{
Expand Down Expand Up @@ -195,6 +205,22 @@ describe('parameters', () => {
type: 'array',
},
},
{
in: 'query',
name: 'includeRelationships',
required: false,
schema: {
type: 'boolean',
},
},
{
in: 'query',
name: 'includePets',
required: false,
schema: {
type: 'boolean',
},
},
])
})

Expand Down
37 changes: 19 additions & 18 deletions src/generateSpec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,24 +170,25 @@ export function getQueryParams(
}
})

const queriesMeta = route.params.find((p) => p.type === 'queries')
if (queriesMeta) {
const paramSchema = getParamSchema(queriesMeta) as oa.ReferenceObject
// the last segment after '/'
const paramSchemaName = paramSchema.$ref.split('/').pop() || ''
const currentSchema = schemas[paramSchemaName]

for (const [name, schema] of Object.entries(
currentSchema?.properties || {}
)) {
queries.push({
in: 'query',
name,
required: currentSchema.required?.includes(name),
schema,
})
}
}
route.params
.filter((p) => p.type === 'queries')
.forEach((queriesMeta) => {
const paramSchema = getParamSchema(queriesMeta) as oa.ReferenceObject
// the last segment after '/'
const paramSchemaName = paramSchema.$ref.split('/').pop() || ''
const currentSchema = schemas[paramSchemaName]

for (const [name, schema] of Object.entries(
currentSchema?.properties || {}
)) {
queries.push({
in: 'query',
name,
required: currentSchema.required?.includes(name) || false,
schema,
})
}
})
return queries
}

Expand Down