-
Notifications
You must be signed in to change notification settings - Fork 1.4k
updated the description of the neon cli command description to support the az mcp #8775
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
updated the description of the neon cli command description to support the az mcp #8775
Conversation
❌Azure CLI Extensions Breaking Change Test
|
Hi @alluri02, |
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>
|
Thank you for your contribution! We will review the pull request and get back to you soon. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the Neon CLI command descriptions, help strings, API version values, and internal helper method names for consistency and clarity. Key changes include:
- Revised help messages and command examples across multiple command modules.
- Renaming of internal helper methods (e.g. from _build_schema_models_attributes_read to _build_schema_attributes_read) and updates to URL path segments (e.g. “computes” to “endpoints”).
- Updates to API version strings in several commands to reflect current service expectations.
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated no comments.
File | Description |
---|---|
src/neon/azext_neon/aaz/latest/neon/postgres/project/_list.py | Removed the preview flag and updated help text for organization name. |
src/neon/azext_neon/aaz/latest/neon/postgres/endpoint/_list.py | Changed URL path segment from “computes” to “endpoints” and updated help text accordingly. |
src/neon/azext_neon/aaz/latest/neon/postgres/organization/_wait.py | Updated API version string and help message for resource group name. |
src/neon/azext_neon/aaz/latest/neon/postgres/branch/_update.py | Refactored internal helper method names and updated documentation comments. |
Comments suppressed due to low confidence (4)
src/neon/azext_neon/aaz/latest/neon/postgres/project/_list.py:15
- Confirm that the removal of the preview flag aligns with the intended release phase for this command.
- is_preview=True,
src/neon/azext_neon/aaz/latest/neon/postgres/endpoint/_list.py:112
- Ensure that the change from 'computes' to 'endpoints' in the URL is reflected in all related command groups and documentation.
- "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Neon.Postgres/organizations/{organizationName}/projects/{projectName}/branches/{branchName}/computes",
src/neon/azext_neon/aaz/latest/neon/postgres/organization/_wait.py:23
- Verify that updating the API version to '2024-08-01-preview' is consistent with the service's current expectations across all endpoints.
- ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/neon.postgres/organizations/{}", "2025-03-01"],
src/neon/azext_neon/aaz/latest/neon/postgres/branch/_update.py:432
- [nitpick] The refactored helper method name is more concise; ensure that related documentation and tests reference the updated name.
def _build_schema_attributes_read(cls, _schema):
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 |
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request updates the CLI command descriptions and help texts across Neon Postgres commands to align with the updated mnemonics and language conventions. Key changes include:
- Concise and consistent help texts for organization, project, branch, and related resource arguments.
- Renaming of helper methods (e.g. replacing _build_schema_models_attributes_read with _build_schema_attributes_read) to improve clarity and consistency.
- Updates to command and parameter naming (e.g. using “project-name” instead of “project-id” in selected commands) for improved uniformity.
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
src/neon/azext_neon/aaz/latest/neon/postgres/project/_list.py | Updated help messages and refactored schema helper method calls. |
src/neon/azext_neon/aaz/latest/neon/postgres/project/_get_connection_uri.py | Revised help texts for Neon organization and project arguments. |
src/neon/azext_neon/aaz/latest/neon/postgres/project/_delete.py | Simplified and standardized the help descriptions. |
src/neon/azext_neon/aaz/latest/neon/postgres/project/_create.py | Updated command descriptions and refactored helper method names for better clarity. |
src/neon/azext_neon/aaz/latest/neon/postgres/organization/* | Updates include revised API versions, help messages, examples, and helper method renamings. |
src/neon/azext_neon/aaz/latest/neon/postgres/neon_role/, neon_database/, endpoint/, branch/ | Consistent parameter naming and standardized help texts across listing, delete, create, update, and wait commands. |
src/neon/azext_neon/aaz/latest/neon/postgres/__cmd_group.py | Updated the command group description to reflect the resource scope. |
Comments suppressed due to low confidence (2)
src/neon/azext_neon/aaz/latest/neon/postgres/endpoint/_list.py:136
- Ensure that the project argument naming is consistent across commands. If other parts of the CLI refer to the project identifier using '--project-id', consider aligning the parameter naming for uniformity.
"projectName", self.ctx.args.project_name,
src/neon/azext_neon/aaz/latest/neon/postgres/branch/_update.py:52
- [nitpick] Review the help text for the branch argument to confirm that it communicates whether this parameter expects an identifier or a display name, ensuring consistency across all branch commands.
help="Name of the Neon branch."
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
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 azdev
required)python scripts/ci/test_index.py -q
locally? (pip install wheel==0.30.0
required)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.json
automatically.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
.