feat(neon): flatten command hierarchy remove legacy 'neon postgres' group (1.0.0b5)

Author: Bhargavsaichinni

src/neon/HISTORY.rst

@@ -3,10 +3,10 @@
 Release History
 ===============
 
-1.0.0b1
+1.0.0b5
 ++++++
-* Initial release.
-
+* Flatten command hierarchy: removed duplicate 'neon postgres' group; all commands now under top-level 'neon'.
+* Added consolidated help content.
 1.0.0b2
 ++++++
 * Updated command descriptions.
@@ -17,4 +17,9 @@ Release History
 
 1.0.0b4
 ++++++
-* Update the CLI command description to support AI related queries.
+* Update the CLI command description to support AI related queries.
+
+1.0.0b5
+++++++
+* Flatten command hierarchy: deprecate duplicate 'neon postgres' group in favor of top-level 'neon'.
+* Add consolidated help content and deprecation notice.

src/neon/azext_neon/_help.py

@@ -9,3 +9,18 @@
 # pylint: disable=too-many-lines
 
 from knack.help_files import helps  # pylint: disable=unused-import
+
+helps["neon"] = """
+		type: group
+		short-summary: Manage Neon Serverless Postgres resources (organizations, projects, branches, databases, roles, endpoints, compute).
+		long-summary: |-
+				Manage Neon serverless Postgres on Azure including:
+					* Organization lifecycle
+					* Project management
+					* Branch management
+					* Database operations
+					* Role management
+					* Compute / endpoints
+				NOTE: Previous nested usage 'az neon postgres <subgroup>' is deprecated. Use 'az neon <subgroup>'.
+"""
+

src/neon/azext_neon/aaz/__init__.py

@@ -4,3 +4,5 @@
 #
 # Code generated by aaz-dev-tools
 # --------------------------------------------------------------------------------------------
+
+from . import latest

src/neon/azext_neon/aaz/latest/__init__.py

@@ -8,3 +8,4 @@
 # pylint: skip-file
 # flake8: noqa
 
+from . import neon

src/neon/azext_neon/aaz/latest/neon/__cmd_group.py

@@ -15,9 +15,10 @@
     "neon",
 )
 class __CMDGroup(AAZCommandGroup):
-    """Manage Neon Postgres databases and related resources within Azure.
+    """Manage Neon Serverless Postgres resources including organizations, projects, and branches.
     """
     pass
 
 
 __all__ = ["__CMDGroup"]
+

src/neon/azext_neon/aaz/latest/neon/__init__.py

@@ -9,3 +9,4 @@
 # flake8: noqa
 
 from .__cmd_group import *
+from . import postgres

src/neon/azext_neon/aaz/latest/neon/postgres/__init__.py

@@ -8,5 +8,17 @@
 # pylint: skip-file
 # flake8: noqa
 
-from .__cmd_group import *
+"""Loader for Neon subcommand groups without legacy 'neon postgres' wrapper.
+
+The original generated package registered a duplicate root group 'neon postgres'.
+That group has been removed to flatten the hierarchy so only 'neon' appears in docs.
+"""
+
 from ._create import *
+from . import branch
+from . import compute
+from . import endpoint
+from . import neon_database
+from . import neon_role
+from . import organization
+from . import project

src/neon/azext_neon/aaz/latest/neon/postgres/_create.py

@@ -11,17 +11,20 @@
 from azure.cli.core.aaz import *
 
 
+@register_command(
+    "neon create",
+    )
 class Create(AAZCommand):
     """Create a Neon organization
 
-    :example: Organizations_CreateOrUpdate
-        az neon postgres create --resource-group demoResourceGroup --name demoNeonResource --location eastus --subscription 12345678-1234-1234-1234-123456789abc --marketplace-details "{subscription-id:abcd1234-5678-90ab-cdef-12345678abcd,subscription-status:PendingFulfillmentStart,offer-details:{publisher-id:microsoft,offer-id:neon-postgres,plan-id:serverless-plan,plan-name:'Neon Serverless Postgres - Free (Test_Liftr)',term-unit:P1M,term-id:term1234}}" --user-details "{first-name:John,last-name:Doe,email-address:johndoe@example.com,upn:johndoe,phone-number:+1234567890}" --company-details "{company-name:'DemoCompany',country:USA,business-phone:+9876543210,office-address:'123 Azure Ave, Redmond, WA',domain:democompany.com,number-of-employees:1000}" --partner-organization-properties "{organization-id:org-5678,org-name:'PartnerOrg',single-sign-on-properties:{single-sign-on-state:Enable,enterprise-app-id:app-9876,single-sign-on-url:'https://sso.partnerorg.com',aad-domains:['partnerorg.com']}}"
+    :example: Create Neon Organization (Shortcut)
+        az neon create --resource-group myResourceGroup --name myNeonOrg --location eastus --subscription 12345678-1234-1234-1234-123456789abc --marketplace-details "{subscription-id:abcd1234-5678-90ab-cdef-12345678abcd,subscription-status:Subscribed,offer-details:{publisher-id:neon1722366567200,offer-id:neon_serverless_postgres_azure_prod,plan-id:neon_serverless_postgres_azure_prod_free,plan-name:'Free Plan',term-unit:P1M,term-id:term1234}}" --user-details "{first-name:John,last-name:Doe,email-address:johndoe@example.com,upn:johndoe,phone-number:+1234567890}" --company-details "{company-name:'DemoCompany',country:USA,business-phone:+9876543210,office-address:'123 Azure Ave, Redmond, WA',domain:democompany.com,number-of-employees:1000}" --partner-organization-properties "{organization-id:org-5678,org-name:'PartnerOrg',single-sign-on-properties:{single-sign-on-state:Enable,enterprise-app-id:app-9876,single-sign-on-url:'https://sso.partnerorg.com',aad-domains:['partnerorg.com']}}"
     """
 
     _aaz_info = {
-        "version": "2024-08-01-preview",
+        "version": "2025-03-01",
         "resources": [
-            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/neon.postgres/organizations/{}", "2024-08-01-preview"],
+            ["mgmt-plane", "/subscriptions/{}/resourcegroups/{}/providers/neon.postgres/organizations/{}", "2025-03-01"],
         ]
     }
 
@@ -120,7 +123,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
         marketplace_details.subscription_status = AAZStrArg(
             options=["subscription-status"],
             help="Marketplace subscription status",
-            enum={"PendingFulfillmentStart": "PendingFulfillmentStart", "Subscribed": "Subscribed", "Suspended": "Suspended", "Unsubscribed": "Unsubscribed"},
+            enum={"Subscribed": "Subscribed", "Subscribed": "Subscribed", "Suspended": "Suspended", "Unsubscribed": "Unsubscribed"},
         )
 
         offer_details = cls._args_schema.marketplace_details.offer_details
@@ -321,7 +324,7 @@ def url_parameters(self):
         def query_parameters(self):
             parameters = {
                 **self.serialize_query_param(
-                    "api-version", "2024-08-01-preview",
+                    "api-version", "2025-03-01",
                     required=True,
                 ),
             }

src/neon/azext_neon/aaz/latest/neon/postgres/branch/__cmd_group.py

@@ -12,7 +12,7 @@
 
 
 @register_command_group(
-    "neon postgres branch",
+    "neon branch",
 )
 class __CMDGroup(AAZCommandGroup):
     """Manage branches within a Neon Postgres database.

src/neon/azext_neon/aaz/latest/neon/postgres/branch/_create.py

@@ -12,13 +12,13 @@
 
 
 @register_command(
-    "neon postgres branch create",
+    "neon branch create",
 )
 class Create(AAZCommand):
     """Create a new branch within a Neon Postgres database.
 
     :example: Create a Branch
-        az neon postgres branch create --resource-group rgneon --organization-name org-cli-test --project-name old-frost-16758796 --branch-name test-branch --entity-name test-branch --role-name test_role --database-name testneondb
+        az neon branch create --resource-group rgneon --organization-name org-cli-test --project-name old-frost-16758796 --branch-name test-branch --entity-name test-branch --role-name test_role --database-name testneondb
     """
 
     _aaz_info = {