Support custom primitive type formats #66
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
McSym28
commented
Aug 6, 2024
Comment on lines
-384
to
+386
| defp render_return_type([], _type_overrides), do: quote(do: :ok) | ||
| defp render_return_type(_state, []), do: quote(do: :ok) |
There was a problem hiding this comment.
Sorry for going outside of this PR's limits, but shouldn't this clause check for the empty list on the second argument?
McSym28
commented
Aug 6, 2024
lib/open_api/processor/type.ex
Outdated
Comment on lines
12
to
13
| @type integer_format :: String.t() | ||
| @type number_format :: String.t() |
There was a problem hiding this comment.
I haven't decided whether to add all the Decided to add integer and number formats mentioned in the OpenAPI specification (for "symmetry" with string formats):
int32andint64forintegertypefloatanddoublefornumbertype
McSym28
commented
Aug 6, 2024
Comment on lines
+55
to
+59
| | {:boolean, boolean_format} | ||
| | :integer | ||
| | {:integer, integer_format} | ||
| | :number | ||
| | {:number, number_format} |
There was a problem hiding this comment.
Do we still need an atom-type or should we use :generic as a second tuple element as the "default" value?
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 PR allows processing of custom formats for primitive types (
boolean,integer,numberandstring). All non-nullformats will be stored in a tuple ({:string, "custom"}).Examples:
DD.MM.YYYYY/Nor1/0The new callback
OpenAPI.Renderer.render_type/2(with the default implementation inOpenAPI.Renderer.Util.to_type/2) is added to allow users to customize the formats' processing.