Example S3 code is invalid.

Open Beginner friendly
#1,420 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
java
Domain
documentation

Research direction

Start with themes/default/content/registry/packages/aws/api-docs/s3/bucketpolicy/_index.md and inspect the Java S3 bucket policy example. Verify the argument type and redundant applyValue usage against the surrounding API documentation, then confirm the corrected example compiles.

Written by the indexing model from the issue text.

Description

area/codegen area/docs kind/bug

File: themes/default/content/registry/packages/aws/api-docs/s3/bucketpolicy/_index.md

The example provided for S3 bucket policy in Java is invalid. GetPolicyDocumentStatementArgs does not accept a List of Output<String> (List<Output<String>>) as the example implies. Instead it accepts Output<List<String>>. Current solution cannot be used at all, since it won't compile.

.applyValue(getPolicyDocumentResult -> getPolicyDocumentResult) is redundant. It does not mutate or does anything to the value itself.

Dominant language
Java
Stars
85
Forks
26
Avg merge
11h 49m
Merged PRs (30d)
22

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pulumi/pulumi-java

All issues in pulumi/pulumi-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.