Azure / Azure/azure-openapi-validator
Descriptions should be plain text (no HTML tags, no markdown tags, etc)
- Dominant language
- TypeScript
- Stars
- 53
- Forks
- 57
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Description
### Lint rule description
`
` cannot be processed by upstream Autorest and SDK doc generators and is therefore not allowed.
### Related swagger example
```
"description": "The query option to fetch Capacity Reservation Group Resource Ids.
'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription.
'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription.
'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription."
```
### Category
SDK
### Severity level
Error
### Applies to
Management plane API spec
### How to fix the violation
Remove the `
` tags and format your text as plain text.
```
"description": "The query option to fetch Capacity Reservation Group Resource Ids.
'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription.
'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription.
'All' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription and created in the subscription."
```
### What't the impact if breaking the rule
The `
` tags will appear as plain text on all documentation and code upstream of the swagger specs (SDK, client tools). This is confusing to customers and degrades the development experience.
Contributor guide
Assessment
This issue has not been assessed yet.