Skip to content

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

alluri02
Copy link
Member

@alluri02 alluri02 commented May 21, 2025


This checklist is used to make sure that common guidelines for a pull request are followed.

Related command

General Guidelines

  • Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
  • Have you run python scripts/ci/test_index.py -q locally? (pip install wheel==0.30.0 required)
  • My extension version conforms to the Extension version schema

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.

@Copilot Copilot AI review requested due to automatic review settings May 21, 2025 13:31
Copy link

azure-client-tools-bot-prd bot commented May 21, 2025

❌Azure CLI Extensions Breaking Change Test
❌neon
rule cmd_name rule_message suggest_message
1012 - SubgroupRemove neon postgres compute sub group neon postgres compute removed please confirm sub group neon postgres compute removed
1007 - ParaRemove neon postgres organization update cmd neon postgres organization update removed parameter marketplace_details please add back parameter marketplace_details for cmd neon postgres organization update
⚠️ 1008 - ParaPropAdd neon postgres branch create cmd neon postgres branch create update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres branch delete cmd neon postgres branch delete update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres branch list cmd neon postgres branch list update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres branch show cmd neon postgres branch show update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres branch update cmd neon postgres branch update update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres branch wait cmd neon postgres branch wait update parameter organization_name: added property nargs=?
⚠️ 1011 - SubgroupAdd neon postgres endpoint sub group neon postgres endpoint added
⚠️ 1008 - ParaPropAdd neon postgres neon-database list cmd neon postgres neon-database list update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres neon-role list cmd neon postgres neon-role list update parameter organization_name: added property nargs=?
⚠️ 1006 - ParaAdd neon postgres organization update cmd neon postgres organization update added parameter partner_organization_properties
⚠️ 1006 - ParaAdd neon postgres organization update cmd neon postgres organization update added parameter user_details
⚠️ 1008 - ParaPropAdd neon postgres project delete cmd neon postgres project delete update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres project get-connection-uri cmd neon postgres project get-connection-uri update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres project list cmd neon postgres project list update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres project show cmd neon postgres project show update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres project update cmd neon postgres project update update parameter organization_name: added property nargs=?
⚠️ 1008 - ParaPropAdd neon postgres project wait cmd neon postgres project wait update parameter organization_name: added property nargs=?

Copy link

Hi @alluri02,
Please write the description of changes which can be perceived by customers into HISTORY.rst.
If you want to release a new extension version, please update the version in setup.py as well.

Copy link

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).
After that please run the following commands to enable git hooks:

pip install azdev --upgrade
azdev setup -c <your azure-cli repo path> -r <your azure-cli-extensions repo path>

@yonzhan
Copy link
Collaborator

yonzhan commented May 21, 2025

Thank you for your contribution! We will review the pull request and get back to you soon.

Copy link
Contributor

@Copilot Copilot AI left a 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):

Copy link

CodeGen Tools Feedback Collection

Thank 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

Copy link

github-actions bot commented May 21, 2025

@yonzhan yonzhan requested a review from kairu-ms May 21, 2025 14:54
@yonzhan yonzhan requested a review from jsntcy May 21, 2025 14:54
@alluri02 alluri02 requested a review from Copilot May 21, 2025 15:08
Copy link
Contributor

@Copilot Copilot AI left a 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."

@kairu-ms
Copy link
Contributor

/azp run

Copy link

Azure Pipelines successfully started running 2 pipeline(s).

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.

3 participants