Azure / Azure/openapi-diff

Error contains no link to Problem line in Swagger

Open
#238 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
290
Forks
50
Avg merge
5d 13h
Merged PRs (30d)
5

Description

Validation failure does not contain the problem line of code in the link. It opens the top of the file instead.

title: 'No potential breaking changes',
summary: 'Compared to the target branch (**main**), this pull request introduces:\n' +
'\n' +
'   :white_check_mark:   **0** new errors\n' +
'\n' +
'   :white_check_mark:   **0** new warnings\n' +
'\n',
text: '### The following files look to be newly added in this PR:\n' +
'* [specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2022-08-07/iotdps.json]([https://github.com/Azure/azure-rest-api-specs/blob/e57017bcbb5450d587bbbb316ea30ad71af706af/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2022-08-07/iotdps.json)\n'](https://github.com/Azure/azure-rest-api-specs/blob/e57017bcbb5450d587bbbb316ea30ad71af706af/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/preview/2022-08-07/iotdps.json)/n') +
'

\n' +
'**There were no files containing new errors or warnings.**\n' +
'\n' +
'

\n' +
'Thanks for using breaking change tool to review.\n' +
'If you encounter any issue(s), please open issue(s) at https://github.com/Azure/openapi-diff/issues.'
}

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the validation failure using the Swagger/OpenAPI example in the issue and trace how the generated link is built. Done means the link opens the source line containing the problem instead of the top of the file; no specific file or test is named, so inspect the validation and error-reporting entry points first.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.