Enable OpenAPI definitions to reflect field renaming #49
Conversation
This file contains 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
IodizedGabe
commented
Nov 19, 2021
| @@ -156,6 +156,9 @@ Object { | |||
| "format": "uuid", | |||
| "type": "string", | |||
| }, | |||
| "string_value_with_different_wire_name": Object { | |||
There was a problem hiding this comment.
OpenAPI definition reflects the wire name.
IodizedGabe
commented
Nov 19, 2021
| @@ -211,6 +211,11 @@ export function createFixtures(flavor: Flavor): Fixture { | |||
| nullable: true, | |||
| }) | |||
| nullableUUIDValue!: string | null; | |||
|
|
|||
| @IsString({ | |||
| name: 'string_value_with_different_wire_name', | |||
There was a problem hiding this comment.
Opted to make this required in testing to ensure that we can always validate that it was converted correctly.
IodizedGabe
commented
Nov 19, 2021
| @@ -54,11 +54,13 @@ describe('flavors.basic', () => { | |||
| nullableNestedValue: { | |||
| nullableStringValue: 'nested', | |||
| }, | |||
| // NB: This field is not transformed (b/c @Expose() is not included) | |||
| string_value_with_different_wire_name: 'value', | |||
There was a problem hiding this comment.
Notice me: I'm assuming the exclusion of expose on DecoratorOptions was intentional, meaning that this now adds a new (expected) issue.
There was a problem hiding this comment.
Yeah, the basic flavor omits the @Expose decorator because we used to have a scenario in pod where that behavior broke things.
jessemyers
approved these changes
Nov 19, 2021
IodizedGabe
force-pushed
the
feature/allow-external-name-exposure
branch
from
039667b
to
4adab0e
Compare
Further support to allow DTO types to retain the expected field naming convention, but expose a different name over its API.
IodizedGabe
force-pushed
the
feature/allow-external-name-exposure
branch
from
4adab0e
to
750a0e8
Compare
adrian-hippo
approved these changes
Nov 19, 2021
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.
Further support to allow DTO types to retain the expected field naming
convention, but expose a different name over its API.