Json2code: full $ref support #2452
Open
+24
−7
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
bashtanov
force-pushed
the
allow-ref-in-api
branch
from
abeca0c
to
d7a8500
Compare
Swagger only allows to refer to custom composite types via "$ref", not via "type", whether it is about array elements or individual items. Disallowing "type" would break existing use, so allow "$ref" to be used interchangeably. Signed-off-by: Alexey Bashtanov <[email protected]>
bashtanov
force-pushed
the
allow-ref-in-api
branch
from
d7a8500
to
0548195
Compare
bashtanov
added a commit
to bashtanov/redpanda
that referenced
this pull request
Sep 24, 2024
Swagger needs "$ref", while seastar only allows "type" (at least until scylladb/seastar#2452 is merged), so let's use both for now
|
@amnonh hi Amnon, could you take a look at this change as well? i plan to review it in this week. |
tchaikov
reviewed
Sep 28, 2024
Comment on lines
+373
to
+379
| try: | ||
| type = getitem(properties[var], "type", name + ":" + var) | ||
| except Exception as e: | ||
| try: | ||
| type = getitem(properties[var], "$ref", name + ":" + var) | ||
| except: | ||
| raise e |
There was a problem hiding this comment.
if $ref is the notation supported by swagger spec, probably we should check if first. and i'd suggest just use dict.get() . simpler this way. and we might want to define a tiny helper to avoid the repeating. like:
def get_referenced_type(schema, key)
# to be backward compatible, support "type" as well
type = schema.get("$ref") or schema.get("type")
if type is None:
raise KeyError("$ref")
return type
|
also, would be better to use the imperative mood in the title of commit message, in this case, could use something like:
|
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.
Swagger only allows to refer to custom composite types via "$ref", not via "type", whether it is about array elements or individual items.
Disallowing "type" would break existing use, so allow "$ref" to be used interchangeably.