apic-extension GA release (#7677)

* build: add cicd pipeline (#7) * build: move update version logic to workflow (#8) * build: Run CI on multiple python version (#38) * build: Run CI in Python 3.8-3.11 * build: remove pull request event for CI to avoid duplicate runs * test: add test cases for commands (#40) * fix: error when register API with long description spec (#41) * test: add test cases for optional parameters (#42) * feat!: remove file name param (#43) * fix: error not thrown when import spec with >3MB file (#44) * feat!: remove state param for deployment commands (#46) * fix: API title created by register command is not same with provided spec (#47) * feat!: redesign parameters to specify APIM instance for import-from-apim command (#45) * test: clean up legacy test cases (#48) * test: add test cases for command examples (#49) * docs: update help message per feedback (#50) * build: bump version to 1.0.0 and add changelog (#51) * fix: some parameters should be required in import-specification and deployment command (#53) * feat!: rename parameter names to align with other Azure CLI command experience (#52) * test: enable test for import-from-apim (#54) * test: fix show service test case (#55) * docs: update changelog for 1.0.0 (#56) * Update HISTORY.rst - jukasper updated changelog * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * Update HISTORY.rst * docs: update readme for apic-extension (#57) * fix: cannot run create command against existing resource (#58) * fix: cannot run create command against existing resource * style: fix style * build: remove cicd pipeline (#59) * build: resolve review comments (#60) --------- Co-authored-by: Julia Kasper <[email protected]>
Azure · Jul 4, 2024 · dcee6ba · dcee6ba
1 parent 01d7a7b
commit dcee6ba
Show file tree

Hide file tree

Showing 188 changed files with 24,366 additions and 4,959 deletions.
diff --git a/src/apic-extension/HISTORY.rst b/src/apic-extension/HISTORY.rst
@@ -3,8 +3,34 @@
 Release History
 ===============
 
+1.0.0
+++++++++++++++++++
+Potential Impact: The changes in this release, including the renaming of commands and parameters, may require changes to existing scripts and integrations. Please review the changes carefully and update your code accordingly.
+
+**Updates:**
+
+* Redesigned ``az apic service import-from-apim`` command for an easier specification of APIM instances.
+* [BREAKING CHANGE] Renamed ``az apic service *`` commands to ``az apic *`` commands.
+* [BREAKING CHANGE] Renamed ``--name/--service/--service-name/-s`` parameters in ``az apic *`` commands to ``--name/-n``.
+* [BREAKING CHANGE] Renamed ``--service/--service-name/-s`` parameters in subcommands to ``--service-name/-n``.
+* [BREAKING CHANGE] Renamed ``--metadata-schema/--metadata-schema-name/--name`` parameters in ``az apic metadata *`` commands to ``--metadata-name``.
+* [BREAKING CHANGE] Renamed ``--environment-name`` parameter in ``az apic api register`` command to ``--environment-id``.
+
+**Fixes:**
+
+* Ensured API title created by ``register`` command matches the provided specification.
+* Addressed the non-throwing of errors when importing specifications with files larger than 3MB.
+* Resolved errors occurring when registering APIs with long descriptions in the specification.
+* [BREAKING CHANGE] Made ``--definition-id``, ``--environment-id``, ``--server``, ``--title`` parameters mandatory in ``az apic api deployment create`` command.
+* [BREAKING CHANGE] Made ``--format``, ``--specification``, ``--value`` parameters mandatory in ``az apic api definition import-specification`` command.
+
+**Removals:**
+
+* Removed ``--state`` parameter from ``az apic api deployment`` commands.
+* [BREAKING CHANGE] Eliminated ``--file-name`` parameter for ``az apic api definition import-specification``, ``az apic metadata create``, and ``az apic metadata update`` commands. Introduced usage of the ``@filename`` syntax for reading parameter values from a file directly in Azure CLI.
+
 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 +41,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.
diff --git a/src/apic-extension/README.md b/src/apic-extension/README.md
@@ -1,6 +1,9 @@
-# Azure CLI APICenter Extension
+# Azure CLI API Center Extension
 
-This extension can help create and manage APICenter Resources
+*This extension can help create and manage API Center Resources.*
+
+**Azure API Center** enables tracking all of your APIs in a centralized location for discovery, reuse, and governance. Use an API center to develop and maintain a structured and organized inventory of your organization's APIs - regardless of their type, lifecycle stage, or deployment location - along with related information such as version details, API definition files, and common metadata. 
+See [Azure API Center documentation](https://learn.microsoft.com/azure/api-center/overview) for more information.
 
 ### How to use
 Install this extension using the below CLI command
@@ -9,274 +12,10 @@ az extension add --name apic-extension
 ```
 
 ### API Center Extension Info
-APICenter documentation: https://learn.microsoft.com/en-us/azure/api-center/
-
-List Service Examples
-```
-az apic service show --resource-group api-center-test
-```
-```
-az apic service show -g api-center-test
-```
-
-Show service Examples
-```
-az apic service show --resource-group api-center-test --service-name contosoeuap
-```
-```
-az apic service show -g api-center-test -s contosoeuap
-```
-
-Delete Service Examples
-```
-az apic service delete --resource-group api-center-test --service-name contosoeuap
-```
-```
-az apic service delete --resource-group arpi-test-rg1 -s apictestcli3
-```
-
-Create API Examples
-```
-az apic api create -g api-center-test -s contosoeuap --name echo-api --title "Echo API" --kind "rest"
-```
-```
-az apic api create --resource-group api-center-test --service-name contosoeuap --api-name echo-api2 --description "CLI Test" --kind rest --title "Echo API"
-```
-
-Update API Examples
-```
-az apic api update -g api-center-test -s contosoeuap --name echo-api --summary "Basic REST API service"
-```
-```
-az apic api update --resource-group api-center-test -s contosoeuap --name echo-api --summary "Basic REST API service"
-```
-
-LIST Api Example
-```
-az apic api list --resource-group api-center-test --service-name contosoeuap
-```
-```
-az apic api list -g api-center-test -s contosoeuap
-```
-
-SHOW Api Examples
-```
-az apic api show -g api-center-test -s contosoeuap --name echo-api
-```
-```
-az apic api show --resource-group api-center-test --service-name contosoeuap -w default --api echo-api
-```
-
-Delete API Examples
-```
-az apic api delete -g api-center-test -s contosoeuap --name echo-api 
-```
-```
-az apic api delete --resource-group contoso-resources --service-name contosoeuap --name echo-api
-```
-
-CREATE Api Version Examples
-```
-az apic api version create -g api-center-test -s contosoeuap --api-name echo-api --name 2023-01-01 --title "2023-01-01"
-```
-```
-az apic api version create --resource-group api-center-test --service-name contosoeuap --api-name echo-api --name 2023-01-01 --title "2023-01-01"
-```
-
-UPDATE Api Version Examples
-```
-Az apic api version update -g api-center-test -s contosoeuap --api-name echo-api --name 2023-01-01 --title "2023-01-01"
-```
-```
-az apic api version update --resource-group api-center-test --service-name contosoeuap --api-name echo-api --name 2023-01-01 --title "2023-01-01"
-```
-
-LIST Api Version Examples
-```
-az apic api version list -g api-center-test -s contosoeuap --api-name echo-api
-```
-```
-az apic api version list --resource-group api-center-test --service-name contosoeuap --api-name echo-api
-```
-
-SHOW Api Version Example
-```
-az apic api version show -g api-center-test -s contosoeuap --api-name echo-api --name 2023-01-01
-```
-```
-az apic api version show --resource-group api-center-test --service-name contosoeuap --api-name echo-api --name 2023-01-01
-```
-
-DELETE Api Version Example
-```
-az apic api version delete -g api-center-test -s contosoeuap --api-name echo-api --name 2023-01-01 
-```
-```
-az apic api version delete --resource-group api-center-test --service-name contosoeuap --api-name echo-api --name 2023-01-01
-```
-
-CREATE API Definition Example
-```
-az apic api definition create -g api-center-test -s contosoeuap --api-name echo-api --version 2023-01-01 --name "openapi" --title "OpenAPI"
-```
-
-UPDATE API Definition Example
-```
-az apic api definition update -g api-center-test -s contosoeuap --api-name echo-api --version 2023-01-01 --name "openapi" --title "OpenAPI"
-```
-
-SHOW API Definition Example
-```
-az apic api definition show -g api-center-test -s contosoeuap --api-name echo-api --version 2023-01-01 --name "openapi"
-```
-
-LIST API Definition Example
-```
-az apic api definition list -g api-center-test -s contosoeuap --api-name echo-api --version 2023-01-01 
-```
-
-DELETE API Definition Example
-```
-az apic api definition delete -g api-center-test -s contosoeuap --api-name echo-api --version 2023-01-01 --name "openapi" 
-```
-
-IMPORT Specification Examples
-Import Specification inline option
-```
-az apic api definition import-specification -g api-center-test -s contosoeuap --api-name echo-api --version-name 2023-01-01 --definition-name openapi--format "inline" --value '{"openapi":"3.0.1","info":{"title":"httpbin.org","description":"API Management facade for a very handy and free online HTTP tool.","version":"1.0"}}' --specification '{"name":"openapi","version":"3.0.0"}' 
-```
-
-Import Specification Inline option where spec is provided by sending a file
-```
-az apic api definition import-specification -g api-center-test -s contosoeuap --api-name echo-api --version-name 2023-01-01 --definition-name openapi --format inline --specification '{"name":"openapi","version":"3.0.0"}' --file-name C:\Users\arpishah\examples\cli-examples\spec-examples\cat-facts-api.json 
-```
-
-Import Specification Link option where spec is provided via a link
-```
-az apic api definition import-specification -g api-center-test -s contosoeuap - --api-name echo-api --version-name 2023-01-01 --definition-name openapi --format "link" --value https://alzaslonaztest.blob.core.windows.net/arpitestblobs/cat-facts-api.json --specification '{"name":"openapi","version":"3.0.0"}'
-```
-
-Export Specification Examples
-Export Spec to a file
-```
-az apic api definition export-specification -g api-center-test -s contosoeuap --api-name echo-api-10 --version-name 2023-11-08 --definition-name arpitest4 --file-name C:\Users\arpishah\examples\cli-examples\exported-results\exported-spec-inline.json
-```
-
-CREATE Api Deployment
-
-```
-az apic api deployment create -g api-center-test -s contosoeuap --name production --title "Production deployment" --description "Public cloud production deployment." --api echo-api --server C:/Users/arpishah/examples/cli-examples/payload-examples/deplcreate.json --environment-id "/workspaces/default/environments/production" --definition-id "/workspaces/default/apis/echo-api/versions/2023-01-01/definitions/openapi"
-where examples/deplcreate.json contains  
-{"runtime-uri": ["https://api.contoso.com"]} 
-```
-
-UPDATE Api Deployment
-```
-az apic api deployment update -g api-center-test -s contosoeuap --name production --title "Production deployment 10" --api echo-api –w default
-```
-
-LIST Api Deployment
-```
-az apic api deployment list -g api-center-test -s contosoeuap --api-name echo-api
-```
-
-SHOW Api Deployment
-```
-az apic api deployment show -g api-center-test -s contosoeuap --name production --api-name echo-api
-```
-
-DELETE Api Deployment
-```
-Az apic api deployment delete -g api-center-test -s contosoeuap --name production --api-name echo-api
-```
-
-CREATE Environment
-```
-az apic environment create -g api-center-test -s contosoeuap --name public-3 --title "Public cloud" --kind "development" --server "C:\Users\arpishah\examples\cli-examples\payload-examples\envcreate1.json"
-Where envcreate1.json contains 
-{ 
-    "type": "Azure API Management", 
-    "managementPortalUri": [ 
-        "management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.ApiManagement/service/my-api-management-service" 
-    ] 
-} 
-```
-
-UPDATE Environment
-```
-az apic environment update -g api-center-test -s contosoeuap --name public --title "Public cloud"
-```
-
-LIST Environment
-```
-az apic environment list -g api-center-test -s contosoeuap 
-```
+API Center CLI documentation: [https://learn.microsoft.com/cli/azure/api-center/](https://learn.microsoft.com/cli/azure/service-page/api%20center?view=azure-cli-latest)
 
-SHOW Environment
-```
-az apic environment show -g api-center-test -s contosoeuap --name public 
-```
+### Tutorials
 
-DELETE Environment
-```
-az apic environment delete -g api-center-test -s contosoeuap --name public 
-```
-
-CREATE Metadata Schema
-```
-az apic metadata-schema create --resource-group api-center-test --service-name contosoeuap --name "test1" --file-name "C:\Users\arpishah\examples\cli-examples\payload-examples\schemacreate.json" 
-Where schemacreate.json contains metadata schema 
-{ 
-    "type": "string", 
-    "title": "First name", 
-    "pattern": "^[a-zA-Z0-9 ]+$" 
-} 
-```
-
-UPDATE Metadata Schema
-```
-az apic metadata-schema update --resource-group api-center-test --service-name contosoeuap --name "test1" --file-name "C:\Users\arpishah\examples\cli-examples\payload-examples\schemaupdate.json" 
-Where schemaupdate.json contains metadata schema 
-{ 
-    "type": "string", 
-    "title": "Last name", 
-    "pattern": "^[a-zA-Z0-9 ]+$" 
-}
-```
-
-LIST Metadata Schema
-```
-az apic metadata-schema list -g api-center-test -s contosoeuap
-```
-
-SHOW Metadata Schema
-```
-az apic metadata-schema show --resource-group api-center-test --service-name contosoeuap --name "test1"
-```
-
-DELETE Metadata Schema 
-```
-az apic metadata-schema delete --resource-group api-center-test --service-name contosoeuap --name "test1"
-```
-
-EXPORT Metadata Schema
-EXPORT Metadata Schema assigned to an API
-```
-az apic metadata-schema export-metadata-schema -g api-center-test -s contosoeuap --assigned-to api --file-name C:\Users\arpishah\examples\cli-examples\exported-results\exported-schema-3.json
-```
-
-EXPORT Metadata Schema assigned to a Deployment
-```
-az apic metadata-schema export-metadata-schema -g api-center-test -s contosoeuap --assigned-to deployment --file-name C:\Users\arpishah\examples\cli-examples\exported-results\exported-schema-5.json
-```
-
-EXPORT Metadata Schema assigned to an Environment
-```
-az apic metadata-schema export-metadata-schema -g api-center-test -s contosoeuap --assigned-to environment --file-name C:\Users\arpishah\examples\cli-examples\exported-results\exported-schema-6.json
-```
-
-Register API or Quick Add
-```
-az apic api register -g api-center-test -s contosoeuap --api-location "C:/Users/arpishah/examples/cli-examples/spec-examples/openai.json" --environment-name public
-az apic api register -g api-center-test -s contosoeuap --api-location "C:/Users/arpishah/examples/cli-examples/spec-examples/openai.yml" --environment-name public
-```
+* [Use the Azure CLI to manage your API inventory](https://learn.microsoft.com/azure/api-center/manage-apis-azure-cli)
+* [Register API, API version, and definition](https://learn.microsoft.com/azure/api-center/manage-apis-azure-cli#register-api-api-version-and-definition)
+* [Import APIs to your API center from Azure API Management](https://learn.microsoft.com/azure/api-center/import-api-management-apis)
diff --git a/src/apic-extension/azext_apic_extension/_help.py b/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
 """