docs: hydra update oauth2-client updates only provided fields#2680
Conversation
The hydra update oauth2-client and ory update oauth2-client commands now send a partial update built from the flags that were set, instead of replacing the entire client. Update the CLI reference synopses and the OAuth2 clients guide accordingly: the flag-based examples move to the patch section, and the update (replace) section documents --file. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the Hydra and Ory CLI documentation to reflect the new behavior of hydra update oauth2-client / ory update oauth2-client: flag-based updates now perform a partial update (patch) affecting only provided fields, while full replacement is done via --file.
Changes:
- Updated both CLI reference pages’ synopsis text to describe partial updates via flags and full replacement via
--file. - Adjusted the OAuth2 clients guide to show
--fileunder “Update OAuth2 client” (full replacement) and moved the flag-based example to “Patch OAuth2 client”. - Added cross-reference from the “Update” CLI tab to the “Patch OAuth2 client” section.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/hydra/guides/oauth2-clients.mdx | Repositions CLI examples to align with “update = full replace via --file” vs “patch = flags”. |
| docs/hydra/cli/hydra-update-oauth2-client.md | Updates synopsis to document “flags patch; --file replaces”. |
| docs/cli/ory-update-oauth2-client.md | Updates synopsis to document “flags patch; --file replaces”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe OAuth2 client CLI documentation now distinguishes partial updates using flags from full replacement using ChangesOAuth2 client update semantics
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
The
hydra update oauth2-client(and, from Ory CLI v1.3.2,ory update oauth2-client) command now sends a partial update built from exactly the flags that were set, instead of replacing the entire client. Fields not passed as flags keep their current values; full replacement remains available via--file.This PR updates the documentation accordingly:
docs/hydra/cli/hydra-update-oauth2-client.md,docs/cli/ory-update-oauth2-client.md: new synopsis matching the updated command help text. These pages are auto-generated; the wording here matches what regeneration will produce from the new cobraLongtext.docs/hydra/guides/oauth2-clients.mdx: the flag-based CLI example moves to the "Patch OAuth2 client" section (which is what flags now do), and the "Update OAuth2 client" section documents--filefor full replacement.Code change: ory-corp/cloud (hydra), PR linked from there.
Related Issue or Design Document
Documentation improvement, no issue reference required. Related upstream request: ory/hydra#2020.
Checklist
🤖 Generated with Claude Code
Summary by CodeRabbit