Skip to content

fix: parse HeaderParams as multiple params and not as a schema object #162

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

Closed
Juhbaldissera wants to merge 1 commit into from
Closed

fix: parse HeaderParams as multiple params and not as a schema object #162

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
12 changes: 8 additions & 4 deletions __tests__/fixtures/spec.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,11 +223,15 @@
"parameters": [
{
"in": "header",
"name": "ListUsersHeaderParams",
"name": "Authorization",
"required": true,
"schema": { "type": "string" }
},
{
"in": "header",
"name": "X-Correlation-ID",
"required": false,
"schema": {
"$ref": "#/components/schemas/ListUsersHeaderParams"
}
"schema": { "type": "string" }
},
{
"in": "query",
Expand Down
43 changes: 34 additions & 9 deletions __tests__/parameters.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,13 @@ describe('parameters', () => {
let schemas: { [p: string]: SchemaObject }

beforeAll(() => {
class ListUsersHeaderParams {}
class ListUsersHeaderParams {
@IsString()
deviceId: number

@IsString()
acceptLanguage: number
}

class ListUsersQueryParams {
@IsNumber()
Expand Down Expand Up @@ -199,20 +205,39 @@ describe('parameters', () => {
})

it('parses header param from @HeaderParam decorator', () => {
expect(getHeaderParams(route)[0]).toEqual({
expect(getHeaderParams(route, schemas)[0]).toEqual({
in: 'header',
name: 'Authorization',
required: true,
schema: { type: 'string' },
})
})

it('parses header param ref from @HeaderParams decorator', () => {
expect(getHeaderParams(route)[1]).toEqual({
in: 'header',
name: 'ListUsersHeaderParams',
required: false,
schema: { $ref: '#/components/schemas/ListUsersHeaderParams' },
})
it('parses header param ref from @HeaderParams decorator', () => { // here
expect(getHeaderParams(route, schemas)).toEqual([
// Authorization comes from @HeaderParam
{
in: 'header',
name: 'Authorization',
required: true,
schema: { type: 'string' },
},
{
in: 'header',
name: 'deviceId',
required: true,
schema: {
type: 'string'
}
},
{
in: 'header',
name: 'acceptLanguage',
required: true,
schema: {
type: 'string'
}
}
])
})
})
31 changes: 22 additions & 9 deletions src/generateSpec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export function getOperation(
const operation: oa.OperationObject = {
operationId: getOperationId(route),
parameters: [
...getHeaderParams(route),
...getHeaderParams(route, schemas),
...getPathParams(route),
...getQueryParams(route, schemas),
],
Expand Down Expand Up @@ -86,7 +86,10 @@ export function getPaths(
/**
* Return header parameters of given route.
*/
export function getHeaderParams(route: IRoute): oa.ParameterObject[] {
export function getHeaderParams(
route: IRoute,
schemas: { [p: string]: oa.SchemaObject | oa.ReferenceObject },
): oa.ParameterObject[] {
const headers: oa.ParameterObject[] = route.params
.filter((p) => p.type === 'header')
.map((headerMeta) => {
Expand All @@ -101,13 +104,23 @@ export function getHeaderParams(route: IRoute): oa.ParameterObject[] {

const headersMeta = route.params.find((p) => p.type === 'headers')
if (headersMeta) {
const schema = getParamSchema(headersMeta) as oa.ReferenceObject
headers.push({
in: 'header',
name: schema.$ref.split('/').pop() || '',
required: isRequired(headersMeta, route),
schema,
})
const paramSchema = getParamSchema(headersMeta) as oa.ReferenceObject
// the last segment after '/'
const paramSchemaName = paramSchema.$ref.split('/').pop() || ''
const currentSchema = schemas[paramSchemaName]

if (currentSchema && oa.isSchemaObject(currentSchema)) {
for (const [name, schema] of Object.entries(
currentSchema?.properties || {}
)) {
headers.push({
in: 'header',
name,
required: currentSchema.required?.includes(name),
schema,
})
}
}
}

return headers
Expand Down