feat: add discriminator tag to generate if-then schemas
#1376
Conversation
This tag allows for generating if-then, in favor of anyOf clauses.
There was a problem hiding this comment.
Thank you for the pull request. I am honestly still a bit suspicious of the utility of this feature but it looks like the code changes are localized so I'm okay with accepting it.
Can you add a test to cover the remaining lines in this patch that are not covered yet? Also, please add an issue for the bug you found.
| @@ -15,11 +17,51 @@ export class UnionTypeFormatter implements SubTypeFormatter { | |||
| return type instanceof UnionType; | |||
| } | |||
| public getDefinition(type: UnionType): Definition { | |||
| // FIXME: Filtering never types from union types is wrong. However, | |||
There was a problem hiding this comment.
Can you file an issue for this? A fixme in the code here is too easy to overlook.
There was a problem hiding this comment.
I was incorrect, filtering never types from unions is valid. However, I thought this statement would be superfluous as never types are filtered upon construction of the union. Apparently, this is not always the case, as the hidden tests point out.
|
I have removed the line that wasn't tested as it turned out it was unreachable. The FIXME has also been removed, as it was incorrect. |
|
🚀 PR was released in |
github-actions
bot
added
released
Fixes #1209
This pr adds the ability to select a common property in a union type to act as a discriminator. This is done by specifying the desired property key using the
discriminatortag. For an example, see the tagged issue or a supplied test case. Note that each of the constituent types should contain this key. A possible next step would be to allow each of the constituent types to define a separate discriminator. Thediscriminatortag would then not be applied to the union definition, but to the separate object definitions.