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

Storage STG 87 #22451

Merged
merged 5 commits into from
Feb 9, 2023
Merged

Storage STG 87 #22451

merged 5 commits into from
Feb 9, 2023

Conversation

seanmcc-msft
Copy link
Member

This is not a breaking change

The Encryption Context feature in the Data Lake swagger was implemented and enabled about a year ago, we are just adding SDK support now.

This is not a breaking change

@seanmcc-msft seanmcc-msft requested a review from a team as a code owner February 3, 2023 21:01
@seanmcc-msft seanmcc-msft requested review from scgbear and bexxx and removed request for a team February 3, 2023 21:01
@openapi-workflow-bot
Copy link

Hi, @seanmcc-msft 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. [email protected]

    @ghost ghost added the Storage Storage Service (Queues, Blobs, Files) label Feb 3, 2023
    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2023 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    DataLakeStorage.json 2021-06-08(61b7e4a) 2021-06-08(main)
    Rule Message
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'EncryptionContext' in response that was not found in the old version.
    New: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3280:7
    Old: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3268:7
    ❌ 1043 - AddingOptionalParameter The optional parameter 'x-ms-encryption-context' was added in the new version.
    New: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L613:9
    ️❌Breaking Change(Cross-Version): 80 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    file.json 2022-11-02(61b7e4a) 2021-12-02(main)

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

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

    Rule Message
    ❌ 1009 - RemovedRequiredParameter The required parameter 'shareName' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1946:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'restype' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L2228:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'shareName' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L2247:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'directory' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L2247:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'shareName' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L2487:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'directory' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L2487:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'fileName' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L2945:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'comp' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L4195:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'comp' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L4419:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'shareName' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L4570:9
    ❌ 1009 - RemovedRequiredParameter The required parameter 'fileName' was removed in the new version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L4837:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L46:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L93:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L164:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L240:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L313:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L491:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L566:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L689:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L804:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L927:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1047:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1175:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1271:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1331:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1413:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1510:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1601:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1665:9
    ❌ 1019 - RemovedEnumValue The new version is removing enum value(s) '2021-12-02' from the old version.
    Old: Microsoft.FileStorage/preview/2021-12-02/file.json#L1756:9
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 3 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2022-11 package-2022-11(61b7e4a) default(main)
    package-2021-06 package-2021-06(61b7e4a) package-2021-06(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Rule Message Related RPC [For API reviewers]
    ⚠️ PropertyDescription Property should have a description.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3317
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L7363
    ⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L7371


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ HostParametersValidation The host parameter must be called 'endpoint'.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L19
    ❌ HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L19
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L580
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L590
    ❌ ValidFormats 'file' is not a known format.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1361
    ❌ ValidFormats 'file' is not a known format.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1471
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1863
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1980
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L2161
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L2317
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L2409
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L2494
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L2532
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L2572
    ❌ ValidFormats 'file' is not a known format.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3019
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3377
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3541
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L3558
    ❌ HostParametersValidation The host parameter must be called 'endpoint'.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L16
    ❌ HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L16
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L135
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L145
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L221
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L361
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L366
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L371
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L376
    ❌ IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L387
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L547
    ❌ XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
    Location: Microsoft.FileStorage/preview/2022-11-02/file.json#L644
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 3, 2023 •
    edited
    Loading

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

    @openapi-pipeline-app
    Copy link

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit data-plane new-api-version labels Feb 3, 2023
    @openapi-workflow-bot
    Copy link

    Hi @seanmcc-msft, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.
    Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    @openapi-workflow-bot
    Copy link

    Hi, @seanmcc-msft, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    @seanmcc-msft
    Copy link
    Member Author

    @tg-msft, could you take a look?

    @tg-msft tg-msft added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 9, 2023
    @tg-msft
    Copy link
    Member

    tg-msft commented Feb 9, 2023

    DataLake was easy to diff in the PR and I used https://portal.azure-devex-tools.com/tools/diff/eyJzb3VyY2VVcmwiOiJodHRwczovL2dpdGh1Yi5jb20vQXp1cmUvYXp1cmUtcmVzdC1hcGktc3BlY3MvYmxvYi9tYWluL3NwZWNpZmljYXRpb24vc3RvcmFnZS9kYXRhLXBsYW5lL01pY3Jvc29mdC5GaWxlU3RvcmFnZS9wcmV2aWV3LzIwMjEtMTItMDIvZmlsZS5qc29uIiwidGFyZ2V0VXJsIjoiaHR0cHM6Ly9naXRodWIuY29tL0F6dXJlL2F6dXJlLXJlc3QtYXBpLXNwZWNzL2Jsb2IvNjFiN2U0YWQ5MWQ0NGQzZGFjZmNhZWU2YzVmNGNmZDAwODAyMmE3Ni9zcGVjaWZpY2F0aW9uL3N0b3JhZ2UvZGF0YS1wbGFuZS9NaWNyb3NvZnQuRmlsZVN0b3JhZ2UvcHJldmlldy8yMDIyLTExLTAyL2ZpbGUuanNvbiJ9 to diff Files. None of the changes are breaking so I added the Approved Breaking Change label.

    @vincenttran-msft vincenttran-msft self-requested a review February 9, 2023 21:01
    vincenttran-msft
    vincenttran-msft approved these changes Feb 9, 2023
    View reviewed changes
    Copy link
    Member

    @vincenttran-msft vincenttran-msft left a comment

    Choose a reason for hiding this comment

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

    :shipit:

    @tg-msft tg-msft merged commit 3f3b51e into main Feb 9, 2023
    @tg-msft tg-msft deleted the feature/storage/stg87base branch February 9, 2023 21:47
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    @seanmcc-msft @vincenttran-msft @aviyerMSFT
    Storage STG 87 (Azure#22451)
    c322418 
    * Added new file version (Azure#21704)

* Added HNS Encryption Context (Azure#21693)

* Added x-ms-file-request-intent to File and Directory operations (Azure#21705)

* Trailing Dot (Azure#21781)

* Add file request intent to comp=rename for dir&files (Azure#22420)

---------

Co-authored-by: vincenttran-msft <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @vincenttran-msft vincenttran-msft vincenttran-msft approved these changes

    @scgbear scgbear Awaiting requested review from scgbear scgbear is a code owner automatically assigned from Azure/api-stewardship-board

    @bexxx bexxx Awaiting requested review from bexxx bexxx is a code owner automatically assigned from Azure/api-stewardship-board

    Assignees

    @tg-msft tg-msft

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-MissingBaseCommit data-plane new-api-version Storage Storage Service (Queues, Blobs, Files)
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    4 participants
    @seanmcc-msft @tg-msft @vincenttran-msft @AzureRestAPISpecReview