Azure / Azure/azure-openapi-validator
R3011 check being applied to examples where property name is "Description"
- Dominant language
- TypeScript
- Stars
- 53
- Forks
- 57
- Avg merge
- 1d 23h
- Merged PRs (30d)
- 2
Description
PR in question: #15439
LintDiff gate: https://github.com/Azure/azure-rest-api-specs/pull/15439/checks?check_run_id=3341238861
Fails with: Description must not match the name of the node it is supposed to describe. Node name:'string' Description:'string'
Our service has a few definitions where "Description" is a property, BatchDeployment.Description, for example. The issue is that the R3011 check is being applied to example files' request property. For example, the BatchDeployment CreateOrUpdate example has "description": "string" in its request body. If I change this to something like "description": "lorem ipsum", then the R3011 check will pass on that case.
Is the R3011 check supposed to be applied to example json requests? It seems like the point of R3011 is to ensure schema definitions have proper descriptions, so I think it is incorrect for R3011 to be applied to example json requests.
Contributor guide
Assessment
This issue has not been assessed yet.