apic-extension GA release

.github/workflows/CD.yml

@@ -0,0 +1,78 @@
+name: CD
+
+on:
+  pull_request:
+    types: [closed]
+  workflow_dispatch:
+
+permissions:
+  actions: read
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.11
+
+    - name: Setup development environment
+      run: |
+        python -m venv .venv
+        source .venv/bin/activate
+        python -m pip install -U pip
+        pip install azdev
+        azdev setup -r .
+        azdev extension add apic-extension
+
+    # Append commit hash to the version. E.g. 1.0.0b4+abc1234
+    - name: Update version
+      run: |
+        python -c "
+        import re
+        import os
+
+        # Open the file
+        with open('src/apic-extension/setup.py', 'r') as f:
+            content = f.read()
+
+        # Find the version string
+        version_match = re.search(r'VERSION = \'(.*?)\'', content)
+        if version_match is None:
+            raise ValueError('Could not find version string in setup.py')
+
+        # Extract the original version
+        original_version = version_match.group(1)
+
+        # Get the commit hash
+        commit_hash = os.getenv('GITHUB_SHA', 'daily')[:7]
+
+        # Create the new version string
+        new_version = original_version + '+' + commit_hash
+
+        # Replace the old version string with the new one
+        content_new = re.sub(r'VERSION = \'(.*?)\'', f'VERSION = \'{new_version}\'', content)
+
+        # Write the updated content back to the file
+        with open('src/apic-extension/setup.py', 'w') as f:
+            f.write(content_new)
+        "
+
+    - name: Build binary
+      run: |
+        source .venv/bin/activate
+        azdev extension build apic-extension
+
+    - name: Upload release asset
+      uses: actions/upload-artifact@v3
+      with:
+        name: release
+        path: |
+          ./dist/*.whl

.github/workflows/CI.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Setup development environment
+      run: |
+        python -m venv .venv
+        source .venv/bin/activate
+        python -m pip install -U pip
+        pip install azdev
+        azdev setup -r .
+        azdev extension add apic-extension
+
+    - name: Run style check
+      run: |
+        source .venv/bin/activate
+        azdev style apic-extension
+
+    - name: Run linter
+      run: |
+        source .venv/bin/activate
+        azdev linter apic-extension
+
+    - name: Run tests
+      run: |
+        source .venv/bin/activate
+        azdev test apic-extension

src/apic-extension/HISTORY.rst

@@ -3,8 +3,24 @@
 Release History
 ===============
 
+1.0.0
+++++++++++++++++++
+* Update: Redesigned `az apic service import-from-apim` command to provide easier way to specify APIM instance
+* Update: Renamed `az apic service *` commands to `az apic *` commands
+* Update: Renamed `--name/--service/--service-name/-s` parameters in `az apic *` commands to `--name/-n`
+* Update: Renamed `--service/--service-name/-s` parameters in each sub commands to `--service-name/-n`
+* Update: Renamed `--metadata-schema/--metadata-schema-name/--name` parameters in `az apic metadata *` commands to `--metadata-name`
+* Update: Renamed `--environment-name` parameter in `az apic api register` command to `--environment-id`
+* Fix: API title created by register command is not same with provided spec
+* Fix: Error not thrown when import spec with >3MB file
+* Fix: Error when register API with long description in spec
+* Fix: `--definition-id`, `--environment-id`, `--server`, `--title` parameters should be required in `az apic api deployment create` command
+* Fix: `--format`, `--specification`, `--value` parameters should be required in `az apic api definition import-specification` command
+* Remove: `--state`` parameter for `az apic api deployment` commands.
+* Remove: `--file-name`` parameter for `az apic api definition import-specification`, `az apic metadata create` and `az apic metadata update` command. Use the `@filename` syntax provided by Azure CLI to read parameter value from a file directly.
+
 1.0.0b5
-+++++
+++++++++++++++++++
 * Add: Support yaml file for `az apic api register` command.
 * Update: Command names, parameter names, and command descriptions for better understanding. Please leverage `-h` option or refer Azure CLI reference doc to see full list of commands and parameters.
 * Update: Introduction to parameter constraints to ensure that valid values are provided.
@@ -15,17 +31,17 @@ Release History
 * Remove: `head` commands in each command group are removed.
 
 1.0.0b4
-+++++
+++++++++++++++++++
 * Add: Support for Default Portal configuration and default hostname provisoning deprovisioning commands
 
 1.0.0b3
-+++++
+++++++++++++++++++
 * Add: Support for Import from apim command along with add examples for create service
 
 1.0.0b2
-++++++
+++++++++++++++++++
 * Remove: All workspace cli commands as it should not be exposed to customers just yet.
 
 1.0.0b1
-++++++
-* Initial release.
+++++++++++++++++++
+* Initial release.

src/apic-extension/azext_apic_extension/_help.py

@@ -12,23 +12,23 @@
 
 helps['apic api register'] = """
     type: command
-    short-summary: Registers a new API with version, definition, and associated deployments using the specification file as the source of truth.
+    short-summary: Registers a new API with version, definition, and associated deployments using the specification file as the source of truth. For now we only support OpenAPI JSON/YAML format.
     parameters:
       - name: --api-location -l
         type: string
         short-summary: Location of spec file.
       - name: --resource-group -g
         type: string
         short-summary: Resource group name.
-      - name: --service -s
+      - name: --service-name -n
         type: string
         short-summary: APICenter Catalog or Service name.
-      - name: --environment-name -e
+      - name: --environment-id
         type: string
-        short-summary: Name of environment created before.
+        short-summary: Id of environment created before.
     examples:
       - name: Register api by providing spec file.
         text: |
-          az apic api register -g api-center-test -s contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-name public
-          az apic api register -g api-center-test -s contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-name public
+          az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.json" --environment-id public
+          az apic api register -g api-center-test -n contosoeuap --api-location "examples/cli-examples/spec-examples/openai.yml" --environment-id public
 """

src/apic-extension/azext_apic_extension/_params.py

@@ -26,13 +26,13 @@ def load_arguments(self, _):  # pylint: disable=unused-argument
         )
         c.argument(
             "service_name",
-            options_list=['--service', '-s'],
+            options_list=['--service-name', '-n'],
             help="Service name",
             required=True,
         )
         c.argument(
-            "environment_name",
-            options_list=['--environment-name', '-e'],
-            help="Environemnt name",
+            "environment_id",
+            options_list=['--environment-id'],
+            help="Environemnt id",
             required=False
         )

src/apic-extension/azext_apic_extension/aaz/latest/apic/__init__.py

@@ -9,3 +9,9 @@
 # flake8: noqa
 
 from .__cmd_group import *
+from ._create import *
+from ._delete import *
+from ._import_from_apim import *
+from ._list import *
+from ._show import *
+from ._update import *

src/apic-extension/azext_apic_extension/aaz/latest/apic/service/_create.py → src/apic-extension/azext_apic_extension/aaz/latest/apic/_create.py

@@ -12,16 +12,16 @@
 
 
 @register_command(
-    "apic service create",
+    "apic create",
 )
 class Create(AAZCommand):
     """Creates an instance or update an existing instance of an Azure API Center service.
 
     :example: Create service Example 1
-        az apic service create -g contoso-resources -s contoso -l eastus
+        az apic create -g contoso-resources -n contoso -l eastus
 
     :example: Create Service Example 2
-        az apic service create --resource-group contoso-resources --name contoso --location eastus
+        az apic create --resource-group contoso-resources --name contoso --location eastus
     """
 
     _aaz_info = {
@@ -50,8 +50,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
         _args_schema.resource_group = AAZResourceGroupNameArg(
             required=True,
         )
-        _args_schema.service_name = AAZStrArg(
-            options=["-s", "--name", "--service", "--service-name"],
+        _args_schema.name = AAZStrArg(
+            options=["-n", "--name"],
             help="The name of the API Center service.",
             required=True,
             fmt=AAZStrArgFormat(
@@ -149,7 +149,7 @@ def url_parameters(self):
                     required=True,
                 ),
                 **self.serialize_url_param(
-                    "serviceName", self.ctx.args.service_name,
+                    "serviceName", self.ctx.args.name,
                     required=True,
                 ),
                 **self.serialize_url_param(

src/apic-extension/azext_apic_extension/aaz/latest/apic/service/_delete.py → src/apic-extension/azext_apic_extension/aaz/latest/apic/_delete.py

@@ -12,14 +12,14 @@
 
 
 @register_command(
-    "apic service delete",
+    "apic delete",
     confirmation="Are you sure you want to perform this operation?",
 )
 class Delete(AAZCommand):
     """Deletes an instance of an Azure API Center service.
 
     :example: Delete service
-        az apic service delete -s contoso -g contoso-resources
+        az apic delete -n contoso -g contoso-resources
     """
 
     _aaz_info = {
@@ -48,8 +48,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
         _args_schema.resource_group = AAZResourceGroupNameArg(
             required=True,
         )
-        _args_schema.service_name = AAZStrArg(
-            options=["-s", "--name", "--service", "--service-name"],
+        _args_schema.name = AAZStrArg(
+            options=["-n", "--name"],
             help="The name of the API Center service.",
             required=True,
             id_part="name",
@@ -110,7 +110,7 @@ def url_parameters(self):
                     required=True,
                 ),
                 **self.serialize_url_param(
-                    "serviceName", self.ctx.args.service_name,
+                    "serviceName", self.ctx.args.name,
                     required=True,
                 ),
                 **self.serialize_url_param(

src/apic-extension/azext_apic_extension/aaz/latest/apic/service/_import_from_apim.py → src/apic-extension/azext_apic_extension/aaz/latest/apic/_import_from_apim.py

@@ -12,13 +12,19 @@
 
 
 @register_command(
-    "apic service import-from-apim",
+    "apic import-from-apim",
 )
 class ImportFromApim(AAZCommand):
     """Imports APIs from an Azure API Management service instance.
 
-    :example: Import From APIM
-        az apic service import-from-apim -g api-center-test --service-name contosoeuap --source-resource-ids '/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/servicegroup/providers/Microsoft.ApiManagement/service/contoso/apis/contosoapi'
+    :example: Import all APIs from APIM in same resource group
+        az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis *
+
+    :example: Import selected APIs from APIM in same resource group
+        az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-name contoso-apim --apim-apis [echo,foo]
+
+    :example: Import all APIs from APIM in another subscription and resource group
+        az apic import-from-apim -g api-center-test --service-name contoso-apic --apim-subscription 00000000-0000-0000-0000-000000000000 --apim-resource-group apim-rg --apim-name contoso-apim --apim-apis *
     """
 
     _aaz_info = {
@@ -49,7 +55,7 @@ def _build_arguments_schema(cls, *args, **kwargs):
             required=True,
         )
         _args_schema.service_name = AAZStrArg(
-            options=["-s", "--service", "--service-name"],
+            options=["-n", "--service-name"],
             help="The name of Azure API Center service.",
             required=True,
             id_part="name",

src/apic-extension/azext_apic_extension/aaz/latest/apic/service/_list.py → src/apic-extension/azext_apic_extension/aaz/latest/apic/_list.py

@@ -12,13 +12,15 @@
 
 
 @register_command(
-    "apic service list",
+    "apic list",
 )
 class List(AAZCommand):
     """Lists Azure API Center services within an Azure subscription.
 
+    There is a known issue that listing all resources under a subscription does not work. Please list resources by resource group.
+
     :example: List services in resource group
-        az apic service list -g contoso-resources
+        az apic list -g contoso-resources
     """
 
     _aaz_info = {

src/apic-extension/azext_apic_extension/aaz/latest/apic/service/_show.py → src/apic-extension/azext_apic_extension/aaz/latest/apic/_show.py

@@ -12,13 +12,13 @@
 
 
 @register_command(
-    "apic service show",
+    "apic show",
 )
 class Show(AAZCommand):
     """Show details of an Azure API Center service instance.
 
     :example: Show service details
-        az apic service show -g contoso-resources -s contoso
+        az apic show -g contoso-resources -n contoso
     """
 
     _aaz_info = {
@@ -47,8 +47,8 @@ def _build_arguments_schema(cls, *args, **kwargs):
         _args_schema.resource_group = AAZResourceGroupNameArg(
             required=True,
         )
-        _args_schema.service_name = AAZStrArg(
-            options=["-s", "--name", "--service", "--service-name"],
+        _args_schema.name = AAZStrArg(
+            options=["-n", "--name"],
             help="The name of the API Center service.",
             required=True,
             id_part="name",
@@ -111,7 +111,7 @@ def url_parameters(self):
                     required=True,
                 ),
                 **self.serialize_url_param(
-                    "serviceName", self.ctx.args.service_name,
+                    "serviceName", self.ctx.args.name,
                     required=True,
                 ),
                 **self.serialize_url_param(