Azure / Azure/bicep

Add ability to report swagger issue directly from tooling

Open
#1,113 3 comments 5 reactions 0 assignees View on GitHub
enhancement
Dominant language
Bicep
Stars
3.6k
Forks
830
Avg merge
1d 21m
Merged PRs (30d)
79

Description

If there is a warning for a missing type or a false positive due to an incorrect swagger definition, it would be nice to allow a report to be sent directly from the VS Code extension. A report could mean opening up an issue in the rest-api-spec repo.

We could also provide an ability to highlight a property name if there were enum values missing and the tooling should be able to provide a JSON path to the relevant swagger property.

Contributor guide

Open the contributing guide

Research direction

Start in the VS Code extension tooling that emits warnings for missing types or false positives from Swagger definitions, and review how it identifies the relevant property. Check the rest-api-spec repository workflow for opening reports, then define completion as submitting a report directly from the extension and exposing a JSON path for missing enum values.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, openapi, vscode
Domain
developer-experience, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.