fix: unintentional payload object mappings for checks and notification endpoints #630
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
- A nullable property requires a type. - If the property may use one or more subschemas with different types, make each subschema nullable.
- Removes unnecessary allOf. - Redundant allOf in discriminators causes some processors (Redoc and Redocly CLI) to create unintended implicit schema mappings. - For example, for PostCheck In Redoc, this generates the following possible request objects: - deadman - threshold - custom and, the unintended implicit objects: - Check - PostCheck
Contributor
Author
sanderson
approved these changes
Jan 20, 2023
Contributor
sanderson
left a comment
sanderson
left a comment
There was a problem hiding this comment.
LGTM. Thanks @jstirnaman!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
create unintended implicit schema mappings.
and, the unintended implicit objects:
Redoc before (current prod):
Redoc after:
This error from
@redocly/cli splitalerted me and helped me pinpoint the problem:/usr/local/lib/node_modules/@redocly/cli/lib/commands/split/index.js:167 const discriminatorPropSchema = obj.properties[obj.discriminator.propertyName]; ^ TypeError: Cannot read properties of undefined (reading 'type') at implicitlyReferenceDiscriminator (/usr/local/lib/node_modules/@redocly/cli/lib/commands/split/index.js:167:51)