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

[Storage] Add data plane Blob Storage swagger #15734

Merged
merged 5 commits into from
Aug 24, 2021
Merged

Conversation

tg-msft
Copy link
Member

@tg-msft tg-msft commented Aug 21, 2021

Add a swagger spec for the 2020-10-02 version of Blob Storage.

@openapi-workflow-bot
Copy link

Hi, @tg-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. 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 Aug 21, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 11 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Service_SetProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L33
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Container_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L927
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Container_SubmitBatch' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L1485
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Container_BreakLease' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L1943
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Blob_Delete' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L3506
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Blob_BreakLease' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L5574
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Blob_StartCopyFromURL' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L5833
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Blob_CopyFromURL' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L5994
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Blob_SetTier' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L6264
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'PageBlob_CopyIncremental' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L8104
    ⚠️ R2018 - XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options. Property name: QueryType
    Location: Microsoft.BlobStorage/preview/2020-10-02/blob.json#L10672
    ️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: 3e79cd0365aafcd7b200baabf579d5c2fc058518/specification/storage/data-plane
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"storage/data-plane/Microsoft.BlobStorage/readme.md",
    "tag":"package-2020-10",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"storage/data-plane/Microsoft.BlobStorage/readme.md",
    "tag":"package-2020-10",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"storage/data-plane/Microsoft.BlobStorage/readme.md",
    "tag":"package-2020-10",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"storage/data-plane/Microsoft.BlobStorage/readme.md",
    "tag":"package-2020-10",
    "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] 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 Aug 21, 2021

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

    @openapi-workflow-bot
    Copy link

    Hi @tg-msft, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @tg-msft tg-msft changed the title Try Blobs by itself with no root readme [Storage] Add data plane Blob Storage swagger Aug 23, 2021
    @tg-msft tg-msft marked this pull request as ready for review August 23, 2021 17:48
    Copy link
    Member

    @tjprescott tjprescott left a comment

    Choose a reason for hiding this comment

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

    For all practical purposes, there is no way I can review a 12k line Swagger, so I am purely relying on the CI for this approval.

    @tasherif-msft
    Copy link
    Contributor

    LGTM

    @tjprescott
    Copy link
    Member

    You need to resolve the conflicts before this can be merged.

    @tasherif-msft
    Copy link
    Contributor

    tasherif-msft commented Aug 24, 2021

    @tjprescott I have resolved the conflict. It's ready to be merged. I do not have the authority to do so.

    @tjprescott tjprescott merged commit 44017a2 into Azure:main Aug 24, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants