Add fallback to ShapeRef documentation when Shape.Documenation is empty#682
Add fallback to ShapeRef documentation when Shape.Documenation is empty#682knottnt wants to merge 1 commit intoaws-controllers-k8s:mainfrom
Conversation
- Update Attr type to include ShapeRef property - Add Attr.Documentation() func to handle fallback to ShapeRef.Documentation if Shape.Documentation is unavailable - Update type_def.go.tpl to use new Attr.Documentation() func
|
Example PR showing changes applied to a controller. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: a-hilaly, knottnt, michaelhtm The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/retest |
|
/test s3-controller-test |
1 similar comment
|
/test s3-controller-test |
|
/retest |
2 similar comments
|
/retest |
|
/retest |
|
@knottnt: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here. |
3 participants
Issue #, if available:
Description of changes:
Primitive fields (string, integer, boolean, etc) fields that were nested in an object didn't have their CRD descriptions populated with the contents to their API shape's
#documentationtrait. This was due the TypeDef Attrs using a generic primitive shape instead the member's ShapeRef. This PR adds a fallback to using ShapeRef.Documentation when Shape.Documentation.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.