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

Purview Share V2 Specs - Data plane #22316

Merged
merged 53 commits into from
Feb 22, 2023
Merged

Purview Share V2 Specs - Data plane #22316

merged 53 commits into from
Feb 22, 2023

Conversation

faisalaltell
Copy link
Member

@faisalaltell faisalaltell commented Jan 25, 2023

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

  • Link to engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.

  • Design Document:
  • Previous Open API Doc:
  • Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

faisalaltell12 and others added 7 commits January 24, 2023 07:52
All changes missing Kevin's sink changes
This commit makes the following updates to the specifications:
- Removes /v2 from routes in the api specification.
- Removes sink property from detached received share examples.
…-detached-received-share-update

Purview Share Specification Adjustments for Resources and Routes
@faisalaltell faisalaltell requested review from mikekistler and a team as code owners January 25, 2023 22:57
@faisalaltell faisalaltell requested review from scgbear and removed request for a team January 25, 2023 22:57
@openapi-workflow-bot
Copy link

Hi, @faisalaltell Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 126 Errors, 22 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.4)] new version base version
    share.json 2023-02-15-preview(5193c61) 2021-09-01-preview(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
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/assets' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L9:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/assets/{assetName}' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L61:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedShares/{receivedShareName}/assetMappings' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L203:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedShares/{receivedShareName}/assetMappings/{assetMappingName}' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L255:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedInvitations' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L403:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedInvitations/{receivedInvitationName}' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L452:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedInvitations/{receivedInvitationName}:reject' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L492:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedShares' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L556:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/receivedShares/{receivedShareName}/receivedAssets' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L731:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L958:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1004:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:reinstate' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1047:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:revoke' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1109:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:update-expiration' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1159:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/activateEmail' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1419:5
    1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/registerEmail' removed or restructured?
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1474:5
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AcceptedSentShare' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAsset' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAssetMapping' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAssetMappingProperties' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountAssetProperties' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountReceivedAsset' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AdlsGen2AccountReceivedAssetProperties' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ApplicationInvitation' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ApplicationInvitationProperties' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ApplicationReceivedInvitation' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ApplicationReceivedInvitationProperties' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'Asset' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AssetMapping' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'AssetMappingStatus' removed or renamed?
    New: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L946:3
    Old: Azure.Analytics.Purview.Share/preview/2021-09-01-preview/share.json#L1518:3
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 12 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2023-02-15-preview package-2023-02-15-preview(5193c61) default(main)

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

    Rule Message Related RPC [For API reviewers]
    ⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L66
    ⚠️ OperationId OperationId for put method should contain both 'Create' and 'Update'
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L421
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L961
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1008
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1066
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1113
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1153
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1253
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1611
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1844
    ⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1929
    ⚠️ 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.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L1947


    The following errors/warnings exist before current PR submission:

    Rule Message
    HostParametersValidation The host parameter must be typed 'type 'string', format 'url''.
    Location: Azure.Analytics.Purview.Share/preview/2023-02-15-preview/share.json#L2096
    ️️✔️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 succeeded [Detail] [Expand]
    ️️✔️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 Jan 25, 2023

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️❌ azure-sdk-for-net-track2 failed [Detail]
    • Failed [Logs]Release - Generate from 12cbd66. SDK Automation 14.0.0
      Only show 20 items here, please refer to log for details.
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk. exit code: False
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGet-ChildItem: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:760
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 760 | �[0m … rtifacts += �[36;1mGet-ChildItem $artifactsPath -Filter *.nupkg -exclude *.s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m               ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mCannot find path
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m'/mnt/vss/_work/1/s/azure-sdk-for-net/artifacts/packages/Debug/' because
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1mit does not exist.
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1mGeneratePackage: �[0m/mnt/vss/_work/1/s/azure-sdk-for-net/eng/scripts/automation/GenerateAndBuildLib.ps1:672
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1mLine |
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m 672 | �[0m         �[36;1mGeneratePackage -projectFolder $projectFolder -sdkRootPath $s�[0m …
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[36;1m     | �[31;1m         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[31;1m�[36;1m     | �[31;1mFailed to generate sdk artifact
      cmderr	[Invoke-GenerateAndBuildV2.ps1] �[0m
    • Azure.Analytics.Purview.Account [View full logs]  [Release SDK Changes]
      info	[Changelog]
    • Azure.Analytics.Purview.Administration [View full logs]  [Release SDK Changes]
      info	[Changelog]
    • Azure.Analytics.Purview.Catalog [View full logs]  [Release SDK Changes]
      info	[Changelog]
    • Azure.Analytics.Purview.Scanning [View full logs]  [Release SDK Changes]
      info	[Changelog]
    • Azure.Analytics.Purview.Share [View full logs]  [Release SDK Changes]
      info	[Changelog]
    • Azure.Analytics.Purview.Workflows [View full logs]  [Release SDK Changes]
      info	[Changelog]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2023

    Generated ApiView

    Language Package Name ApiView Link
    swagger purview-data-plane-Azure.Analytics.Purview.Share https://apiview.dev/Assemblies/Review/3a169944515241f7b57e3fb70b9bb92d

    @AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required CI-FixRequiredOnFailure data-plane labels Jan 25, 2023
    @openapi-workflow-bot
    Copy link

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

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

    Copy link
    Member

    @mikekistler mikekistler left a comment

    Choose a reason for hiding this comment

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

    I made a quick pass and found some minor issues -- hopefully all easy fixes.

    Comment on lines 155 to 158
    "Azure-AsyncOperation": {
    "description": "The URL to track the status of the long running operation.",
    "type": "string"
    }
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Data-plane services should not return the "Azure-AsyncOperation" header.

    Comment on lines 408 to 410
    "summary": "Create or replace a sent share.",
    "description": "Create a sent share",
    "operationId": "SentShares_Create",
    Copy link
    Member

    Choose a reason for hiding this comment

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

    This is confusing. Does this operation only create or can it also replace? Please make the summary, description, and operationId consistent. And if replace is supported, add a 200 response.

    Copy link
    Contributor

    @faisalaltell12 faisalaltell12 Feb 15, 2023

    Choose a reason for hiding this comment

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

    @mikekistler In case of a replace, it might be long running as well. Is it ok to return a 200 with a long running operation header?

    Copy link
    Member

    Choose a reason for hiding this comment

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

    Yes.

    Comment on lines 499 to 502
    "Azure-AsyncOperation": {
    "description": "The URL to track the status of the long running operation.",
    "type": "string"
    }
    Copy link
    Member

    Choose a reason for hiding this comment

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

    No "Azure-AsyncOperation" header in data-plane.

    Suggested change
    "Azure-AsyncOperation": {
    "description": "The URL to track the status of the long running operation.",
    "type": "string"
    }

    Comment on lines 732 to 735
    "Azure-AsyncOperation": {
    "description": "The URL to track the status of the long running operation.",
    "type": "string"
    }
    Copy link
    Member

    Choose a reason for hiding this comment

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

    No "Azure-AsyncOperation" header in data-plane.

    "properties": {
    "properties": {
    "$ref": "#/definitions/AdlsGen2AccountSinkProperties",
    "x-ms-client-flatten": true
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Please remove all instances of "x-ms-client-flatten". This extension is deprecated and no longer supported by our client generators.

    @markweitzel markweitzel added the APIStewardship-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review label Feb 14, 2023
    Copy link
    Member

    @mikekistler mikekistler left a comment

    Choose a reason for hiding this comment

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

    A couple more small issues.

    ],
    "summary": "Create or replace a received share.",
    "description": "Update changes to a received share",
    "operationId": "ReceivedShares_CreateOrUpdate",
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Suggested change
    "operationId": "ReceivedShares_CreateOrUpdate",
    "operationId": "ReceivedShares_CreateOrReplace",

    ],
    "summary": "Create or replace a sent share.",
    "description": "Create or replace a sent share",
    "operationId": "SentShares_CreateOrUpdate",
    Copy link
    Member

    Choose a reason for hiding this comment

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

    Suggested change
    "operationId": "SentShares_CreateOrUpdate",
    "operationId": "SentShares_CreateOrReplace",

    Copy link
    Member

    @mikekistler mikekistler left a comment

    Choose a reason for hiding this comment

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

    Looks good. 👍

    @mikekistler
    Copy link
    Member

    @Azure/api-stewardship-board Could we get one more review/approve on this API?

    @mikekistler mikekistler added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label Feb 22, 2023
    @mikekistler
    Copy link
    Member

    @anuchandy I think this PR is ready to merge. Would you please do the honors.

    @anuchandy anuchandy merged commit 12cbd66 into Azure:main Feb 22, 2023
    aviyerMSFT pushed a commit to aviyerMSFT/azure-rest-api-specs that referenced this pull request Mar 22, 2023
    * add changes
    
    * clean up
    
    * clean up
    
    * Purview Share Specification Adjustments for Resources and Routes
    
    This commit makes the following updates to the specifications:
    - Removes /v2 from routes in the api specification.
    - Removes sink property from detached received share examples.
    
    * pipeline failures
    
    * Remove comma that is not needed
    
    * adjust incorrect spelling of word
    
    * commit changes
    
    * test fix
    
    * fixes
    
    * remove unneccessary files
    
    * lro headers fix
    
    * error fix
    
    * changes
    
    * changes
    
    * readme.md
    
    * changes
    
    * add security
    
    * Filter and security
    
    * push changes
    
    * changes
    
    * changes
    
    * changes
    
    * changes
    
    * Update examples
    
    * change
    
    * changes
    
    * add 202 to deletes
    
    * datetime rfc, state, route changes
    
    * CreateOrReplace rename, description enum rename
    
    ---------
    
    Co-authored-by: faisalaltell12 <faisalaltell@gmail.com>
    Co-authored-by: kbowersox <kbowersox@microsoft.com>
    Co-authored-by: kevinmichaelbowersox <99699543+kevinmichaelbowersox@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    APIStewardship-ChangesRequested <valid label in PR review process>add this label when assignee request changes after review APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. 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 data-plane Purview
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    [Microsoft Purview - Share] API Review
    10 participants