-
Notifications
You must be signed in to change notification settings - Fork 85
Add description for id and status field of the lifecycle spec #88
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add description for id and status field of the lifecycle spec #88
Conversation
Signed-off-by: Aljoscha Poertner <aljoscha.poertner@hellmann.com>
Signed-off-by: Aljoscha Poertner <aljoscha.poertner@hellmann.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: AljoschaP The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hi @AljoschaP. Thanks for your PR. I'm waiting for a aws-controllers-k8s member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @AljoschaP!
Unfortunately, all of these YAML files are actually auto-generated by controller-gen after it looks at the Go type definitions in the apis/v1alpha1 directory.
So, the next time the S3 controller is regenerated (which happens very often as new runtimes and aws-sdk-go's are released), the changes introduced in this PR would be overwritten.
If a field in a resource has an associated Documentation string in the API's documentation file (here is the S3 one: https://github.com/aws/aws-sdk-go/blob/main/models/apis/s3/2006-03-01/docs-2.json) then our code generation tooling should pick up that Documentation string. I will have to look into why these particular fields aren't getting any documentation inserted.
|
Hi @jaypipes :-) Thank you for the clarification! That makes a lot of sense 👍 Sorry for the noise 🤦♂️ Should I close the PR and create an issue instead? |
Hi @AljoschaP sorry for the late response! Yes, please do create a GH issue that explains the issue. Thank you! :) |
|
Corresponding issue: aws-controllers-k8s/community#1540 |
Issue #, if available: Not available
Description of changes:
In order to clarify the use of the id and status field of the lifecycle spec, this PR adds description fields to both.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.