Support oneOfs & anyOfs in operation request & response schema #701
+332
−67
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
lgarber-akamai
force-pushed
the
new/one-of-support
branch
from
c87efb9 to
0a04571
Compare
lgarber-akamai
changed the title
lgarber-akamai
commented
Dec 12, 2024
linodecli/baked/request.py
Outdated
Comment on lines
142
to
204
| v, | ||
| prefix=pref, | ||
| parent=parent, | ||
| # NOTE: We do not increment the depth because dicts do not have | ||
| # parent arguments. | ||
| depth=depth, | ||
| ) | ||
| elif ( | ||
| v.type == "array" | ||
| and v.items | ||
| and v.items.type == "object" | ||
| and v.extensions.get("linode-cli-format") != "json" | ||
| ): | ||
| # handle lists of objects as a special case, where each property | ||
| # of the object in the list is its own argument | ||
| pref = prefix + "." + k if prefix else k | ||
|
|
||
| # Support specifying this list as JSON | ||
| args.append( | ||
| OpenAPIRequestArg( | ||
| k, | ||
| v.items, | ||
| False, | ||
| prefix=prefix, | ||
| is_parent=True, | ||
| parent=parent, | ||
| # NOTE: We do not increment the depth because dicts do not have | ||
| # parent arguments. | ||
| depth=depth, | ||
| ) | ||
| elif ( | ||
| v.type == "array" | ||
| and v.items | ||
| and v.items.type == "object" | ||
| and v.extensions.get("linode-cli-format") != "json" | ||
| ): | ||
| # handle lists of objects as a special case, where each property | ||
| # of the object in the list is its own argument | ||
| pref = prefix + "." + k if prefix else k | ||
|
|
||
| # Support specifying this list as JSON | ||
| args.append( | ||
| OpenAPIRequestArg( | ||
| k, | ||
| v.items, | ||
| False, | ||
| prefix=prefix, | ||
| is_parent=True, | ||
| parent=parent, | ||
| depth=depth, | ||
| ) | ||
| ) | ||
| ) | ||
|
|
||
| args += _parse_request_model( | ||
| v.items, | ||
| prefix=pref, | ||
| parent=pref, | ||
| depth=depth + 1, | ||
| ) | ||
| else: | ||
| # required fields are defined in the schema above the property, so | ||
| # we have to check here if required fields are defined/if this key | ||
| # is among them and pass it into the OpenAPIRequestArg class. | ||
| required = False | ||
| if schema.required: | ||
| required = k in schema.required | ||
| args.append( | ||
| OpenAPIRequestArg( | ||
| k, | ||
| v, | ||
| required, | ||
| prefix=prefix, | ||
| parent=parent, | ||
| depth=depth, | ||
| ) | ||
| args += _parse_request_model( | ||
| v.items, | ||
| prefix=pref, | ||
| parent=pref, | ||
| depth=depth + 1, | ||
| ) | ||
| else: | ||
| # required fields are defined in the schema above the property, so | ||
| # we have to check here if required fields are defined/if this key | ||
| # is among them and pass it into the OpenAPIRequestArg class. | ||
| required = False | ||
| if schema.required: | ||
| required = k in schema.required | ||
| args.append( | ||
| OpenAPIRequestArg( | ||
| k, | ||
| v, | ||
| required, | ||
| prefix=prefix, | ||
| parent=parent, | ||
| depth=depth, | ||
| ) | ||
| ) | ||
|
|
There was a problem hiding this comment.
This logic is all the same, I just replaced the wrapping if statement with a guard clause
lgarber-akamai
changed the title
lgarber-akamai
requested review from
jriddle-linode and
zliang-akamai
and removed request for
a team
lgarber-akamai
commented
Dec 12, 2024
| if ( | ||
| v.type == "object" | ||
| and not v.readOnly | ||
| and len(_aggregate_schema_properties(v)[0]) > 0 |
There was a problem hiding this comment.
This is necessary to account for nested anyOfs and oneOfs.
lgarber-akamai
changed the title
jriddle-linode
approved these changes
Dec 13, 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.
📝 Description
This pull request adds support for parsing OpenAPI oneOfs and anyOfs in both the request and response schema for operations.
Additionally, this PR adds support for rendering each root-level request oneOf separate section in the generated command help pages.
✔️ How to Test
The following test steps assume you have pulled down this pull request locally and run the following command:
make SPEC='https://gist.githubusercontent.com/lgarber-akamai/07485a643e8329a5c16bec775e8066c4/raw/56f4491ba6e239c9cad736f05ff2d1ab0608098c/openapi.json' installNOTE: The overridden specification is necessary because the currently published OpenAPI specification does not yet make use of oneOfs.
Unit Testing
Integration Testing
Manual Testing
nodebalancers config-createcommand:MYIDHEREwith the ID of the newly created NodeBalancer:📷 Preview
Improved Help Page