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.

Sign up for GitHub

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

Jump to bottom

Fixed S360 issues in Microsoft.Solutions. #17719

Merged
merged 1 commit into from
Feb 18, 2022
Merged

Fixed S360 issues in Microsoft.Solutions. #17719

merged 1 commit into from
Feb 18, 2022

Conversation

vayada
Copy link
Contributor

@vayada vayada commented Feb 9, 2022 •
edited
Loading

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

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. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

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 label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @vayada 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 9, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 6 Errors, 2 Warnings failed [Detail]
    Rule Message
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L427:9
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2339:9
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
    New: common-types/resource-management/v2/types.json#L438:9
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2346:9
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'httpStatus' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331:7
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2068:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'errorCode' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331:7
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2068:7
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'errorMessage' renamed or removed?
    New: common-types/resource-management/v2/types.json#L331:7
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2068:7
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'error' in response that was not found in the old version.
    New: common-types/resource-management/v2/types.json#L331:7
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2068:7
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L57:13
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L57:13
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: common-types/resource-management/v2/types.json#L423:5
    Old: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L2336:5
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ D5001 - XmsExamplesRequired Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations.
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L36
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'properties'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ❌ R2016 - PatchBodyParametersSchema Properties of a PATCH request body must not be required. PATCH operation: 'Applications_UpdateById' Model Definition: 'Application' Property: 'kind'
    Location: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1312
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 25 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/getApplication.json#L11
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/getApplication.json#L11
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplication.json#L19
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplication.json#L19
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplication.json#L41
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplication.json#L41
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/getApplicationDefinition.json#L11
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/getApplicationDefinition.json#L11
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L26
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L26
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L62
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L62
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/listApplicationDefinitionsByResourceGroup.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/listApplicationDefinitionsByResourceGroup.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/listApplicationsByResourceGroup.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1291
    JsonUrl: stable/2019-07-01/examples/listApplicationsByResourceGroup.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/getApplicationDefinition.json#L11
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/getApplicationDefinition.json#L11
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L26
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L26
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: location
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L62
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: tags
    Url: Microsoft.Solutions/stable/2019-07-01/managedapplications.json#L1351
    JsonUrl: stable/2019-07-01/examples/createOrUpdateApplicationDefinition.json#L62
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌CredScan: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️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 Feb 9, 2022 •
    edited
    Loading

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-workflow-bot
    Copy link

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

    @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.

    @openapi-workflow-bot
    Copy link

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

    This was referenced Feb 9, 2022
    Draft
    Draft
    This was referenced Feb 9, 2022
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    Draft
    @raych1
    Copy link
    Member

    raych1 commented Feb 9, 2022

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

    Please get breaking change review approval.

    @vayada
    Copy link
    Contributor Author

    vayada commented Feb 9, 2022

    @raych1 This change involves changes for fixing S360 issues. S360 issue was related to ErrorResponse and OperationResult which were being defined in the swagger itself instead of using the standard one from common-types. Customer shouldn't be impacted with this as it uses the standard ErrorResponse & OperationResult schema now.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 14, 2022
    @raych1 raych1 merged commit 67223eb into Azure:main Feb 18, 2022
    grizzlytheodore added a commit that referenced this pull request Feb 22, 2022
    @grizzlytheodore @stephenbudhi-msft
    @Ochirkhuyag @ruslany @xwang971 @Juliehzl @vturecek @vinisoto @erich-wang @vusause @sanchitmehta @kerend @yantang-msft @oravital7 @seanmcc-msft @robertklee @rajrame @peter-li-ms @dw511214992 @Alancere @ajparule @msyyc @rchlkm @jinghzhu-msft @BigCat20196 @sharathmalladi @agalerrotaru @solankisamir @vayada @vukelich @priyankarking @lynshi @jorgecotillo @ruowan @satravi @ArcturusZhang @pratikjoshi14 @amchandn @pratimaupadhyay02 @laithhisham @colawwj @yuzhangyi @zhanyu2024 @petrsvihlik @apraovjr @ajpeacock0 @Harshan01
    merge main to this (#17943)
    fc96497 
    * [CapacityRP] [S360] Fix R3007 Linter Error in Microsoft.Capacity (#17711)

* change 200 response for PUT/PATCH

* add integer type and remove extra fields to pass model check

* add id, name, type to GET/PUT/PATCH 200 response

* run prettier

* change x-ms-long-running-operation-options

* updated an error response for the rename API on v2020-09-01 (#17850)

Co-authored-by: Ochi <ochisamand@microsoft.com>

* Microsoft.App version 2022-01-01-preview (#17820)

* New Swagger Spec File

* New Swagger Example Spec File

* New Readme Config File

* New Azure AZ Readme Config File

* New Azure CLI Readme Config File

* New Go Language Readme Config File

* New Python Language Readme Config File

* New Typescript Language Readme Config File

* New C# Language Readme Config File

* Adding new API version 2022-01-01-preview for the new service Microsoft.App (#17135)

* Adding swagger and examples

* Fix samples

* Fix linting errors

* fix errors

* fix more errors

* prettier fixes

* Fix the VNET properties

* fix the vnet props

* Attempt to remove x-ms-identifiers

* Add x-ms-identifiers back

* Revert "Add x-ms-identifiers back"

This reverts commit 44525ab.

* Addsourcecontrolapis (#17287)

* add sourcecontrol apis

* remove space

* prettier fix

* typo

* avocado fix

* lint fix

* add replicas apis (#17501)

* Remove Dapr components from ContainerApp spec. Not breaking because the version hasn't been released yet. (#17479)

* Remove dapr components from the ContainerApp object

* Fix example

* add descriptions

* fix

* change the auto-rest parameters

* Support volume mounts for containerApp (#17530)

* add volume mounts

* add identifier

* refine volume definition

* Fix samples (#17534)

* Adding managed identity (#17569)

* Adding managed identity

* prettier fix.

* Microsof.app 2022 01 01 preview/add custom domains (#17385)

* add support for Custom domains and certificates

* add Certificates

* Ccertificate as child resource of Managed Env.

* Support default custom domain

* PUT/DELETE certificate are not long-running

* Add Custom Domain Verification Id

* domains for all revisions and adding examples

* missing examples

* one more missing example

* Examples+missing paths

* Adding missing envelope properties

* Addressing PR comments

* Removing AKV and Free cert related properties

* Prettier and semantic validation fixes

* Fixing semantic validations and examples

* More fixes

* Addressing more PR comments

* Updating examples

* fixing type

* fixing types

* Extra properties and responses

* misplaced response

* whitespace

* fix security section

* fixing ManageEnvironment securityDefinitions

* add 204 delete response

* Removing virtual IP and IP Based option

* change modelAsString

* Addressing ARM PR comments

* Removing 404 response from example

* renaming custom hostname analysis operation

* mark certificate as tracked resource

* fix sample

* Use Certificate Id instead of Certificate name

Co-authored-by: Ruslan Yakushev 🚴 <ruslany@microsoft.com>
Co-authored-by: vinisoto <vinisoto@hotmail.com>

* Add new properties for ContainerApp (#17483)

* add ephemeral storage

* add outbound ip

* add listsecrets

* fix CI

* fix example

* fix

* add identifier

* fix

* add example

* mars as secret

* Add storages operation for managedEnvironment (#17545)

* add storage

* fix

* fix typo

* Add EasyAuth configuration APIs for ContainerApp (#17492)

* Add Easy Auth Config related APIs for ContainerApp

* Use common type ProxyResource

* Update description

* update per validation

* typo fix

* fix validation error

* Update sample and description

* Update because ARM prefer string than boolean

* Add static web identity provider

* Add container probes (#17535)

* Add container probes

* minor fix

* Use execute instead of exec'd, add identifier

* remove exec from preview

* use integer instead of intorstring

* Add `internal` property under VnetConfiguration for internalOnly environments (#17656)

* Add internal property under VnetConfiguration for internalOnly environments

* Update examples

* Add Dapr Components collection APIs (#17552)

* Add daprComponents

* update readme

* Fix linting errors

* More lint fixes

* prettier fixes

* make dapr component a tracked resource

* fix the patch

* fix lint errors

* Revert "fix lint errors"

This reverts commit 045f1d9.

* Revert "fix the patch"

This reverts commit 1452110.

* Revert "make dapr component a tracked resource"

This reverts commit 239268e.

* Fix linter issues

* fix wrong fix

* fix linter

* fix the operationids (#17809)

* correct resource name (#17846)

* Add custom open id providers support (#17855)

* Add custom open id providers support

* Update description

Co-authored-by: Xingjian Wang <79332479+xwang971@users.noreply.github.com>
Co-authored-by: Zunli Hu <zuh@microsoft.com>
Co-authored-by: Vaclav Turecek <vturecek@microsoft.com>
Co-authored-by: Vini Soto <18271663+vinisoto@users.noreply.github.com>
Co-authored-by: vinisoto <vinisoto@hotmail.com>
Co-authored-by: erich-wang <eriwan@microsoft.com>
Co-authored-by: Mike Vu <mdhvu@uwaterloo.ca>
Co-authored-by: Sanchit Mehta <sanmeht@microsoft.com>

* [Hub Generated] Review request for Microsoft.Security to add version preview/2021-07-01-preview (#17460)

* .

* .

* Add x-ms-identifiers for dataprotection (#17817)

* Adding supported clouds param (#17580)

* Add x-ms-identifiers for datalake-analytics (#17756)

* Fixed Storage File Copy Ignore Readonly (#17867)

* Add aliases to 2021-04-30-preview swagger for Azure search (#17253)

* Add aliases to 2021-04-30-preview swagger for Azure search

* add example for aliases in GetServiceStats

* prettier changes

* fix examples to use aliasName

* add discriminator to LexicalNormalizer to fix validation error

* fix validation error because of duration string

Co-authored-by: Robert Lee <robertlee@microsoft.com>

* Manually moving DataCollectionRules from Private PR. (#17845)

* Create readme.md

* Create post_IngestUsingDataCollectionRule.json

* Create DataCollectionRules.json

* Use AuthConfig instead of EasyAuth for all public API/Document (#17885)

* Initial commit for new version and new child resource type extended l… (#17681)

* Initial commit for new version and new child resource type extended location

New version: 2021-08-31-preview
New child resource type: resource sync rule

* Fix lint check errors and cross version breaking changes validation issues

* Try to fix Cross-Version Breaking Changes

* Revert changes to previous stable version

* Remove "x-ms-identifiers" definition which will cause golang sdk generation error

* Address review comments, revert unnecessary changes

* Try fix breaking error

* Revert changes which fix lint error but will cause cross version breaking changes

* Fix lintdiff validation issue and also add back two updates for this version only

* Update descriptions of properties of resource sync rules.

* Update description of the resource sync rules API

* Update description of resource sync rules selector property

* Update description of matchExpressions

* Update description of targetResourceGroup

* Fix a required LintDiff check

Adding "x-ms-identifiers": [] to matchExpressionsList

* Add title to readme.typescript.md

* Update specification/extendedlocation/resource-manager/readme.typescript.md

* Revert cross version breacking changes

Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>

* [Go] Add batch tag 20220217 (#17886)

* plural (#17876)

* add property (#17878)

* [CosmosDB][2021-11-15-preview]Add enableMaterializedViews property to DB Account API's (#17864)

* Added enableMaterializedViews property for DB account CRUD API's

* revert package-lock.json

* revert package-lock

* update examples with enableMaterializedViews property

* updated example

* trigger

* trigger

Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>

* [Hub Generated] Review request for Microsoft.SqlVirtualMachine to add version preview/2021-11-01-preview (#17252)

* Adds base for updating Microsoft.SqlVirtualMachine from version preview/2017-03-01-preview to version 2021-11-01-preview

* Updates readme

* Updates API version in new specs and examples

* add 2021-11-01 swagger

* add missing files, spellcheck, add MAXDOP to custom-words

* prettier check

* fix model validation errors

* fix swagger avocado failures, SDK azure-sdk-for-net failures due to DaysOfWeek

* add system data to AvailabilityGroupListener, SqlVirtualMachineGroup, SqlVirtualMachine

* update list operation for 2021-11-01

* add ms-identifier to address lintdiff R4041

* remove x-ms-identifiers property as it is not available yet on .net sdk

* add SqlVirtualMachines_StartAssessment

* update ResourceIdentity enum from IdentityTypeWithNone to IdentityType

* update list operations json

* prettier check

* re-add ms-identifier to address lintdiff R4041

* Add Swagger spec of MICROSOFT.DASHBOARD for Public Preview (#17667)

* Add Swagger spec of MICROSOFT.DASHBOARD for Public Preview

* Add sdk files

* Use ErrorResponse from common-types

* Update GrafanaResource to follow TrackedResources from common-types

* Update specification/dashboard/resource-manager/readme.typescript.md

Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>

* Update specification/dashboard/resource-manager/readme.typescript.md

Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>

* Update specification/dashboard/resource-manager/readme.csharp.md

Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>

* Remove location from PATCH

* Refer to OperationList from common types

* Fix Swagger ModelValidation error

* Remove GrafanaResourcePropertiesUpdateParameters

* Update specification/dashboard/resource-manager/readme.md

Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>

* Update readme.python.md

* Update specification/dashboard/resource-manager/readme.go.md

* Update specification/dashboard/resource-manager/readme.md

* Update readme.python.md

* Update readme.md

* Update specification/dashboard/resource-manager/readme.csharp.md

Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>
Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com>
Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>

* Users/sharathm/putmodelapi (#17386)

* Put Model api for Personalizer

* Moved api to v1.1-preview.3 and renamed api from model to signedmodel

* Change api to allowed downloading signed and unsigned models.

* Updates to add new parameter for signed for Get model api

* Renamed example file reference

* Fixed errors in model validation.

* Fixed errors from prettier check.

* Changed examples to match the generated files.

* Manual updates to address breaking change issues

* Updated as per feedback from api review meeting

* Added description for Ocp-Apim-Subscription-Key

* Renamed Evaluation_Apply to Evaluations_Apply

* Reverting back the renaming operation since it was done in error.

* Add description for body parameter of model/put call

Co-authored-by: Decision Service <personalizer@microsoft.com>

* Adding xms identifiers for RPs (#17753)

* Adding x-ms-identifiers for AD Hybrid Health Service

* remove added properties

* Adding xms-identifiers for AlertsManagement

* revert changes related to files outside resource-manager

* Adding xms-ids for ApiManagement

* adding xms-ids for AzureData

* Adding xms-ids for COnfidentialLedger

* Adding xms ids for Confluent

* Adding xms-ids for CostManagement

* Adding xms ids for DataBox

* Adding xms ids for DataBricks

* fix typos

* Corrections after rebasing

* corrections after rebase

* fixing invalid format errors

* changing the format to uuid for all Ids

* prettier fix

* prettier fix 2

* reverting package files to main

* revert noisy prettifier changes

* revert some format changes in adhybrid

* reverting noisy changes

* removing adhybrid and alerts management

* remove azuredata

* remove apimanagement files from this PR

* fix examples (#17698)

* Adding xms-ids for Compute (#17633)

* Adding xms-ids for Compute

* porting changes to a newer gallery version

* S360 fix. (#17719)

* Add x-ms-identifiers to servicelinker/resource-manager. (#17778)

Co-authored-by: Steven Vukelich <svukel@microsoft.com>

* swagger correctness fix for INVALID RESPONSE CODE. (#17750)

Co-authored-by: Priyankar Gupta <priyagupta@microsoft.com>

* [Confidential Ledger] Example fixes and Swagger changes to accommodate CLI / PowerShell generation (#17695)

* add swagger generation code for azcli

* fiddle with ordering because the cli-extension codegen did not seem to run

* remove comment

* update readme files as in latest docs

* fix example for cli test case generation

* spec fixes for codegen

* update documentation

* fix example

* Update readme.python.md

* Update readme.md

Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>

* added missing enum (#17828)

* Update comment.yml (#17875)

* Update pull_request_assignment.yml (#17901)

* Mobile Network REST API Specification (#17730)

* Mobile Network REST API Specification

* Removed API versions 2020-06-01-preview and 2021-04-01-preview. Have only the API version 2022-01-01-preview in Public

* Addressed Swagger Avocado and Swagger SpellCheck Errors

* Addressed Parameters Order Errors

* Merge azure-rest-api-specs-pr branch ssivathas/mobilenetwork-public-api into satravi/mobilenetwork-rest-api-specs

* Removed Unreferenced JSON Files

* Added support for Static IP Addressing to PMN

* Addressed Swagger PrettierCheck Errors

* Addressed Swagger ModelValidation Errors

* change go config to track 2

* Updated the API versions in SDK README files

* Update readme.python.md

* Update readme.md

* Updated ActivationState to ConfigurationState

* Addressed XmsIdentifierValidation Errors

* Addressed DescriptionAndTitleMissing Errors

* Generic name for N2 and N3 Interface attributes to support 4G Networks

* Generic name for N6 Interface attribute to support 4G Networks

* Generic name for N6 Interface attribute to support 4G Networks

Co-authored-by: ArcturusZhang <dapzhang@microsoft.com>
Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>

* [Hub Generated] Review request for Microsoft.DataProtection to add version stable/2022-01-01 (#17261)

* Adds base for updating Microsoft.DataProtection from version stable/2021-07-01 to version 2022-01-01

* Updates readme

* Updates API version in new specs and examples

* stop protection changes

* Composite configure protection and restore changes

* Adding new routes and API for operationStatus

* Changes to Azure-AsyncOperation in examples

* Fixing swagger correctness issue

* prettier fix

* Fixing Lint Diff error

* Updating example for list operations API

* Composite configure protection changes

* FIxing OAV error

* Swagger validation fixes

* Swagger validation fixes

* Swagger validation fixes

* Swagger validation fixes

* Swagger validation fixes

* PR feedback changes

* PR feedback changes

Co-authored-by: amchandn <amchandn@microsoft.com>
Co-authored-by: Pratima Upadhyay <pratima.upadhyay02@gmail.com>

* [Hub Generated] Review request for Microsoft.SecurityInsights to add version preview/2021-10-01-preview (#17837)

* extract MicrosoftSecurityProductName to enum

* extract AlertRuleTemplateStatus to enum

* define FusionAlertRuleTemplateProperties

* add back nested properties

* add flatten to mitre and fusion properties objects

* change position of required

* define MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties

* align required + add flatten

* fix AlertSeverity ref

* align type to avoid breaking change

* add type for MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties

* Add x-ms-identifiers for WebApps (#17536)

* Add x-ms-identifiers for WebApps

* Run prettifier

* Resolve PR review comment

* add x-ms-enum for resourcehealth (#17425)

* dnsresolver-add-typescript.md (#17873)

* [Data Factory] Support rest-based connectors in Synapse (I) (#17922)

* Enable excel in public swagger

* update

* rollback dataflow change

* Support rest-based connectors in Synapse (I)

Co-authored-by: zhanyu2014 <zhanyu@microsoft.com>

* Update PULL_REQUEST_TEMPLATE.md (#17928)

* fix publicnetworkaccess for preview in sb (#17464)

* Add publicnetworkaccess to preview (#17463)

* add x-ms-enum to policyinsights (#17424)

* add x-ms-enum to policyinsights

* fix casing

* resolve comments

* resolve comments

* resolve comment

* align the parameters in all the polluted files

* Revert "[Communication] Adding 2022-02-01 NetworkTraversal API version for General Availability (#16946)" (#17911)

This reverts commit 1824478.

* Autorest related fix to data-plane API of Azure Load Testing (#17705)

* Add description to formData in loadtest data-plane API

* Modify description for loadtest upload route in data-plane API

Co-authored-by: sbudhi-msft <81762203+sbudhi-msft@users.noreply.github.com>
Co-authored-by: Ochirkhuyag <ochirkhuyag.samand@gmail.com>
Co-authored-by: Ochi <ochisamand@microsoft.com>
Co-authored-by: Ruslan Yakushev <1664475+ruslany@users.noreply.github.com>
Co-authored-by: Xingjian Wang <79332479+xwang971@users.noreply.github.com>
Co-authored-by: Zunli Hu <zuh@microsoft.com>
Co-authored-by: Vaclav Turecek <vturecek@microsoft.com>
Co-authored-by: Vini Soto <18271663+vinisoto@users.noreply.github.com>
Co-authored-by: vinisoto <vinisoto@hotmail.com>
Co-authored-by: erich-wang <eriwan@microsoft.com>
Co-authored-by: Mike Vu <mdhvu@uwaterloo.ca>
Co-authored-by: Sanchit Mehta <sanmeht@microsoft.com>
Co-authored-by: kerend <kerend@users.noreply.github.com>
Co-authored-by: Yanming Tang <yantang@microsoft.com>
Co-authored-by: Or Avital <37445345+oravital7@users.noreply.github.com>
Co-authored-by: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com>
Co-authored-by: Robert Lee <32447910+robertklee@users.noreply.github.com>
Co-authored-by: Robert Lee <robertlee@microsoft.com>
Co-authored-by: rajrame <52300710+rajrame@users.noreply.github.com>
Co-authored-by: Lei Li <77429849+peter-li-ms@users.noreply.github.com>
Co-authored-by: Wei Dong <40835867+dw511214992@users.noreply.github.com>
Co-authored-by: Jiahui Peng <46921893+Alancere@users.noreply.github.com>
Co-authored-by: Ajay Parulekar <79739098+ajparule@users.noreply.github.com>
Co-authored-by: Yuchao Yan <yuchaoyan@microsoft.com>
Co-authored-by: Rachel Kim <rachelkim1205@gmail.com>
Co-authored-by: Jinghua Zhu <75519723+jinghzhu-msft@users.noreply.github.com>
Co-authored-by: Jiefeng Chen <51037443+BigCat20196@users.noreply.github.com>
Co-authored-by: Sharath Malladi <msharath@live.com>
Co-authored-by: Decision Service <personalizer@microsoft.com>
Co-authored-by: agalerrotaru <86316103+agalerrotaru@users.noreply.github.com>
Co-authored-by: Samir Solanki <samirsolanki@outlook.com>
Co-authored-by: vayada <vayada@microsoft.com>
Co-authored-by: Steven Vukelich <csgopher@gmail.com>
Co-authored-by: Steven Vukelich <svukel@microsoft.com>
Co-authored-by: priyankarking <priyankarhappy@gmail.com>
Co-authored-by: Priyankar Gupta <priyagupta@microsoft.com>
Co-authored-by: Lyndon Shi <lyshi@microsoft.com>
Co-authored-by: Jorge Cotillo <jcotillo@microsoft.com>
Co-authored-by: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com>
Co-authored-by: satravi <96466317+satravi@users.noreply.github.com>
Co-authored-by: ArcturusZhang <dapzhang@microsoft.com>
Co-authored-by: pratikjoshi14 <59243362+pratikjoshi14@users.noreply.github.com>
Co-authored-by: amchandn <amchandn@microsoft.com>
Co-authored-by: Pratima Upadhyay <pratima.upadhyay02@gmail.com>
Co-authored-by: laithhisham <49263932+laithhisham@users.noreply.github.com>
Co-authored-by: colawwj <70128817+colawwj@users.noreply.github.com>
Co-authored-by: yuzhangyi <44692931+yuzhangyi@users.noreply.github.com>
Co-authored-by: zhanyu2014 <zhanyu@microsoft.com>
Co-authored-by: Petr Švihlík <rocky.intel@gmail.com>
Co-authored-by: apraovjr <aprao@microsoft.com>
Co-authored-by: Andrew Peacock <ajpeacock0@outlook.com>
Co-authored-by: Harshan B <Harshan01@gmail.com>
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    @vayada @FredericHeem
    S360 fix. (Azure#17719)
    2f800b9
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @raych1 raych1 raych1 approved these changes

    Assignees

    @raych1 raych1

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-ModelValidation CI-BreakingChange-Go-V2 CI-FixRequiredOnFailure FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @vayada @raych1 @JeffreyRichter