{apic} HTML tags are rendering as empty parameter values in reference docs

[dbradish-microsoft]

Describe the bug

Problem to solve:

HTML tags in source code are causing build warnings in MicrosoftDocs/azure-docs-cli. More importantly, customer-facing reference docs are not instantiating properly -- parameter values formatted with `<>` are missing. Here's an example:

Requested solution:

These values should be escaped with a backtick. Here's an example from az webpubsub.

Related GitHub issues:

This is the same issue as these GitHub issues.

List of HTML tag instances that need update:

File name	Build error
latest/docs-ref-autogen/apic.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api/definition.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api/definition.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api/deployment.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api/deployment.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api/version.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/api/version.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/environment.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/environment.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/metadata.yml	HTML tag 'indexToRemove' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
latest/docs-ref-autogen/apic/metadata.yml	HTML tag 'value' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Related command

az apic

Errors

n/a

Issue script & Debug output

n/a

Expected behavior

n/a

Environment Summary

This GitHub issue was created at the time of Azure CLI 2.62.0

Additional context

No response

[yonzhan]

Thank you for opening this issue, we will look into it.

[github-actions]

Here are some similar issues that might help you. Please check if they can solve your problem.

• {postgres} HTML tag isn't allowed in example syntax  #27058
• {ams asset} HTML tag isn't allowed in example syntax #27055
• {afd} HTML tags are rendering as empty parameter values in reference docs #29521