confluent cli description update #8786
Conversation
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
|
Hi @alluri02, |
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
|
The git hooks are available for azure-cli and azure-cli-extensions repos. They could help you run required checks before creating the PR. Please sync the latest code with latest dev branch (for azure-cli) or main branch (for azure-cli-extensions). pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>
|
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Confluent CLI command descriptions and improves the parameter validation logic for various organization operations. Key changes include updated docstrings for better clarity, adjustments to argument definitions (such as the email regex pattern and resource group options), and renaming internal classes in the list command to more accurately reflect their purpose.
Reviewed Changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/confluent/azext_confluent/aaz/latest/confluent/organization/access/default/_list_cluster.py | Updated command description for listing clusters |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/access/__cmd_group.py | Updated command group registration and description |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_wait.py | Added read_only flag to a schema property |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_update.py | Updated command description, removed redundant resource group options, adjusted email regex escaping, and added read_only flag |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_show.py | Improved docstring and set read_only flag |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_list_users.py, _list_service_accounts.py, _list_role_binding.py | Updated descriptions for listing details |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_list_region.py | Added new command for listing supported regions |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_list.py | Updated list command logic and renamed inner classes to align endpoints with conditions |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/_delete.py, _create_user.py, _create_role_binding.py, _create.py | Updated descriptions and argument formats |
| src/confluent/azext_confluent/aaz/latest/confluent/organization/init.py, __cmd_group.py | Updated init imports and command group description |
| src/confluent/HISTORY.rst | Bumped version and added CLI description update history |
Comments suppressed due to low confidence (1)
src/confluent/azext_confluent/aaz/latest/confluent/organization/_update.py:170
- The updated email regex pattern now uses proper escaping; please ensure this pattern fully meets your email validation requirements in production scenarios.
pattern="^\\S+@\\S+\\.\\S+$",
| return cls._args_schema | ||
|
|
||
| def _execute_operations(self): | ||
| self.pre_operations() | ||
| condition_0 = has_value(self.ctx.args.resource_group) and has_value(self.ctx.subscription_id) | ||
| condition_1 = has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True | ||
| condition_0 = has_value(self.ctx.subscription_id) and has_value(self.ctx.args.resource_group) is not True |
There was a problem hiding this comment.
The logic for determining which inner class to invoke (i.e. OrganizationListBySubscription versus OrganizationListByResourceGroup) relies on dividing conditions in a non-obvious way. Consider refactoring or adding inline comments to clarify the intent and ensure that each endpoint URL aligns with the corresponding condition.
Copilot uses AI. Check for mistakes.
CodeGen Tools Feedback CollectionThank you for using our CodeGen tool. We value your feedback, and we would like to know how we can improve our product. Please take a few minutes to fill our codegen survey |
|
github-actions
bot
added
the
release-version-block
| @@ -2,6 +2,10 @@ | |||
|
|
|||
| Release History | |||
| =============== | |||
| 0.7.0 | |||
as per the reviewer suggestion Co-authored-by: AllyW <[email protected]>
github-actions
bot
removed
the
release-version-block
This checklist is used to make sure that common guidelines for a pull request are followed.
Related command
General Guidelines
azdev style <YOUR_EXT>locally? (pip install azdevrequired)python scripts/ci/test_index.py -qlocally? (pip install wheel==0.30.0required)For new extensions:
About Extension Publish
There is a pipeline to automatically build, upload and publish extension wheels.
Once your pull request is merged into main branch, a new pull request will be created to update
src/index.jsonautomatically.You only need to update the version information in file setup.py and historical information in file HISTORY.rst in your PR but do not modify
src/index.json.