Skip to content

fix(docs): mark --public-key-remote and --public-keys as deprecated in kas-registry docs#791

Open
marythought wants to merge 1 commit intomainfrom
fix/257-deprecate-public-key-remote
Open

fix(docs): mark --public-key-remote and --public-keys as deprecated in kas-registry docs#791
marythought wants to merge 1 commit intomainfrom
fix/257-deprecate-public-key-remote

Conversation

@marythought
Copy link
Copy Markdown

Summary

  • Add :::warning deprecation callouts to both kas-registry create and kas-registry update doc pages directing users to the new kas-registry key commands
  • Mark --public-keys and --public-key-remote flags as deprecated in the update command's flag descriptions (create already had this)
  • Remove --public-key-remote from the update example command
  • Update update page description to remove "key material (remote/cached)" since that's now handled by kas-registry key

Addresses opentdf/docs#257

Test plan

  • Verify the deprecation warnings render correctly when the docs site builds
  • Confirm the updated example for kas-registry update works without deprecated flags

🤖 Generated with Claude Code

…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>
@marythought marythought requested a review from a team as a code owner April 3, 2026 00:53
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 3, 2026

Warning

Rate limit exceeded

@marythought has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 13 minutes and 1 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d22407ee-e26a-49dc-bb38-292259e86de5

📥 Commits

Reviewing files that changed from the base of the PR and between 2d8a147 and b52403a.

📒 Files selected for processing (2)
  • docs/man/policy/kas-registry/create.md
  • docs/man/policy/kas-registry/update.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/257-deprecate-public-key-remote

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant