From ed7b022e9a82fbc02a02299f3a517de21c60a22c Mon Sep 17 00:00:00 2001 From: frankqianms Date: Tue, 5 Nov 2024 23:55:27 +0800 Subject: [PATCH 1/5] refactor: add example --- .../aaz/latest/apic/api/definition/_import_specification.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py index 6afb0e3f230..bcbd363565f 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py @@ -22,6 +22,9 @@ class ImportSpecification(AAZCommand): :example: Import specification example 2 az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}' + + :example: Import specification from file example + az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '@petstore.json' """ _aaz_info = { From 91ccd0d51810160836082da06bca35623ca17f7c Mon Sep 17 00:00:00 2001 From: frankqianms Date: Wed, 6 Nov 2024 10:43:59 +0800 Subject: [PATCH 2/5] fix: update params --- .../aaz/latest/apic/api/definition/_import_specification.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py index bcbd363565f..718d06854a7 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py @@ -24,7 +24,7 @@ class ImportSpecification(AAZCommand): az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}' :example: Import specification from file example - az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api-2 --version-id 2023-08-01 --definition-id openapi3 --format "inline" --value '@petstore.json' + az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-ap --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json' """ _aaz_info = { From 57e937504a661964307546b74b09104b5fe8d7f7 Mon Sep 17 00:00:00 2001 From: frankqianms Date: Thu, 7 Nov 2024 10:12:43 +0800 Subject: [PATCH 3/5] fix: bad api id --- .../aaz/latest/apic/api/definition/_import_specification.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py index 718d06854a7..ecd9de2d557 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/api/definition/_import_specification.py @@ -24,7 +24,7 @@ class ImportSpecification(AAZCommand): az apic api definition import-specification -g api-center-test -n contoso --api-id echo-api --version-id 2023-11-01 --definition-id openapi --format "link" --value 'https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/examples/v3.0/petstore.json' --specification '{"name":"openapi","version":"3.0.0"}' :example: Import specification from file example - az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-ap --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json' + az apic api definition import-specification -g api-center-test -n contosoeuap --api-id echo-api --version-id 2023-08-01 --definition-id openapi --format "inline" --value '@petstore.json' """ _aaz_info = { From 7f74512e027578f1d9c897b0f45dcbcd7f262951 Mon Sep 17 00:00:00 2001 From: frankqianms Date: Thu, 7 Nov 2024 13:55:46 +0800 Subject: [PATCH 4/5] refactor: add @filename.json examples --- .../azext_apic_extension/aaz/latest/apic/api/_create.py | 1 + .../azext_apic_extension/aaz/latest/apic/api/_update.py | 1 + .../aaz/latest/apic/api/deployment/_create.py | 1 + .../azext_apic_extension/aaz/latest/apic/metadata/_create.py | 3 +++ .../azext_apic_extension/aaz/latest/apic/metadata/_update.py | 1 + 5 files changed, 7 insertions(+) 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 index ba6583bcc9f..75d776d4a5e 100644 --- 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,7 @@ 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}' + az apic api create -g contoso-resources -n contoso --api-id echo-api --title "Echo API" --type REST --custom-properties '@customProperties.json' """ _aaz_info = { 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 index 5d95d1df547..6c9e0cca4bb 100644 --- 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,7 @@ 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}' + az apic api update -g contoso-resources -n contoso --api-id echo-api --custom-properties '@customProperities.json' :example: Update single custom metadata az apic api update -g contoso-resources -n contoso --api-id echo-api --set customProperties.internal=false 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 index d9f83bb4b45..215c734e899 100644 --- 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,7 @@ 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\"]}' + 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' """ _aaz_info = { diff --git a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py index f7ec27b4b2c..df6f7d22687 100644 --- a/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py +++ b/src/apic-extension/azext_apic_extension/aaz/latest/apic/metadata/_create.py @@ -22,6 +22,9 @@ class Create(AAZCommand): :example: Create metadata example 2 az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name testregion --schema '{\"type\":\"string\",\"title\":\"testregion\",\"oneOf\":[{\"const\":\"Region1\",\"description\":\"\"},{\"const\":\"Region2\",\"description\":\"\"},{\"const\":\"Region3\",\"description\":\"\"}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]' + + :example: Create metadata using json file schema and assignments example + az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json' """ _aaz_info = { 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 index 38974e1a22b..7e76789e235 100644 --- 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,7 @@ 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]+$\"}' + az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json' """ _aaz_info = { From 89eb790f63071fa0595a6f364fa710955f96e99d Mon Sep 17 00:00:00 2001 From: frankqianms Date: Tue, 12 Nov 2024 13:24:59 +0800 Subject: [PATCH 5/5] refactor: update --- .../azext_apic_extension/aaz/latest/apic/api/_create.py | 2 ++ .../azext_apic_extension/aaz/latest/apic/api/_update.py | 2 ++ .../aaz/latest/apic/api/deployment/_create.py | 2 ++ .../azext_apic_extension/aaz/latest/apic/metadata/_update.py | 2 ++ 4 files changed, 8 insertions(+) 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 index 75d776d4a5e..59e5f180b92 100644 --- 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 index 6c9e0cca4bb..16b56d1e986 100644 --- 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 index 215c734e899..2d0b0a5c72b 100644 --- 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 index 7e76789e235..5ae23be61eb 100644 --- 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' """