-
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
Add missing path for Guest Config #22766
Add missing path for Guest Config #22766
Conversation
Hi, @Rusalunk 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. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
definitions.json | 2018-06-30-preview(bb37da3) | 2018-06-30-preview(main) |
guestconfiguration.json | 2020-06-25(bb37da3) | 2020-06-25(main) |
guestconfiguration.json | 2022-01-25(bb37da3) | 2022-01-25(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 30 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) | new version | base version |
---|---|---|
package-2022-01-25 | package-2022-01-25(bb37da3) | package-2022-01-25(main) |
package-2021-01-25 | package-2021-01-25(bb37da3) | package-2021-01-25(main) |
package-2020-06-25 | package-2020-06-25(bb37da3) | package-2020-06-25(main) |
package-2018-11-20 | package-2018-11-20(bb37da3) | package-2018-11-20(main) |
package-2018-06-30-preview | package-2018-06-30-preview(bb37da3) | package-2018-06-30-preview(main) |
package-2018-01-20-preview | package-2018-01-20-preview(bb37da3) | package-2018-01-20-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
Rule | Message | Related RPC [For API reviewers] |
---|---|---|
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'GuestConfigurationConnectedVMwarevSphereAssignments_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L812 |
||
The response of operation:'GuestConfigurationConnectedVMwarevSphereAssignments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L812 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update guest configuration assignment Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L818 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L823 |
||
The response of operation:'GuestConfigurationConnectedVMwarevSphereAssignments_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L881 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a guest configuration assignment Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L887 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L892 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Delete an guest configuration assignment Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L941 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L946 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List all guest configuration assignments for a virtual machine Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L997 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1002 |
||
Based on the response model schema, operation 'GuestConfigurationConnectedVMwarevSphereAssignmentsReports_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1042 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List all guest configuration assignments for a virtual machine Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1048 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1053 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a guest configuration assignment report by Id for a virtual machine Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1104 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1109 |
||
A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'GuestConfigurationConnectedVMwarevSphereAssignments_CreateOrUpdate' Request Model: 'parameters[4].schema' Response Model: 'responses[200].schema' Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1162 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Create or update guest configuration assignment Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1168 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1173 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a guest configuration assignment Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1237 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1242 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Delete an guest configuration assignment Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1291 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1296 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List all guest configuration assignments for a virtual machine Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1347 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1352 |
||
Based on the response model schema, operation 'GuestConfigurationConnectedVMwarevSphereAssignmentsReports_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1392 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List all guest configuration assignments for a virtual machine Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1398 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1403 |
||
Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get a guest configuration assignment report by Id for a virtual machine Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1454 |
||
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1459 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'guestConfigurationAssignmentName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L30 |
TrackedResourcePatchOperation |
Tracked resource 'GuestConfigurationAssignment' must have patch operation that at least supports the update of tags. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L30 |
ParametersOrder |
The parameters:guestConfigurationAssignmentName,resourceGroupName,vmName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L31 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,vmName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L99 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,vmName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L152 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L184 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L230 |
GetOperation200 |
The get operation should only return 200. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L281 |
ResourceNameRestriction |
The resource name parameter 'guestConfigurationAssignmentName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L353 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,vmName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L354 |
ResourceNameRestriction |
The resource name parameter 'guestConfigurationAssignmentName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L408 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,reportId,vmName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L409 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L470 |
ResourceNameRestriction |
The resource name parameter 'guestConfigurationAssignmentName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L470 |
ParametersOrder |
The parameters:guestConfigurationAssignmentName,resourceGroupName,machineName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L471 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,machineName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L539 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,machineName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L592 |
DeleteOperationResponses |
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L624 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L643 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L694 |
ResourceNameRestriction |
The resource name parameter 'guestConfigurationAssignmentName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L694 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,machineName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L695 |
ResourceNameRestriction |
The resource name parameter 'machineName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L749 |
ResourceNameRestriction |
The resource name parameter 'guestConfigurationAssignmentName' should be defined with a 'pattern' restriction. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L749 |
ParametersOrder |
The parameters:resourceGroupName,guestConfigurationAssignmentName,reportId,machineName should be kept in the same order as they present in the path. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L750 |
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.GuestConfiguration/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1180 |
MissingTypeObject |
The schema 'GuestConfigurationAssignmentList' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1204 |
MissingTypeObject |
The schema 'GuestConfigurationAssignment' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1216 |
RequiredPropertiesMissingInResourceModel |
Model definition 'GuestConfigurationAssignment' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1216 |
MissingTypeObject |
The schema 'GuestConfigurationNavigation' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1231 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️
~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
Tag package-2022-01-25; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 27, untested: 18, failed: 0, passed: 9
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
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 Generation Artifacts
|
Generated ApiView
|
NewApiVersionRequired reason: |
Hi @Rusalunk, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
Hi @Rusalunk, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @Rusalunk please fix the linter errors and make sure the api readiness check pass |
… into user/rusalunk/AddNewResourcePathGuestConfig
* Add missing path for Guest Config * Add missing path for Guest Config * Add missing path * Add missing path * update pattern * Add missing path * validation check fix * update pattern * validation check fix * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file * Add Scenario test file
ARM API Information (Control Plane)
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 (MS Employees Only):
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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.