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

Property notes sometimes get attached to the wrong property #1693

Open
Tracked by #3906
sean1588 opened this issue Feb 15, 2024 · 5 comments
Open
Tracked by #3906

Property notes sometimes get attached to the wrong property #1693

sean1588 opened this issue Feb 15, 2024 · 5 comments
Labels
area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/bug Some behavior is incorrect or out of spec

Comments

@sean1588
Copy link
Member

sean1588 commented Feb 15, 2024

Sometime property notes get attached to the wrong property. See accelerationStatus and objectLockConfiguration, it seems the note belongs under accelerationStatus. https://www.pulumi.com/registry/packages/aws/api-docs/s3/bucket/#inputs.

Screen Shot 2024-02-21 at 10 57 02 AM
@github-actions github-actions bot added the needs-triage Needs attention from the triage team label Feb 15, 2024
@sean1588 sean1588 added kind/bug Some behavior is incorrect or out of spec and removed needs-triage Needs attention from the triage team labels Feb 15, 2024
@sean1588
Copy link
Member Author

sean1588 commented Feb 20, 2024

It looks like this is may be an issue with the way the bridge is converting things. The note is attached to the wrong property in the schema itself.

"objectLockConfiguration": {
     "$ref": "#/types/aws:s3/BucketObjectLockConfiguration:BucketObjectLockConfiguration",
         "description": "A configuration of [S3 object locking](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html) (documented below)\n\n\u003e **NOTE:** You cannot use `acceleration_status` in `cn-north-1` or `us-gov-west-1`\n"

@cnunciato
Copy link

@sean1588 Should we transfer to terraform-bridge?

@sean1588
Copy link
Member Author

yeah makes sense to transfer it there.

@sean1588 sean1588 transferred this issue from pulumi/registry Feb 21, 2024
@interurban interurban added the area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen label Feb 21, 2024
@sean1588 sean1588 added this to the 0.101 milestone Feb 21, 2024
@sean1588 sean1588 modified the milestones: 0.101, 0.102 Mar 8, 2024
@sean1588 sean1588 modified the milestones: 0.102, 0.103 Apr 8, 2024
@mikhailshilkov mikhailshilkov removed this from the 0.103 milestone Jun 5, 2024
@thoward
Copy link

thoward commented Sep 25, 2024

A related issue #5479 came in regarding a very similar type of rendering failure in this doc: https://www.pulumi.com/registry/packages/aws/api-docs/ec2/networkaclrule/#icmp_code_python ... The notes that are intended to be after the Input properties list are actually getting embedded inside of the icmp_code property description, which is very confusing to readers.

@thoward
Copy link

thoward commented Oct 17, 2024

Another customer reported issue came in that seems similar, though not exactly the same. In this case, the markdown here: https://github.com/hashicorp/terraform-provider-aws/blob/main/website/docs/d/cognito_user_pool.html.markdown?plain=1#L33 ... is dragging three bullet points into a single attribute, likely because they don't follow the same format of:

`attribute_name` - description

You can see this here:

https://www.pulumi.com/registry/packages/aws/api-docs/cognito/getuserpool/#arn_python

these should be three separate attributes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docsgen Issues with docs capture or example rendering, historically part of pkg/tfgen kind/bug Some behavior is incorrect or out of spec
Projects
None yet
Development

No branches or pull requests

5 participants