-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Dev labservices microsoft.lab services 2022 08 01 #20121
Dev labservices microsoft.lab services 2022 08 01 #20121
Conversation
Hi, @kamperiadis 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.9.6)] | new version | base version |
---|---|---|
Images.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
LabPlans.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
LabServices.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
Labs.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
OperationResults.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
Schedules.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
Skus.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
Usages.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
Users.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
VirtualMachines.json | 2022-08-01(d4a2cea) | 2021-11-15-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version has a different format than the previous one. New: Microsoft.LabServices/stable/2022-08-01/Schedules.json#L376:9 Old: Microsoft.LabServices/preview/2021-11-15-preview/Schedules.json#L376:9 |
|
The read only property has changed from 'true' to 'false'. New: Microsoft.LabServices/stable/2022-08-01/Usages.json#L85:9 Old: Microsoft.LabServices/preview/2021-11-15-preview/Usages.json#L85:9 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-08 | package-2022-08(d4a2cea) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.LabServices/stable/2022-08-01/LabServices.json#L7 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.LabServices/stable/2022-08-01/OperationResults.json#L7 |
️❌
Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag does not contain all APIs in this RP. Please make sure the missing API swaggers are in the default tag. readme: specification/labservices/resource-manager/readme.md json: Microsoft.LabServices/stable/2018-10-15/ML.json |
️❌
ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
API Readiness check failed. Please make sure your service is deployed. |
"code: MissingApiVersionParameter, message: The api-version query parameter (?api-version=) is required for all requests." |
️❌
~[Staging] ServiceAPIReadinessTest: 2 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: ResourceType 'labPlans' should be deployed in 'West Central US' on apiVersion '2022-08-01'.: expected [ Array(9) ] to satisfy [Function]" |
RUNTIME_ERROR |
"errorCode: AssertionError, errorMessage: ResourceType 'labPlans' should be deployed in 'West Central US' on apiVersion '2022-08-01'.: expected [ Array(9) ] to satisfy [Function]" |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️
SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/d4a2ceae8dee937042a4bcd897279570e38174a0/specification/labservices/resource-manager/readme.md#tag-package-2022-08">labservices/resource-manager/readme.md#package-2022-08
Rule | Message |
---|---|
"readme":"labservices/resource-manager/readme.md", "tag":"package-2022-08", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️
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.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @kamperiadis, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @kamperiadis your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
@ArcturusZhang help to take a look at this go sdk breaking change. |
}, | ||
"paths": { | ||
"/providers/Microsoft.LabServices/operations": { | ||
"parameters": [ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The parameters should be in "get", not path level.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mmm is that really the issue? Because that's what we had in the last preview version we released
Line 43 in 8006549
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had a separate discussion on this. This should be resolved once we deploy our API in production.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should not create duplicate models in the common-types
@@ -0,0 +1,62 @@ | |||
{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why we need this file added here? We already have ErrorResponse
and ErrorDetails
here which are exactly the same as the things in this file:
azure-rest-api-specs/specification/common-types/resource-management/v3/types.json
Line 300 in 1b3b9c1
"ErrorResponse": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approve since now the PR shows no Go breaking change
* Adds base for updating Microsoft.LabServices from version preview/2021-11-15-preview to version 2022-08-01 * Updates readme * Updates API version in new specs and examples * refactor: update the v2022-08-01 specifications * Fix prettier issues * Add missing clouderror.json file * Add missing xmsidentifier clouderror property * Add x-ms-identifiers to Skus.json file * Resolve code style issues in clouderror.json * Add clouderror to custom-words.txt * Use ErrorResponse instead of CloudError * Fix duration format in examples * Fix duration format in Users examples * Fix duration format in LabPlans examples
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.