[s3-controller] Improve description for id and status field of the bucket lifecycle spec

[aljoshare]

What is the URL of the document?

https://aws-controllers-k8s.github.io/community/reference/s3/v1alpha1/bucket/#spec

Which section(s) is the issue in?

• lifecycle.rules.[].status
• lifecycle.rules.[].id

What needs fixing?

• lifecycle.rules.[].status
  This field is described as optional but in fact its mandatory and needs to be set to Enabled or Disabled. As a user I would like to know thats its a mandatory field and that I need to set it to Enabled if I want the rule to be considered.

Possible description:

Whether the rule is active or inactive. Must be set to Enabled or Disabled.

• lifecycle.rules.[].id
  Its not clear that the id is the name of the rule inside the AWS console and that its auto-generated if I omit it.

Possible description:

Optional unique identifier of the rule.
Must be a value no longer than 255 characters.
If you don't provide one, Amazon S3 will assign an ID.

Additional context

I tried to create a PR (aws-controllers-k8s/s3-controller#88) but missed the auto-generation. @jaypipes was so kind to explain it to me and here is the corresponding issue :-)

[ack-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/lifecycle stale

[aljoshare]

/remove-lifecycle stale

[ack-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
If this issue is safe to close now please do so with /close.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/lifecycle stale

[RedbackThomson]

With the release of the custom documentation configuration, this should be simple to add: aws-controllers-k8s/code-generator#447

[ack-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
If this issue is safe to close now please do so with /close.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/lifecycle rotten

[ack-bot]

Rotten issues close after 60d of inactivity.
Reopen the issue with /reopen.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/close

[ack-prow]

@ack-bot: Closing this issue.

In response to this:

Rotten issues close after 60d of inactivity.
Reopen the issue with /reopen.
Provide feedback via https://github.com/aws-controllers-k8s/community.
/close

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.