feat: mark some parameters as required (#21)

* feat: mark --assignments parameter required for metadata commands

* doc: update sample commands

* feat: mark --source-resource-ids parameter as required for import-from-apim command

* doc: update description for import-from-apim command

src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py

@@ -19,6 +19,9 @@ class Create(AAZCommand):
 
     :example: Create API
         az apic api create -g contoso-resources -s contoso --api-id echo-api --title "Echo API" --type REST
+
+    :example: Create API with custom properties
+        az apic api create -g contoso-resources -s contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{\"public-facing\":true}'
     """
 
     _aaz_info = {

src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py

@@ -19,6 +19,9 @@ class Update(AAZCommand):
 
     :example: Update API
         az apic api update -g contoso-resources -s contoso --api-id echo-api --summary "Basic REST API service"
+
+    :example: Update custom properties
+        az apic api update -g contoso-resources -s contoso --api-id echo-api --custom-properties '{\"public-facing\":true}'
     """
 
     _aaz_info = {

src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_export.py

@@ -18,13 +18,13 @@ class Export(AAZCommand):
     """Exports the metadata schema.
 
     :example: Export Metadata Schema assigned to api
-        az apic metadata export -g api-center-test -s contosoeuap --assignments api --file-name filepath
+        az apic metadata export -g api-center-test -s contosoeuap --assignments api --file-name filename.json
 
     :example: Export Metadata Schema assigned to deployment
-        az apic metadata export -g api-center-test -s contosoeuap --assignments deployment --file-name filepath
+        az apic metadata export -g api-center-test -s contosoeuap --assignments deployment --file-name filename.json
 
     :example: Export Metadata Schema assigned to environment
-        az apic metadata export -g api-center-test -s contosoeuap --assignments environment --file-name filepath
+        az apic metadata export -g api-center-test -s contosoeuap --assignments environment --file-name filename.json
     """
 
     _aaz_info = {

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

@@ -15,7 +15,7 @@
     "apic service import-from-apim",
 )
 class ImportFromApim(AAZCommand):
-    """Imports from APIM instance.
+    """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/a200340d-6b82-494d-9dbf-687ba6e33f9e/resourceGroups/servicegroup/providers/Microsoft.ApiManagement/service/contoso/apis/contosoapi

src/apic-extension/azext_apic_extension/command_patches.py

@@ -116,3 +116,36 @@ class ShowEnvironmentExtension(DefaultWorkspaceParameter, ShowEnvironment):
 
 class UpdateEnvironmentExtension(DefaultWorkspaceParameter, UpdateEnvironment):
     pass
+
+# `az apic metadata commands`
+from .aaz.latest.apic.metadata import Create as CreateMetadata, Export as ExportMetadata
+
+class CreateMetadataExtension(CreateMetadata):
+    # pylint: disable=too-few-public-methods
+    @classmethod
+    def _build_arguments_schema(cls, *args, **kwargs):
+        # pylint: disable=protected-access
+        args_schema = super()._build_arguments_schema(*args, **kwargs)
+        args_schema.assignments._required = True
+        return args_schema
+
+class ExportMetadataExtension(ExportMetadata):
+    # pylint: disable=too-few-public-methods
+    @classmethod
+    def _build_arguments_schema(cls, *args, **kwargs):
+        # pylint: disable=protected-access
+        args_schema = super()._build_arguments_schema(*args, **kwargs)
+        args_schema.assignments._required = True
+        return args_schema
+
+# `az apic service commands`
+from .aaz.latest.apic.service import ImportFromApim
+
+class ImportFromApimExtension(ImportFromApim):
+    # pylint: disable=too-few-public-methods
+    @classmethod
+    def _build_arguments_schema(cls, *args, **kwargs):
+        # pylint: disable=protected-access
+        args_schema = super()._build_arguments_schema(*args, **kwargs)
+        args_schema.source_resource_ids._required = True
+        return args_schema

src/apic-extension/azext_apic_extension/custom.py

@@ -20,9 +20,9 @@
 from azure.cli.core.aaz._arg import AAZStrArg
 from .command_patches import ImportAPIDefinitionExtension
 from .command_patches import ExportAPIDefinitionExtension
-from .aaz.latest.apic.metadata import Create as CreateMetadataSchema
+from .command_patches import CreateMetadataExtension
+from .command_patches import ExportMetadataExtension
 from .aaz.latest.apic.metadata import Update as UpdateMetadataSchema
-from .aaz.latest.apic.metadata import Export as ExportMetadataSchema
 
 logger = get_logger(__name__)
 
@@ -133,7 +133,7 @@ def writeResultsToFile(self, results, file_name):
                     f.write(results)
 
 
-class CreateMetadataSchemaExtension(CreateMetadataSchema):
+class CreateMetadataSchemaExtension(CreateMetadataExtension):
     @classmethod
     def _build_arguments_schema(cls, *args, **kwargs):
         args_schema = super()._build_arguments_schema(*args, **kwargs)
@@ -215,7 +215,7 @@ def pre_operations(self):
         self.ctx.args.schema = value
 
 
-class ExportMetadataSchemaExtension(ExportMetadataSchema):
+class ExportMetadataSchemaExtension(ExportMetadataExtension):
 
     @classmethod
     def _build_arguments_schema(cls, *args, **kwargs):