[Hub Generated] Publish private branch 'release-devcenter-Microsoft.DevCenter-2022-11-11-preview' #21454
Conversation
…03-01-preview to version 2022-11-11-preview
chrissmiller
requested review from
JeffreyRichter and
bexxx
and removed request for
a team
|
The PR is created based on the updates in the private branch. The updates in the PR has already been reviewed and approved with this PR Azure/azure-rest-api-specs-pr/9193 |
|
Hi, @chrissmiller Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| devbox.json | 2022-11-11-preview(8f8a2a0) | 2022-03-01-preview(main) |
| devcenter.json | 2022-11-11-preview(8f8a2a0) | 2022-03-01-preview(main) |
| environments.json | 2022-11-11-preview(8f8a2a0) | 2022-03-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-11 | package-preview-2022-11(8f8a2a0) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L1459 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'DevBoxes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L369 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L62 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L113 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L164 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L219 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L296 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L342 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L409 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L476 |
|
Per the Noun_Verb convention for Operation Ids, the noun 'Environments' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L723 |
| Path parameter 'projectName' should appear before 'poolName'. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L102 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L212 |
|
| OperationId for put method should contain both 'Create' and 'Update' Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L476 |
|
| Schema name should be Pascal case. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L1230 |
|
| Schema should have a description or title. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json#L1317 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L69 |
|
| Error response should contain a x-ms-error-code header. Location: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json#L108 |
|
| All success responses except 202 & 204 should define a response body. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L345 |
|
| All success responses except 202 & 204 should define a response body. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L415 |
|
| All success responses except 202 & 204 should define a response body. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L482 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L1002 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L1116 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DevCenter/preview/2022-11-11-preview/environments.json#L1121 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/devcenter/data-plane/readme.md json: Microsoft.DevCenter/preview/2022-11-11-preview/devcenter.json |
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
|
@jhendrixMSFT let us know if there are any action items we need to take on the PR or if it's OK to merge! |
specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json
Show resolved
Hide resolved
specification/devcenter/data-plane/Microsoft.DevCenter/preview/2022-11-11-preview/devbox.json
Show resolved
Hide resolved
|
Hi @chrissmiller, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Swagger APIView failure is due to an expected circular reference (CloudErrorBody details is a list of CloudErrorBody). Confirmed that running locally with details removed succeeds. Swagger LintDiff errors have been justified in private repo PR. @jhendrixMSFT let us know if there are other issues we can tackle! |
|
@mikekistler if the lintdiff failures are approved, do we need to add any suppressions so the task passes in the future? |
|
@jhendrixMSFT I don't think this API has been reviewed yet by the API Stewardship board. And those lintDiff failures look like things we probably want fixed rather than suppressed. |
@mikekistler This was approved under this issue with this private repo PR. I provided the justification for the lintDiff failures here -- basically, if we follow the suggested fix from this failure we receive a new one because the suggested format is not approved. Additionally, the suggested fix causes issues with generated code and makes the experience more complex for customers. |
|
@chrissmiller Sorry -- I missed that. My mistake. Then I think @jhendrixMSFT is right that we should add suppressions for any approved deviances. |
No worries! Are there any docs on how to set up the suppression for these? Didn't see anything when I searched but not sure if I missed them |
|
cc @jhendrixMSFT as well for the suppressions question |
|
Found it here. |
AzureRestAPISpecReview
added
SuppressionReviewRequired
and removed
CI-FixRequiredOnFailure
labels
|
Hi @chrissmiller, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
Thank you! Added the suppression and submitted the suppression request for the LintDiff errors. I also opened an issue on the APIView tool here since the problem is with the check tool. That should cover the blocking LintDiff errors, now only the staging check is failing (which I believe is expected, and the suppressions only apply to the blocking check?). |
…evCenter-2022-11-11-preview' (Azure#21454) * Adds base for updating Microsoft.DevCenter from version preview/2022-03-01-preview to version 2022-11-11-preview * Updates readme * Updates API version in new specs and examples * Add updated examples and spec * Run prettier and resolve swagger checks * Update client loc and format * Restore URL format to satisfy HostParametersValidation * Update host template naming * Update to use "endpoint" * Update formats and naming * Remove artifacts * Remove url formatting * Expose hibernation support info * Update naming based on feedback, restore hibernate query param * Run prettier, fix ref * Incorporate example changes * Align param naming * Align user ID naming * Remove unnecessary LRO options * Remove delete environment LRO options * Fix reference that breaks swagger api view * Add suppression * Fix suppression format
…evCenter-2022-11-11-preview' (Azure#21454) * Adds base for updating Microsoft.DevCenter from version preview/2022-03-01-preview to version 2022-11-11-preview * Updates readme * Updates API version in new specs and examples * Add updated examples and spec * Run prettier and resolve swagger checks * Update client loc and format * Restore URL format to satisfy HostParametersValidation * Update host template naming * Update to use "endpoint" * Update formats and naming * Remove artifacts * Remove url formatting * Expose hibernation support info * Update naming based on feedback, restore hibernate query param * Run prettier, fix ref * Incorporate example changes * Align param naming * Align user ID naming * Remove unnecessary LRO options * Remove delete environment LRO options * Fix reference that breaks swagger api view * Add suppression * Fix suppression format
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Data Plane API - Pull Request
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your engagement record.
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links