`az apim import` does not set the description

[matt-goldman]

az apim import does not set the description

Describe the bug
Setting the Description property of an API in APIM does not work via Azure CLI.

To Reproduce

az apim api import -g MyRG -n my-apim `
	--specification-format OpenApiJson `
	--specification-url https://myservice.azurewebsites.net/api/specification.json `
	--display-name 'My Service' `
	--description 'Test description' `
	--api-id MyService `
	--api-type http `
	--protocols https `
	--service-url https://myservice.azurewebsites.net `
	--subscription-required true `
	--subscription-key-header-name my-key `
	--subscription-key-query-param-name my-key `
    --path '/myservice'

Expected behavior
The Description property of the API should be set.

Environment summary

  az --version
azure-cli                         2.31.0

core                              2.31.0
telemetry                          1.0.6

Python location 'C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\python.exe'
Extensions directory 'C:\Users\mattg\.azure\cliextensions'

Python (Windows) 3.8.9 (tags/v3.8.9:a743f81, Apr  6 2021, 13:22:56) [MSC v.1928 32 bit (Intel)]

Legal docs and information: aka.ms/AzureCliLegal

[jiasli]

Routing to service team to take a look. Please expect delay due to the holiday season.

Thanks for the feedback! We are routing this to the appropriate team for follow-up. cc @miaojiang.

Issue Details

---

az apim import does not set the description

Describe the bug
Setting the Description property of an API in APIM does not work via Azure CLI.

To Reproduce

az apim api import -g MyRG -n my-apim `
	--specification-format OpenApiJson `
	--specification-url https://myservice.azurewebsites.net/api/specification.json `
	--display-name 'My Service' `
	--description 'Test description' `
	--api-id MyService `
	--api-type http `
	--protocols https `
	--service-url https://myservice.azurewebsites.net `
	--subscription-required true `
	--subscription-key-header-name my-key `
	--subscription-key-query-param-name my-key `
    --path '/myservice'

Expected behavior
The Description property of the API should be set.

Environment summary

  az --version
azure-cli                         2.31.0

core                              2.31.0
telemetry                          1.0.6

Python location 'C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\python.exe'
Extensions directory 'C:\Users\mattg\.azure\cliextensions'

Python (Windows) 3.8.9 (tags/v3.8.9:a743f81, Apr  6 2021, 13:22:56) [MSC v.1928 32 bit (Intel)]

Legal docs and information: aka.ms/AzureCliLegal

Author:	matt-goldman
Assignees:	-
Labels:	Service Attention, question, API Management, customer-reported, needs-triage
Milestone:	-

[navba-MSFT]

@matt-goldman Apologies for the late reply. I am able to reproduce this issue. I have reached out to the Service owners to check if they can provide an update on the fix. In the meantime if you have any questions on this you may feel free to ask on this thread.

[sandi91]

Still same in Sep 2023. any updates on this please?

[markdebruijne]

I think it is even worse what the current behavior is when executing a az apim api import

• When supplying a --description the new/instructed description value is ignored BUT the existing description is cleared/blanked in case of an existing API with a filled description
  • It seems that it doesn't overwrite the OpenAPI spec info object `{ "info": { "description: "" } }, if provided
  • It seems that is doesn't check if such info > description property is specified in the OpenAPI spec file, which is an optional property according the documentation. It parses as null and overwrites the APIM API description filled with null as result
• NOT supplying --description is overwriting the APIM API description, where it (similar to previous bullet) overwrites existing APIM API description although none is specific in that OpenAPI spec info object.

I prefer to not have the displayname and description of APIM API to be fed from "other teams" maintaining the OpenAPI specification (similar to paths for instances). The --display-name is working in a helping manner, but the --description is not.

Any idea @navba-MSFT when this will be addressed? Sounds like a simple if-statement to get both arguments (displayname vs description to behavior similar. Don't understand why this would take > 2,5 years?