Javadoc incorrect for DocumentTableSchema

[tkhill-AWS]

Describe the issue

The following appears in the introductory description of the Javadoc:

DocumentTableSchema specifying primaryKey, sortKey and a customAttributeConverter can be created as below

 DocumentTableSchema documentTableSchema = DocumentTableSchema.builder()
 .primaryKey("sampleHashKey", AttributeValueType.S)
 .sortKey("sampleSortKey", AttributeValueType.S)
 .attributeConverterProviders(customAttributeConverter, AttributeConverterProvider.defaultProvider())
 .build();

However, if you look at the DocumentTableSchema.Builder documentation, the method names are different:

• addIndexPartitionKey() (not primaryKey())
• addIndexSortKeyy() (not sortKey())

The description should be fixed to use the actual method names.

Links

DocumentTableSchema

[debora-ito]

Acknowledged. Thank you Todd!

[anuq]

I will work on this and submit a PR later.

[debora-ito]

Fixed via #4348.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.