Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion opapi/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bpinternal/opapi",
"version": "0.18.0",
"version": "0.18.1",
"description": "Opapi is a highly opinionated library to generate server, client and documentation from OpenAPI specification using typescript.",
"main": "./dist/index.js",
"module": "./dist/index.mjs",
Expand Down
2 changes: 1 addition & 1 deletion opapi/src/opapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ function exportClient(state: State<string, string, string>) {
options = propsOrEndpoint
}

state = applyExportOptions(state, postProcessorsAndStateOpts)
state = applyExportOptions(state, options)

if (options.generator === 'openapi-generator') {
return generateClientWithOpenapiGenerator(state, dir, options.endpoint, options.postProcessors)
Expand Down
8 changes: 8 additions & 0 deletions opapi/test/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ export const getMockApi = () => {
type: 'FooNotFound',
},
],
defaultParameters: {
xFoo: {
in: 'header',
description: 'Foo',
type: 'string',
required: true,
},
},
metadata: {
title: 'Test API',
description: 'Test API',
Expand Down
32 changes: 31 additions & 1 deletion opapi/test/client.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
import { describe, it } from 'vitest'
import { describe, expect, it } from 'vitest'
import { getMockApi } from './api'
import { join } from 'path'
import { getFiles } from '../src/file'
import { validateTypescriptFile } from './util'
import fs from 'node:fs'

describe('client generator', () => {
it('should be able to generate a client with openapi-generator', async () => {
Expand Down Expand Up @@ -38,4 +39,33 @@ describe('client generator', () => {
}
})
})

it('should not include defaultParameters when ignoreDefaultParameters: true', async () => {
const genClientFolder = join(__dirname, 'gen/client-opapi-no-default')

const api = getMockApi()

await api.exportClient(genClientFolder, {
generator: 'opapi',
ignoreDefaultParameters: true,
})

const files = getFiles(genClientFolder)

files.forEach((file) => {
if (file.endsWith('.ts')) {
validateTypescriptFile(file)
}
})
await Promise.all(
files
.filter((file) => file.includes('operations'))
.map(async (file) => {
const content = fs.readFileSync(file, { encoding: 'utf8' })
if (content.includes('xFoo')) {
throw new Error(`'xFoo' parameter should not be included in ${file}`)
}
}),
)
})
})