Skip to content

fix: remove defs when ref already defined in schema #888

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

Merged
gurgunday merged 2 commits into from
Sep 25, 2025
Merged

fix: remove defs when ref already defined in schema #888

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
e59c632
Fix: Remove defs when ref already defined
cyky Jul 10, 2025
2d8d57b
Remove sibling keys if $refs exists
cyky Jul 14, 2025
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
7 changes: 7 additions & 0 deletions lib/spec/openapi/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,6 +515,13 @@ function convertJsonSchemaToOpenapi3 (jsonSchema) {

const openapiSchema = { ...jsonSchema }

if (Object.hasOwn(openapiSchema, '$ref') && Object.keys(openapiSchema).length !== 1) {
for (const key of Object.keys(openapiSchema).filter(k => k !== '$ref')) {
delete openapiSchema[key]
continue
}
}

for (const key of Object.keys(openapiSchema)) {
const value = openapiSchema[key]

Expand Down
132 changes: 132 additions & 0 deletions test/spec/openapi/refs.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,3 +430,135 @@ test('support $ref in callbacks', async (t) => {

await Swagger.validate(openapiObject)
})

test('should return only ref if defs and ref is defined', async (t) => {
const fastify = Fastify()
await fastify.register(fastifySwagger, { openapi: { openapi: '3.1.0' } })

fastify.addSchema({
$id: 'sharedSchema',
humanModule: {
$defs: {
AddressSchema: {
type: 'object',
properties: {
street: {
type: 'string',
},
streetNumber: {
type: 'number',
},
},
required: [
'street',
'streetNumber',
],
$id: 'AddressSchema',
},
PersonSchema: {
type: 'object',
properties: {
name: {
type: 'string',
},
homeAddress: {
$ref: 'AddressSchema',
},
workAddress: {
$ref: 'AddressSchema',
},
},
required: [
'name',
'homeAddress',
'workAddress',
],
$id: 'PersonSchema',
},
PostRequestSchema: {
type: 'object',
properties: {
person: {
$ref: 'PersonSchema',
},
},
required: [
'person',
],
$id: 'PostRequestSchema',
},
},
},
})
fastify.get('/person', {
schema: {
response: {
200:
{
$defs: {
AddressSchema: {
type: 'object',
properties: {
street: {
type: 'string',
},
streetNumber: {
type: 'number',
},
},
required: [
'street',
'streetNumber',
],
$id: 'AddressSchema',
},
PersonSchema: {
type: 'object',
properties: {
name: {
type: 'string',
},
homeAddress: {
$ref: 'AddressSchema',
},
workAddress: {
$ref: 'AddressSchema',
},
},
required: [
'name',
'homeAddress',
'workAddress',
],
$id: 'PersonSchema',
},
PostRequestSchema: {
type: 'object',
properties: {
person: {
$ref: 'PersonSchema',
},
},
required: [
'person',
],
$id: 'PostRequestSchema',
},
},
$ref: 'PersonSchema',
}
}
},
}, async () => ({ result: 'OK' }))

await fastify.ready()

const openapiObject = fastify.swagger()

t.assert.strictEqual(typeof openapiObject, 'object')

const expectedPathContent = { 'application/json': { schema: { $ref: '#/components/schemas/def-2' } } }
t.assert.deepStrictEqual(openapiObject.paths['/person'].get.responses[200].content, expectedPathContent)

await Swagger.validate(openapiObject)
})
Loading