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

[PublicPreviewReadiness] The errors property in the MoveResourceProperties should be readonly. #10554

Merged
merged 1 commit into from
Aug 21, 2020
Merged

[PublicPreviewReadiness] The errors property in the MoveResourceProperties should be readonly. #10554

merged 1 commit into from
Aug 21, 2020

Conversation

innosam
Copy link
Contributor

@innosam innosam commented Aug 21, 2020 •
edited
Loading

a. Enhance the operation discovery with a relevant example.
b. Fix the move resource properties error filed to be readonly.

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

Contribution checklist:

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

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service

  • 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 21, 2020 •
edited
Loading

[Staging] Swagger Validation Report

️❌BreakingChange: 3 Errors, 0 Warnings [Detail] [Expand]
Rule Message
❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'.
New: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9
Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9
❌ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
New: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9
Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9
❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'properties' renamed or removed?
Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1526:7
️️✔️LintDiff [Detail] 
 Validation passes for LintDiff.
️️✔️Avocado [Detail] 
 Validation passes for Avocado.
️️✔️ModelValidation [Detail] 
 Validation passes for ModelValidation.
️️✔️SemanticValidation [Detail] 
 Validation passes for SemanticValidation.
Posted by Swagger Pipeline | How to fix these errors?

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Aug 21, 2020 •
edited
Loading

azure-sdk-for-go - Release

️✔️ succeeded [Logs] [Expand Details]

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Aug 21, 2020 •
edited
Loading

Azure CLI Extension Generation - Release

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Aug 21, 2020 •
edited
Loading

azure-resource-manager-schemas - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from 000ad1c with merge commit 1d90950. Schema Automation 13.0.17.20200807.2
  • ️✔️regionmove [View full logs]  [Release Schema Changes] 
      [after_scripts|node] PostProcessor finished successfully.
[after_scripts|node]   5619 passing (1m)
AzureResourceSchema has no registered package commands.

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Aug 21, 2020 •
    edited
    Loading

    azure-sdk-for-net - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Aug 21, 2020 •
    edited
    Loading

    azure-sdk-for-python - Release

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from 000ad1c with merge commit 1d90950. SDK Automation 13.0.17.20200807.2 
      [azure-mgmt-regionmove][ChangeLog] WARNING: Failed to generate ChangeLog.
    • ⚠️azure-mgmt-regionmove [View full logs]  [Release SDK Changes] 
      [build_conf] INFO:packaging_tools:Building template azure-mgmt-regionmove
[build_conf] INFO:packaging_tools.conf:Build default conf for azure-mgmt-regionmove
[build_conf] INFO:packaging_tools:Template done azure-mgmt-regionmove
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] /z/venv/lib/python3.6/site-packages/setuptools/dist.py:397: UserWarning: Normalizing '0.1.0-preview' to '0.1.0rc0'
[build_package]   normalized_version,
[build_package] warning: no files found matching '*.py' under directory 'tests'
[build_package] warning: no files found matching '*.yaml' under directory 'tests'
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] /z/venv/lib/python3.6/site-packages/setuptools/dist.py:397: UserWarning: Normalizing '0.1.0-preview' to '0.1.0rc0'
[build_package]   normalized_version,
[build_package] warning: no files found matching '*.py' under directory 'tests'
[build_package] warning: no files found matching '*.yaml' under directory 'tests'
[breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
Not exact 2 reports found:
code_reports/latest/report.json
Not generating changelog.
[ChangeLog] WARNING: Failed to generate ChangeLog.

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Aug 21, 2020 •
    edited
    Loading

    azure-sdk-for-js - Release

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from 000ad1c with merge commit 1d90950. SDK Automation 13.0.17.20200807.2 
      Failed to find any diff after autorest so no changed packages was found.

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Aug 21, 2020 •
    edited
    Loading

    Trenton Generation - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Aug 21, 2020 •
    edited
    Loading

    azure-sdk-for-java - Release

    ⚠️ warning [Logs] [Expand Details]
    • ⚠️ Generate from 000ad1c with merge commit 1d90950. SDK Automation 13.0.17.20200807.2 
      Failed to find any diff after autorest so no changed packages was found.

    @innosam innosam changed the title Swagger fixes: [PublicPreviewReadiness] The errors property in the MoveResourceProperties should be readonly. Aug 21, 2020
    @innosam innosam requested a review from ajaygit158 August 21, 2020 09:13
    This was referenced Aug 21, 2020
    Closed
    Closed
    ajaygit158
    ajaygit158 reviewed Aug 21, 2020
    View reviewed changes
    ...e-manager/Microsoft.Migrate/preview/2019-10-01-preview/examples/OperationsDiscovery_Get.json Outdated
    @@ -1,6 +1,6 @@
    {
    "parameters": {
    "api-version": "2016-08-10",
    "api-version": "2019-10-01",
    Copy link
    Member

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    2019-10-01-preview?

    Copy link
    Contributor Author

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    will take this.

    @innosam
    Swagger fixes:
    000ad1c 
    a. Enhance the operation discovery with a relevant example.
b. Fix the move resource properties error filed to be readonly.
    @innosam innosam force-pushed the hsingh/fixerrorreadme branch from 4e4a448 to 000ad1c Compare August 21, 2020 09:24
    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Aug 21, 2020 •
    edited
    Loading

    azure-sdk-for-python-track2 - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @innosam
    Copy link
    Contributor Author

    innosam commented Aug 21, 2020

    Breaking Changes Details

    The service is in private preview, and we are doing this fixes/improvements as part of public preview that is tentatively planned on 27th September 2020.
    Additionally our private preview customer do not use the API's directly instead rely on the portal for the usage.

    We are also working on releasing auto generated powershell and SDK's so the swagger is being actively validated before public preview.

    Rule Message  
    ❌ 1029 - ReadonlyPropertyChanged The read only property has changed from 'false' to 'true'. New: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9 Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9 Bug: The errors field is readonly, and was incorrectly marked.
    ❌ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one. New: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9 Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1173:9 Bug: The errors field is readonly, and was incorrectly marked.
    ❌ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'properties' renamed or removed? Old: Microsoft.Migrate/preview/2019-10-01-preview/regionmovecollection.json#L1526:7 Bug: The errors field is readonly, and was incorrectly marked.

    @azuresdkci
    Copy link
    Contributor

    Can one of the admins verify this patch?

    @lirenhe lirenhe added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 21, 2020
    @lirenhe lirenhe merged commit 1d90950 into Azure:master Aug 21, 2020
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @ajaygit158 ajaygit158 ajaygit158 approved these changes

    @lirenhe lirenhe lirenhe approved these changes

    Assignees

    @lirenhe lirenhe

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

    Successfully merging this pull request may close these issues.
    4 participants
    @innosam @azuresdkci @lirenhe @ajaygit158