Add support for OpenAPI 3.1 nullable patterns in time field validation#79
Closed
jonchun wants to merge 2 commits intoaep-dev:mainfrom
Closed
Add support for OpenAPI 3.1 nullable patterns in time field validation#79jonchun wants to merge 2 commits intoaep-dev:mainfrom
jonchun wants to merge 2 commits intoaep-dev:mainfrom
Conversation
Contributor
Author
|
Re-opening #71 from a proper branch. @toumorokoshi @mkistler |
Contributor
|
It's not clear to me that we want to allow nullable date/time fields in AEP compliant APIs. I don't see any mention of "null" in AEP 142 currently. If we intend "null" to be meaningful in date/time fields, I think the AEP should state that explicitly. |
Contributor
Author
|
That's a fair point. I do think that AEP-142 is a bit too strict then, but that's to be taken up with AEP. Workaround is clearly documented for anyone who has the same issue I did: |
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
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.
Related to #21: The aep-142-time-field-type rule fails to validate nullable timestamp fields in OpenAPI 3.1 specs.
In OAS 3.1, nullable fields are represented using anyOf with a null type. e.g.
The current validation checks field.type directly, which is undefined for anyOf structures. This causes false positives for valid nullable _time fields. (such as a
delete_timefield for soft-deletes)