Azure / Azure/azure-cli

Customer feedback | az apim api import --soap-api-type parameter | What are the options?

Open
#30,082 1 comment 0 reactions 0 assignees View on GitHub
act-observability-squad API Management Auto-Assign bug Service Attention
Dominant language
Python
Stars
4.6k
Forks
3.5k
Avg merge
3d 2h
Merged PRs (30d)
60

Description

### Describe the bug

This GitHub issue is being copied from MicrosoftDocs/azure-docs-cli [4645](https://github.com/MicrosoftDocs/azure-docs-cli/issues/4645).

************************************
### Engineering request
1. Please update the `short-summary` of the `--soap-api-type` parameter to include an example similar to `The type of API when file format is WSDL. For example "xxxxxx".`
1. According to the [Azure CLI guidelines for reference content](https://github.com/Azure/azure-cli/blob/dev/doc/reference_doc_guidelines.md#examples) every parameter should be used in an example. Please provide additional example code blocks and include the `--soap-api-type` in at least one.

### Reference link
https://learn.microsoft.com/en-us/cli/azure/apim/api#az-apim-api-import

### Customer feedback
**Type of issue**

Missing information

**Feedback**

As the title says, it's unclear from the CLI documentation which values(s) are expected for the parameter `--soap-api-type`.
It's definitely not a boolean flag, because I get this error:
```
ERROR: argument --soap-api-type: expected one argument
```

Anywhere else I could find what is the options are?

**Page URL**

https://learn.microsoft.com/en-us/cli/azure/apim/api?view=azure-cli-latest

**Content source URL**

https://github.com/MicrosoftDocs/azure-docs-cli/blob/main/latest/docs-ref-autogen/apim/api.yml

### Related command

az apim api import

### Errors

n/a

### Issue script & Debug output

n/a

### Expected behavior

n/a

### Environment Summary

Azure CLI 2.65.0

### Additional context

n/a

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.