Add required field validation to nested structures #9463
Conversation
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
false positives when the same field name appears at different levels with different requirement statuses.
hssyoo
requested changes
Apr 28, 2025
| doc.style.new_paragraph() | ||
| member_type_name = member_shape.type_name | ||
| if member_type_name == 'structure': | ||
| for sub_name, sub_shape in member_shape.members.items(): | ||
| sub_shape.parent = member_shape |
There was a problem hiding this comment.
I don't love that we're assigning an arbitrary instance attribute that's not defined by our model classes. I suspect that this is trying to avoid exposing a new required parameter to _do_doc_member, but I would prefer plumbing it over setting arbitrary attributes.
| @@ -289,10 +290,14 @@ def _do_doc_member(self, doc, member_name, member_shape, stack): | |||
| doc.include_doc_string(docs) | |||
| if is_tagged_union_type(member_shape): | |||
| self._add_tagged_union_note(member_shape, doc) | |||
| self._document_enums(member_shape, doc) | |||
| required = self._check_if_required(member_shape, member_name) | |||
| self._document_constraints(member_shape, doc, required=required) | |||
There was a problem hiding this comment.
I'm not sure it makes sense to couple the required field with constraints. Constraints define possible parameter values while required marks a parameter as required.
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.
Issue #, if available: CLI-6123
Description of changes:
Example:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.