Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger BreakingChange - false positive related to x-ms-enum field #7749

Open
AndrewNivenMSFT opened this issue Feb 26, 2024 · 1 comment
Open
Assignees
Labels
Breaking Changes Improvements to Breaking Changes tooling Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.

Comments

@AndrewNivenMSFT
Copy link
Member

This Swagger BreakingChange job failed: https://github.com/Azure/azure-rest-api-specs/pull/27895/checks

The error message is that certain x-ms-enum fields are missing the required property "name". The PR is very small and has no impact on any fields related to the ones with the warnings, so I believe this is a false positive.

It appears to be related to a similar problem that this API had with LintDiff, where TypeSpec's generation of static enums was not compatible with LintDiff's expectations. See https://teams.microsoft.com/l/message/19:[email protected]/1705001720452?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=3e17dcb0-4257-4a30-b843-77f47f1d4121&parentMessageId=1705001720452&teamName=Azure%20SDK&channelName=TypeSpec%20Discussion&createdTime=1705001720452 for more details.

@konrad-jamrozik konrad-jamrozik self-assigned this Mar 19, 2024
@konrad-jamrozik konrad-jamrozik added Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo. labels Mar 19, 2024
@konrad-jamrozik
Copy link
Contributor

@AndrewNivenMSFT thx for the report. This is a known problem we are working on. See:

@konrad-jamrozik konrad-jamrozik added the Breaking Changes Improvements to Breaking Changes tooling label Jun 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Changes Improvements to Breaking Changes tooling Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.
Projects
Status: 📋 Backlog
Status: 📋 Backlog
Development

No branches or pull requests

2 participants