fix(docs): mark --public-key-remote and --public-keys as deprecated in kas-registry docs#791
fix(docs): mark --public-key-remote and --public-keys as deprecated in kas-registry docs#791marythought wants to merge 1 commit intomainfrom
Conversation
…n kas-registry docs Add deprecation warnings to kas-registry create and update doc pages directing users to the new `kas-registry key` commands. Mark the --public-keys and --public-key-remote flags as deprecated in the update command's flag descriptions (create already had this). Remove the deprecated --public-key-remote flag from the update example. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Mary Dickson <mary.dickson@virtru.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 13 minutes and 1 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for kas-registry to mark the --public-keys and --public-key-remote flags as deprecated in both the create and update commands, directing users to the new otdfctl policy kas-registry key commands instead. The feedback suggests a minor formatting improvement to wrap the term name in backticks for consistency with other parameters in the documentation.
| --- | ||
|
|
||
| Update the `uri`, `metadata`, or key material (remote/cached) for a KAS registered to the platform. | ||
| Update the `uri`, `metadata`, or name for a KAS registered to the platform. |
There was a problem hiding this comment.
For consistency with the warning block added below and to follow standard documentation practices for technical terms (flags and parameters), the terms uri, metadata, and name should be wrapped in backticks.
| Update the `uri`, `metadata`, or name for a KAS registered to the platform. | |
| Update the `uri`, `metadata`, or `name` for a KAS registered to the platform. |
Summary
:::warningdeprecation callouts to bothkas-registry createandkas-registry updatedoc pages directing users to the newkas-registry keycommands--public-keysand--public-key-remoteflags as deprecated in theupdatecommand's flag descriptions (create already had this)--public-key-remotefrom theupdateexample commandupdatepage description to remove "key material (remote/cached)" since that's now handled bykas-registry keyAddresses opentdf/docs#257
Test plan
kas-registry updateworks without deprecated flags🤖 Generated with Claude Code