Ignores additional properties by default #29
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
This adds a config field `ignoreAdditionalProperties` which is defaulted to `True`. When code gen encounters `additionalProperties: false`, we now ignore it or produce an error based on the value of that config field.
jbrechtel
approved these changes
Apr 9, 2024
qxjit
requested changes
Apr 9, 2024
| @@ -34,6 +34,7 @@ let | |||
| baseConfig = | |||
| { defaultTypeOptions = TypeOptions.default | |||
| , typeOptions = [] : List SpecificTypeOptions | |||
| , ignoreAdditionalProperties = True | |||
There was a problem hiding this comment.
I think the config name is misleading, and also it should not default to True. The default behavior for fleece should not be a setting that doesn't following the OpenAPI spec
There was a problem hiding this comment.
The name was changed to strictAdditionalProperties in 0b7d610.
| data MixedInAdditionalPropertiesFalse = MixedInAdditionalPropertiesFalse | ||
| { bar :: Maybe Bar.Bar | ||
| , foo :: Maybe Foo.Foo | ||
| , additionalProperties :: (Map.Map T.Text FC.AnyJSON) |
There was a problem hiding this comment.
We should not generate code to process additional properties for an item that has additionalProperties: false
There was a problem hiding this comment.
This was fixed in 0b7d610.
This modifies the previous commit to generate no code when the `additionalProperties` field is set to `false`. The relevavnt config field has been renamed to `strictAdditionalProperties`, with the value determining the behavior when the `additionalProperties` field is `false`: - `True`: We raise an error. - `False`: We ignore the field and generate no code for it.
qxjit
approved these changes
Apr 10, 2024
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.
This adds a config field
ignoreAdditionalPropertieswhich is defaulted toTrue. When code gen encountersadditionalProperties: false, we now ignore it or produce an error based on the value of that config field.