Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added HNS Encryption Context #21693

Conversation

seanmcc-msft
Copy link
Member

No description provided.

@seanmcc-msft seanmcc-msft requested a review from a team as a code owner November 29, 2022 17:07
@seanmcc-msft seanmcc-msft requested review from DominikMe and mikekistler and removed request for a team November 29, 2022 17:07
@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]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 29, 2022

    Swagger Validation Report

    ️❌BreakingChange: 2 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    DataLakeStorage.json 2021-06-08(8d43652) 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) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2021-06 package-2021-06(8d43652) package-2021-06(feature/storage/stg87base)

    [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


    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
    ⚠️ DeprecatedXmsCodeGenerationSetting The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L7
    ⚠️ LicenseHeaderMustNotBeSpecified License header must not be specified inside x-ms-code-generation-settings. This is different for different sdks generated and is passed via command line/config file when generating the sdk.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L7
    ⚠️ MsPaths Don't use x-ms-paths except where necessary to support legacy APIs.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L34
    ⚠️ PatchInOperationName 'PATCH' operation 'FileSystem_SetProperties' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L194
    ⚠️ 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: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L777
    ⚠️ GetInOperationName 'GET' operation 'Path_Read' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1211
    ⚠️ 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: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1228
    ⚠️ 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: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1348
    ⚠️ 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: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1458
    ⚠️ PatchInOperationName 'PATCH' operation 'Path_SetAccessControl' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1756
    ⚠️ PatchInOperationName 'PATCH' operation 'Path_SetAccessControlRecursive' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1880
    ⚠️ PatchInOperationName 'PATCH' operation 'Path_FlushData' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Azure.Storage.Files.DataLake/preview/2021-06-08/DataLakeStorage.json#L1997
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️⌛ModelValidation pending [Detail]
    ️⌛SemanticValidation pending [Detail]
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️⌛PR Summary pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 29, 2022

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=339577&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 128 "
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Nov 29, 2022

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

    @ghost ghost added the Storage Storage Service (Queues, Blobs, Files) label Nov 29, 2022
    @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.

    @ghost
    Copy link

    ghost commented Dec 18, 2022

    Hi, @seanmcc-msft. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Dec 18, 2022
    @ghost ghost closed this Jan 2, 2023
    @ghost
    Copy link

    ghost commented Jan 2, 2023

    Hi, @seanmcc-msft. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    @seanmcc-msft seanmcc-msft reopened this Jan 5, 2023
    @ghost ghost removed the no-recent-activity label Jan 5, 2023
    @seanmcc-msft seanmcc-msft merged commit 78809ad into Azure:feature/storage/stg87base Jan 5, 2023
    tg-msft pushed a commit that referenced this pull request Feb 9, 2023
    * Added new file version (#21704)
    
    * Added HNS Encryption Context (#21693)
    
    * Added x-ms-file-request-intent to File and Directory operations (#21705)
    
    * Trailing Dot (#21781)
    
    * Add file request intent to comp=rename for dir&files (#22420)
    
    ---------
    
    Co-authored-by: vincenttran-msft <[email protected]>
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * 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
    Labels
    data-plane NewApiVersionRequired Storage Storage Service (Queues, Blobs, Files)
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants