Azure / Azure/azure-rest-api-specs
VS Code is suggesting "description" values be added to example files
- Dominant language
- TypeSpec
- Stars
- 3.1k
- Forks
- 5.9k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 444
Description
I've removed a few of these in PRs, but it is a confusing change for reviews when it is included with other things.
Right now ModelValidation does flag these (if the swagger doesn't actually have a "description" property on the model).
I've filed an issue with VS Code here https://github.com/microsoft/vscode/issues/74744, so it's not a locale config issue, but an upstream thing.
Contributor guide
Research direction
Start by reproducing the VS Code suggestion against the repository's example files and inspect ModelValidation, then compare the behavior with the linked upstream VS Code issue. The issue does not name a file or specify a repository-side fix, so first establish whether anything in this repository can prevent the unwanted description additions or their validation impact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, vscode
- Domain
- api, developer-experience
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100