Polyfill IJsonSchema.examples
#172
Merged
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
Even though JSON schema's `examples` property must be `Record<string, any>` type, too much people and frameworks are filling the property with array value. Considering the specification, this PR is not proper, but as industry players are following the specification, I've determined to allow for the compatibility.
samchon
added
documentation
There was a problem hiding this comment.
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Files not reviewed (1)
- package.json: Language not supported
Comments suppressed due to low confidence (2)
src/converters/OpenApiV3_1Emender.ts:283
- [nitpick] The conversion uses a key prefix 'e' for examples; consider using a more descriptive and consistent prefix that aligns with similar conversions elsewhere.
examples: Array.isArray(input.examples)
src/converters/OpenApiV3Upgrader.ts:261
- [nitpick] The new conversion uses a key prefix 'v' for examples; it would be beneficial to standardize the key prefix across converters to maintain consistency.
examples: input.examples,
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.
Even though JSON schema's
examplesproperty must beRecord<string, any>type, too much people and frameworks are filling the property with array value.Considering the specification, this PR is not proper, but as industry players are following the specification, I've determined to allow for the compatibility.