aws / aws/aws-encryption-sdk-java
JavaDocs: Document replacement methods for MKP methods
- 主要语言
- Java
- 星标
- 240
- 派生
- 125
- PR 合并指标
- 30 天内没有已合并 PR
描述
### Issue
Crypto Tools marked all MasterKeyProvider methods as deprecated, but did not revise their JavaDocs to state which methods should be used instead.
This is a source of customer confusion, as it is not clear that customers should use the Keyring methods instead.
_As originally posted by @jumarko in https://github.com/aws/aws-encryption-sdk-java/pull/1864#discussion_r1665561054_
Are these deprecations documented anywhere?
The javadoc doesn't say anything about what should be used instead.
### Suggested Fix
Revise the Java Docs for the Master Key Providers so that they details which methods replace the marked as deprecated methods.
Either remove the deprecation notice from the Caching Cryptographic Materials Manager methods or [implement support for the CachingCMM with Keyrings](https://github.com/aws/aws-cryptographic-material-providers-library/issues/480).
#### Related Issues
- https://github.com/aws/aws-encryption-sdk-java/issues/2035
- https://github.com/aws/aws-encryption-sdk-java/issues/2033
贡献指南
调研方向
找到已弃用的 MasterKeyProvider 方法和 Caching Cryptographic Materials Manager 方法的 JavaDocs。阅读相关 issue 2035 和 2033,然后将已弃用的 API 与它们所引用的 Keyring 方法进行比较。完成的标准是:每个已弃用方法的替代方案都已记录,并且 Caching CMM 问题已得到解决或明确记录。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- java
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 42/100