Descriptions should be plain text (no HTML tags, no markdown tags, etc)
@mikeharder is already working on this.
Since Jun 7, 2024.
Assessment
This issue has not been assessed yet.
Description
Lint rule description
<br> 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.
<br>'CreatedInSubscription' enables fetching Resource Ids for all capacity reservation group resources created in the subscription.
<br>'SharedWithSubscription' enables fetching Resource Ids for all capacity reservation group resources shared with the subscription.
<br>'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 <br> 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 <br> 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.
- Dominant language
- TypeScript
- Stars
- 53
- Forks
- 57
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Azure/azure-openapi-validator
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
Azure/azure-openapi-validator#235 ·
-
Azure/azure-openapi-validator#849 · 1 assignee ·
-
Azure/azure-openapi-validator#835 · 1 assignee ·
-
Azure/azure-openapi-validator#812 · 3 comments · 1 assignee ·
-
Azure/azure-openapi-validator#809 · 2 comments · 1 assignee ·
All issues in Azure/azure-openapi-validator
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·