fix(schema): place x-enumNames on enum schema instead of DTO property#3801
Open
maruthang wants to merge 1 commit intonestjs:masterfrom
Open
fix(schema): place x-enumNames on enum schema instead of DTO property#3801maruthang wants to merge 1 commit intonestjs:masterfrom
maruthang wants to merge 1 commit intonestjs:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #3391
Bug:
x-enumNames(anddescription) were incorrectly placed on the shared enum schema object rather than staying on the DTO property reference.Root Cause:
createEnumSchemaType()inSchemaObjectFactorycopieddescriptionfrom DTO property metadata onto the shared enum schema object. Sincedescriptionis per-property, not per-type, it causedx-enumNamesand description to bleed onto the wrong schema.Fix: Removed the single line
description: metadata.description ?? undefinedfrom the enum schema creation block increateEnumSchemaType().Changes
lib/services/schema-object-factory.ts: Removed erroneousdescriptioncopy from DTO property metadata into the shared enum schema objecte2e/api-spec.json: Updated E2E snapshot to reflect corrected schema (description no longer appears on enum schema)test/services/schema-object-factory.spec.ts: Added 3 regression tests verifying correct placement ofx-enumNames, thatdescriptionis not copied to enum schema, and thatx-enumNamesis placed correctly on a pre-existing enum schemaTesting
test/services/schema-object-factory.spec.tsthat verify correctx-enumNamesplacement and thatdescriptionis not copied to the enum schema