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.

Sign up for GitHub

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

Jump to bottom

Swagger Model Validation flags readOnly properties as missing from request body example #6840

Closed
mikekistler opened this issue Aug 23, 2023 · 2 comments
Closed

Swagger Model Validation flags readOnly properties as missing from request body example #6840

mikekistler opened this issue Aug 23, 2023 · 2 comments
Assignees
@scbedd
Labels
Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.

Comments

@mikekistler
Copy link
Member

The Swagger Model Validation PR pipeline check is flagging as errors readOnly properties with OBJECT_MISSING_REQUIRED_PROPERTY because they are not present in the request body example.

An example is PR 25444:

image

The problem likely stems from the (incorrect) assumption that readOnly could not be specified on required properties.
@github-actions github-actions bot added the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Aug 23, 2023
@keryul keryul mentioned this issue Aug 25, 2023
Merged
@mikekistler mikekistler mentioned this issue Aug 26, 2023
Closed
@kurtzeborn kurtzeborn added Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo. and removed needs-triage This is a new issue that needs to be triaged to the appropriate team. labels Aug 28, 2023
@mikekistler mikekistler mentioned this issue Aug 30, 2023
Merged
3 tasks
@mjmadhu
Copy link
Member

mjmadhu commented Sep 4, 2023

@mikekistler @kurtzeborn we're blocked due to this issue and have our public preview SDK PLR pending sign-off as explained in the parent issue - https://github.com/Azure/typespec-azure/issues/3428. Could you please help with an ETA for resolution or any work-around for time-being?

@scbedd scbedd mentioned this issue Sep 12, 2023
Merged
6 tasks
@mikekistler mikekistler mentioned this issue Sep 22, 2023
Open
@scbedd
Copy link
Member

scbedd commented Nov 17, 2023

Hey apologies for the delay here. This is now merged.

We needed to add a follow-up PR after enabling deep regression tests. There were some insidious issues with the PR as-was, and I was really struggling for the free cycles to actually learn enough to understand what was going wrong.

We have also rolled out the change to SwaggerValidation and ModelValidation.

@scbedd scbedd closed this as completed Nov 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@scbedd scbedd

Labels
Central-EngSys This issue is owned by the Engineering System team. Spec PR Tools Tooling that runs in azure-rest-api-specs repo.
Projects
Azure SDK EngSys ♨️🌲🌲
Archived in project
Milestone
No milestone
Development

No branches or pull requests
4 participants
@kurtzeborn @scbedd @mjmadhu @mikekistler