refactor: update

blackchoey · Nov 12, 2024 · 89eb790 · 89eb790
1 parent d2f6e8c
commit 89eb790
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_create.py
@@ -22,6 +22,8 @@ class Create(AAZCommand):
 
     :example: Create API with custom properties
         az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '{\"public-facing\":true}'
+
+    :example: Create API with custom properties using json file
         az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json'
     """
 

diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/_update.py
@@ -22,6 +22,8 @@ class Update(AAZCommand):
 
     :example: Update custom properties
         az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '{\"public-facing\":true}'
+
+    :example: Update custom properties using json file
         az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json'
 
     :example: Update single custom metadata

diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/deployment/_create.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/deployment/_create.py
@@ -19,6 +19,8 @@ class Create(AAZCommand):
 
     :example: Create deployment
         az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '{\"runtimeUri\":[\"https://example.com\"]}'
+
+    :example: Create deployment using server json file
         az apic api deployment create -g api-center-test -n contoso --deployment-id production --title "Production deployment" --description "Public cloud production deployment." --api-id echo-api --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi" --server '@server.json'
     """
 

diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_update.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_update.py
@@ -19,6 +19,8 @@ class Update(AAZCommand):
 
     :example: Update schema
         az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{\"type\":\"string\", \"title\":\"Last name\", \"pattern\": \"^[a-zA-Z0-9]+$\"}'
+
+    :example: Update schema using schema json file
         az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'
     """