Skip to content

Conversation

@grizzlytheodore
Copy link
Contributor

@grizzlytheodore grizzlytheodore commented Jun 7, 2022

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.

grizzlytheodore and others added 2 commits March 21, 2022 23:43
* Update cloud service swagger file and examples

* Update cloudService.json

Co-authored-by: Arpit Khandelwal <arkhande@microsoft.com>
@openapi-workflow-bot
Copy link

Hi, @grizzlytheodore 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

    1 similar comment
    @openapi-workflow-bot
    Copy link

    Hi, @grizzlytheodore 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

    Swagger pipeline can not start as the pull request has merge conflicts.

    1 similar comment
    @openapi-pipeline-app
    Copy link

    Swagger pipeline can not start as the pull request has merge conflicts.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 7, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 2 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R4021 - DescriptionAndTitleMissing 'SubResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L144
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Get Cloud Service Role
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L576


    The following errors/warnings exist before current PR submission:

    Only 28 items are listed, please refer to log for more details.

    Rule Message
    R4037 - MissingTypeObject The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L38
    R4037 - MissingTypeObject The schema 'ApiErrorBase' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L38
    R4037 - MissingTypeObject The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L55
    R4037 - MissingTypeObject The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L55
    R4037 - MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L68
    R4037 - MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L68
    R4037 - MissingTypeObject The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L77
    R4037 - MissingTypeObject The schema 'ApiError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L77
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L109
    R4037 - MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L144
    R4037 - MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L144
    R4037 - MissingTypeObject The schema 'SubResourceReadOnly' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L153
    R4037 - MissingTypeObject The schema 'ExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Compute/stable/2022-04-04/common.json#L207
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L38
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L97
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L168
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L292
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L350
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L408
    R4039 - ParametersOrder The parameters:roleInstanceName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L466
    R4039 - ParametersOrder The parameters:roleName,resourceGroupName,cloudServiceName should be kept in the same order as they present in the path.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L527
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'CloudServicesUpdateDomain_WalkUpdateDomain' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L1346
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L1858
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L1940
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L2079
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L2120
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L2233
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: stable/2022-04-04/CloudServiceRP/cloudService.json#L2335
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_API_VERSION The default tag contains multiple API versions swaggers.
    readme: specification/compute/resource-manager/readme.md
    tag: specification/compute/resource-manager/readme.md#tag-package-2022-04-04
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️⚠️Cross-Version Breaking Changes: 94 Warnings warning [Detail]
    The following breaking changes are detected by comparison with the latest stable version:

    Only 28 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L76:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L59:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Compute/stable/2022-04-04/common.json#L71:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L1730:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Compute/stable/2022-04-04/common.json#L81:11
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L1700:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Compute/stable/2022-04-04/common.json#L90:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L1708:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L1733:11
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L1768:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L149:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L127:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L206:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L182:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L270:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L244:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L330:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L302:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L388:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L358:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L446:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L414:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L507:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L474:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L565:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L524:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L615:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L572:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2021:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2048:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2057:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2084:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2061:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2088:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2156:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2166:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2196:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2203:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2200:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2207:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2165:9
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L2175:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L676:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L639:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L748:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L705:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L797:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L757:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L849:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L806:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L899:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L856:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L935:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L892:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L981:13
    Old: Microsoft.Compute/stable/2021-03-01/cloudService.json#L938:13


    The following breaking changes are detected by comparison with latest preview version:

    Only 28 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L76:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L50:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Compute/stable/2022-04-04/common.json#L71:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1412:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Compute/stable/2022-04-04/common.json#L81:11
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1386:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: Microsoft.Compute/stable/2022-04-04/common.json#L90:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1390:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L1733:11
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1450:11
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L149:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L115:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L206:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L165:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L270:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L221:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L330:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L274:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L388:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L325:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L446:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L376:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L507:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L430:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L565:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L481:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L615:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L524:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2021:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1726:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2057:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1756:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2061:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1759:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2156:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1815:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2196:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1851:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one 'string'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2200:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1855:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L2165:9
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L1823:9
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L676:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L580:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L748:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L652:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L797:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L696:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L849:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L743:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L899:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L788:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L935:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L819:13
    ⚠️ 1026 - TypeChanged The new version has a different type '' than the previous one 'object'.
    New: stable/2022-04-04/CloudServiceRP/cloudService.json#L981:13
    Old: Microsoft.Compute/preview/2020-10-01-preview/cloudService.json#L860:13
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 7, 2022

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-compute - 27.1.0
    ️✔️azure-sdk-for-go - profiles/2020-09-01/compute/mgmt/compute - v65.0.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2017-01-31/containerservice - v65.0.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2016-09-30/containerservice - v65.0.0
    ️✔️azure-sdk-for-go - containerservice/mgmt/2016-03-30/containerservice - v65.0.0
    azure-sdk-for-go - compute/mgmt/2021-12-01/compute - v65.0.0
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2021-11-01/compute - v65.0.0
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2021-08-01/compute - v65.0.0
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2021-07-01/compute - v65.0.0
    +	Field `ProvisioningDetails` of struct `RestorePointProperties` has been removed
    +	Struct `RestorePointProvisioningDetails` has been removed
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2021-04-01/compute - v65.0.0
    +	Field `ProvisioningDetails` of struct `RestorePointProperties` has been removed
    +	Struct `RestorePointProvisioningDetails` has been removed
    azure-sdk-for-go - compute/mgmt/2021-03-01/compute - v65.0.0
    +	Field `ConsistencyMode` of struct `RestorePoint` has been removed
    +	Field `ExcludeDisks` of struct `RestorePoint` has been removed
    +	Field `ProvisioningDetails` of struct `RestorePoint` has been removed
    +	Field `ProvisioningState` of struct `RestorePoint` has been removed
    +	Field `PublicIPAddressSkuName` of struct `PublicIPAddressSku` has been removed
    +	Field `PublicIPAddressSkuTier` of struct `PublicIPAddressSku` has been removed
    +	Field `SourceMetadata` of struct `RestorePoint` has been removed
    +	Struct `RestorePointProvisioningDetails` has been removed
    azure-sdk-for-go - compute/mgmt/2020-12-01/compute - v65.0.0
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2020-06-30/compute - v65.0.0
    +	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
    +	Field `FileName` of struct `UserArtifactSource` has been removed
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2020-06-01/compute - v65.0.0
    +	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
    +	Field `FileName` of struct `UserArtifactSource` has been removed
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2019-12-01/compute - v65.0.0
    +	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
    +	Field `FileName` of struct `UserArtifactSource` has been removed
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    azure-sdk-for-go - compute/mgmt/2019-07-01/compute - v65.0.0
    +	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
    +	Field `FileName` of struct `UserArtifactSource` has been removed
    azure-sdk-for-go - compute/mgmt/2019-03-01/compute - v65.0.0
    +	Field `ContentType` of struct `GalleryApplicationVersionPublishingProfile` has been removed
    +	Field `FileName` of struct `UserArtifactSource` has been removed
    ️✔️azure-sdk-for-go - compute/mgmt/2018-10-01/compute - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2018-06-01/compute - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2018-04-01/compute - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2017-12-01/compute - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2017-09-01/skus - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2017-03-30/compute - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2016-03-30/compute - v65.0.0
    ️✔️azure-sdk-for-go - compute/mgmt/2015-06-15/compute - v65.0.0
    ️✔️azure-sdk-for-go - preview/containerservice/mgmt/2015-11-01-preview/containerservice - v65.0.0
    azure-sdk-for-go - preview/compute/mgmt/2020-10-01-preview/compute - v65.0.0
    +	Type of `OrchestrationServiceStateInput.ServiceName` has been changed from `OrchestrationServiceNames` to `*string`
    ️✔️azure-sdk-for-go - preview/compute/mgmt/2016-04-30-preview/compute - v65.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	sudo apt-get install -y dotnet-sdk-6.0
      command	autorest --version=2.0.4421 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/compute/resource-manager/readme.md
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] realpath(): Permission denied
      cmderr	[Autorest] No usable version of the libssl was found
      cmderr	[Autorest] FATAL: csharp/simplifier - FAILED
      cmderr	[Autorest] FATAL: Error: [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      cmderr	[Autorest] Process() cancelled due to exception : [Exception] AutoRest extension '@microsoft.azure/autorest.csharp' terminated.
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: autorest
      warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. 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] WARN config global `--global`, `--local` are deprecated. Use `--location=global` instead.
    • ️✔️track2_azure-mgmt-compute [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
      cmderr	[generate.py] SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
      cmderr	[generate.py] SLF4J: Defaulting to no-operation (NOP) logger implementation
      cmderr	[generate.py] SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    • ️✔️azure-resourcemanager-compute-generated [View full logs]  [Preview SDK Changes]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. SDK Automation 14.0.0
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
      cmderr	[automation_init.sh] npm WARN deprecated read-package-tree@5.1.6: The functionality that this package provided is now in @npmcli/arborist
      cmderr	[automation_init.sh]  deprecated uuid@3.4.0: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
      cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/types@0.2.0: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
      cmderr	[automation_init.sh] deprecated @azure/storage-blob@10.5.0: This version has been deprecated, please upgrade to the version tagged as latest
      cmderr	[automation_init.sh] npm WARN @octokit/plugin-request-log@1.0.4 requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
      warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
      command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-compute [View full logs]  [Preview SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added Interface SystemData
      info	[Changelog]   - Added Type Alias CloudServiceSlotType
      info	[Changelog]   - Interface CloudService has a new optional parameter systemData
      info	[Changelog]   - Interface CloudServiceNetworkProfile has a new optional parameter slotType
      info	[Changelog]   - Added Enum KnownCloudServiceSlotType
      error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
    ️❌ azure-sdk-for-go failed [Detail]
    • Failed [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. 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
      error	Script return with result [failed] code [2] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2
      warn	Skip package processing as generation is failed
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. 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]  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
    • ️✔️compute [View full logs]  [Preview Schema Changes]
    ️❌ azure-powershell failed [Detail]
    • Failed [Logs] Generate from 2e44e64f94baa60b8afc11b50878bcde3e811985. 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.compute [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @grizzlytheodore grizzlytheodore marked this pull request as ready for review June 7, 2022 22:03
    @grizzlytheodore grizzlytheodore added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jun 7, 2022
    @openapi-workflow-bot
    Copy link

    Hi @grizzlytheodore, 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.

    1 similar comment
    @openapi-workflow-bot
    Copy link

    Hi @grizzlytheodore, 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.

    @grizzlytheodore
    Copy link
    Contributor Author

    What does it mean by: Switch to "Preview" on this description then select one of the choices below.?

    @ArcturusZhang

    Co-authored-by: Arpit Khandelwal <arkhande@microsoft.com>
    @raosuhas
    Copy link

    raosuhas commented Jun 9, 2022

    This PR has not been created correctly. The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    @openapi-workflow-bot openapi-workflow-bot bot removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 9, 2022
    @grizzlytheodore grizzlytheodore added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 13, 2022
    @grizzlytheodore
    Copy link
    Contributor Author

    This PR has not been created correctly. The first commit needs to be the previous api version and the new changes should only be added in the subsequent commits. This is explained in detail here (If using Open API which is recommended) https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/208/OpenAPI-Hub-Adding-new-API-version or here(For manual process) : https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version . Please remove the "ARMChangesRequested" tag once you have fixed this issue.

    @raosuhas
    first commit is indeed setting up the branch for this new release. There are some other commits because in this iteration of releases we are cleaning up the compute swagger files by:

    • breaking up swagger files by resources
    • updating all the example file names to be consistent

    And also since this branch was created, compute had three releases: 2022-01-03, 2022-03-01, 2022-03-02, and it is a difficult task to keep them all synced.
    And the ARM team's ask of having 1 commit as a branch set up and commits following to be only new features being added for this version is a very difficult task to achieve with all the moving parts in compute.
    I understand that this is to make the review process easier, so I have listed out the 2 PRs that were merged to this branch that are the only new features being added to this version:
    #19361
    #19311

    I believe that the difficulty of having the commit history to the ARM team's requirement far outweighs the difficulty added to the review process by the presense of few 'unnecessary' commits. Especially with the PRs I have listed out for you. Please allow an exception

    @zizw123
    Copy link

    zizw123 commented Jun 13, 2022

    I will need to know what changes are new so that I can review those part, without creating the changes properly I can't tell for sure and it will be hard to go over everything line by line. Can you put all the older changes in a few commits, and add new commit on top of that, so that I can just review the diff from the older commit to the new change?

    @openapi-workflow-bot
    Copy link

    Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested

    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 13, 2022
    @grizzlytheodore
    Copy link
    Contributor Author

    grizzlytheodore commented Jun 15, 2022

    @zizw123 seriously question, is there an easy/suggested way to do reorganize commits?
    or do you expect a new branch to be created following @raosuhas 's links?

    as a side note, from the very start, every release, we are aware of the ARM review and we do our best to have our commits organized, but again, with all the moving parts, it is very difficult.

    @zizw123
    Copy link

    zizw123 commented Jun 15, 2022

    @zizw123 seriously question, is there an easy/suggested way to do reorganize commits? or do you expect a new branch to be created following @raosuhas 's links?

    as a side note, from the very start, every release, we are aware of the ARM review and we do our best to have our commits organized, but again, with all the moving parts, it is very difficult.

    You can create a new branch with the proper commit order and send that as a new PR. That should be easier. The only reason why we are asking for these is that we get a lot of reviews and it's really not ideal to us to go over line by line for every files.

    @grizzlytheodore
    Copy link
    Contributor Author

    PR is moved to #19468 for better commit history. Please review/approve @zizw123

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMReview DoNotMerge <valid label in PR review process> use to hold merge after approval

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    6 participants