Skip to content
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

[DBInstance] Remove documentation for read only CertificateDetails property #536

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

angusy29
Copy link
Contributor

@angusy29 angusy29 commented May 9, 2024

Description of changes:

  • [DBInstance] Discovered the public documentation incorrectly displayed CertificateDetails as a property users can mutate, however CertificateDetails is just a readonly property

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link
Collaborator

@zrfr zrfr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The contents of the docs folders are automatically generated from the schema whenever "cfn generate" is run (this is done as part of the build).

It looks like it automatically omits read-only properties but not the parents of nested properties, like what we have here. Maybe this is more of a CFN issue? (https://github.com/aws-cloudformation/cloudformation-cli/blob/d030eea7c0e68b7ac6ad696f33e623afc85cb5a2/src/rpdk/core/project.py#L981-L985, https://github.com/aws-cloudformation/cloudformation-cli/blob/master/src/rpdk/core/templates/docs-readme.md)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants