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

Add missing path for Guest Config #22766

Merged

Conversation

Rusalunk
Copy link
Contributor

@Rusalunk Rusalunk commented Feb 23, 2023

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

@openapi-workflow-bot
Copy link

Hi, @Rusalunk Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    Swagger Validation Report

    ️❌BreakingChange: 23 Errors, 0 Warnings failed [Detail]
    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)
    Rule Message
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/common/v1/definitions.json#L185:5
    Old: Microsoft.GuestConfiguration/common/v1/definitions.json#L185:5
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L42:9
    Old: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L42:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L110:9
    Old: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L110:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L163:9
    Old: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L163:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L314:9
    Old: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L314:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L365:9
    Old: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L365:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L420:9
    Old: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L420:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/common/v1/definitions.json#L185:5
    Old: Microsoft.GuestConfiguration/common/v1/definitions.json#L185:5
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L42:9
    Old: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L42:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L110:9
    Old: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L110:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L163:9
    Old: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L163:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L314:9
    Old: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L314:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L365:9
    Old: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L365:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L420:9
    Old: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L420:9
    1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
    New: Microsoft.GuestConfiguration/common/v1/definitions.json#L185:5
    Old: Microsoft.GuestConfiguration/common/v1/definitions.json#L185:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L811:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L990:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1041:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json#L1097:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1161:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1340:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1391:5
    1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.GuestConfiguration/stable/2022-01-25/guestconfiguration.json#L1447:5
    ️️✔️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]
    ⚠️ PutRequestResponseScheme 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
    ⚠️ RequiredReadOnlySystemData 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ RequiredReadOnlySystemData 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ PageableOperation 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ PutRequestResponseScheme 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ PageableOperation 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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
    ⚠️ UniqueXmsExample 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
    ⚠️ ParameterNotDefinedInGlobalParameters 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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking



    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from bd8511c. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 760 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.ResourceManager.GuestConfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bd8511c. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
      cmderr	[automation_generate.sh]
      cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.3.1 -> 9.6.0
      cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.0>
      cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.0` to update!
      cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-guestconfig [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog]   - Added operation GuestConfigurationAssignmentsVMSSOperations.create_or_update
      info	[Changelog]   - Added operation group GuestConfigurationConnectedVMwarevSphereAssignmentsOperations
      info	[Changelog]   - Added operation group GuestConfigurationConnectedVMwarevSphereAssignmentsReportsOperations
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bd8511c. SDK Automation 14.0.0
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/guestconfiguration/armguestconfiguration [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Features Added
      info	[Changelog]
      info	[Changelog] - New function `*AssignmentsVMSSClient.CreateOrUpdate(context.Context, string, string, string, Assignment, *AssignmentsVMSSClientCreateOrUpdateOptions) (AssignmentsVMSSClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `NewConnectedVMwarevSphereAssignmentsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ConnectedVMwarevSphereAssignmentsClient, error)`
      info	[Changelog] - New function `*ConnectedVMwarevSphereAssignmentsClient.CreateOrUpdate(context.Context, string, string, string, Assignment, *ConnectedVMwarevSphereAssignmentsClientCreateOrUpdateOptions) (ConnectedVMwarevSphereAssignmentsClientCreateOrUpdateResponse, error)`
      info	[Changelog] - New function `*ConnectedVMwarevSphereAssignmentsClient.Delete(context.Context, string, string, string, *ConnectedVMwarevSphereAssignmentsClientDeleteOptions) (ConnectedVMwarevSphereAssignmentsClientDeleteResponse, error)`
      info	[Changelog] - New function `*ConnectedVMwarevSphereAssignmentsClient.Get(context.Context, string, string, string, *ConnectedVMwarevSphereAssignmentsClientGetOptions) (ConnectedVMwarevSphereAssignmentsClientGetResponse, error)`
      info	[Changelog] - New function `*ConnectedVMwarevSphereAssignmentsClient.NewListPager(string, string, *ConnectedVMwarevSphereAssignmentsClientListOptions) *runtime.Pager[ConnectedVMwarevSphereAssignmentsClientListResponse]`
      info	[Changelog] - New function `NewConnectedVMwarevSphereAssignmentsReportsClient(string, azcore.TokenCredential, *arm.ClientOptions) (*ConnectedVMwarevSphereAssignmentsReportsClient, error)`
      info	[Changelog] - New function `*ConnectedVMwarevSphereAssignmentsReportsClient.Get(context.Context, string, string, string, string, *ConnectedVMwarevSphereAssignmentsReportsClientGetOptions) (ConnectedVMwarevSphereAssignmentsReportsClientGetResponse, error)`
      info	[Changelog] - New function `*ConnectedVMwarevSphereAssignmentsReportsClient.List(context.Context, string, string, string, *ConnectedVMwarevSphereAssignmentsReportsClientListOptions) (ConnectedVMwarevSphereAssignmentsReportsClientListResponse, error)`
      info	[Changelog] - New struct `ConnectedVMwarevSphereAssignmentsClient`
      info	[Changelog] - New struct `ConnectedVMwarevSphereAssignmentsReportsClient`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 13 additive change(s).
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from bd8511c. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]  WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
    • ️✔️guestconfiguration [View full logs
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from bd8511c. SDK Automation 14.0.0
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
      command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.GuestConfiguration [View full logs]  [Release SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 23, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/guestconfiguration/armguestconfiguration https://apiview.dev/Assemblies/Review/8f760eb0c09d45e98600b0c74f0e8023

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed NewApiVersionRequired labels Feb 23, 2023
    @openapi-workflow-bot
    Copy link

    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.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMReview CI-FixRequiredOnFailure NewApiVersionRequired WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required and removed BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required labels Feb 27, 2023
    @openapi-workflow-bot
    Copy link

    Hi @Rusalunk, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @xiaoxuqi-ms
    Copy link
    Member

    Hi @Rusalunk please fix the linter errors and make sure the api readiness check pass

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required and removed NewApiVersionRequired labels Mar 1, 2023
    @xiaoxuqi-ms xiaoxuqi-ms merged commit bd8511c into Azure:main Mar 3, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * 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
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required FixS360 ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants