azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard

Added data plane swagger for Microsoft.DataBox RP for EventGrid system topic

Open aakash049 opened this issue 3 years ago • 6 comments

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
  • [x] 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

aakash049 avatar Oct 17 '22 19:10 aakash049

Hi, @aakash049 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]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️❌LintDiff: 2 Errors, 0 Warnings failed [Detail] [must fix]The following errors/warnings are introduced by current PR:
    Rule Message Related RPC [For API reviewers]
    AutoRest exception "location":"specification/eventgrid/data-plane/readme.md",
    "tag":"default",
    "details":"swagger-document/individual/schema-validator - FAILED"
    AutoRest exception "location":"specification/eventgrid/data-plane/readme.md",
    "tag":"default",
    "details":"Error: [OperationAbortedException] Error occurred. Exiting."
    ️❌Avocado: 7 Errors, 0 Warnings failed [Detail]
    Rule Message
    UNREFERENCED_JSON_FILE The swagger JSON file is not referenced from the readme file.
    readme: specification/eventgrid/data-plane/readme.md
    json: Microsoft.DataBox/stable/2018-01-01/DataBox.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/eventgrid/data-plane/readme.md
    json: 2018-01-01/examples/cloud-events-schema/copy_completed.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/eventgrid/data-plane/readme.md
    json: 2018-01-01/examples/cloud-events-schema/copy_started.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/eventgrid/data-plane/readme.md
    json: 2018-01-01/examples/cloud-events-schema/order_completed.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/eventgrid/data-plane/readme.md
    json: 2018-01-01/examples/event-grid-schema/copy_completed.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/eventgrid/data-plane/readme.md
    json: 2018-01-01/examples/event-grid-schema/copy_started.json
    UNREFERENCED_JSON_FILE The example JSON file is not referenced from the swagger file.
    readme: specification/eventgrid/data-plane/readme.md
    json: 2018-01-01/examples/event-grid-schema/order_completed.json
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation
    ️️✔️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?

    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 succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from d9775eb1ed78c740365ddf39661c7ef35c50986c. SDK Automation 14.0.0
      command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
    • ️✔️Azure.Messaging.EventGrid [View full logs]  [Preview SDK Changes]
      info	[Changelog]
    Posted by Swagger Pipeline | How to fix these errors?

    Generated ApiView

    Language Package Name ApiView Link
    .Net Azure.Messaging.EventGrid Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

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

    @aakash049 can you let us know when you are hoping to deploy these changes on the service, and when you are looking for the client libraries to be published?

    JoshLove-msft avatar Oct 25 '22 19:10 JoshLove-msft

    Hi, @aakash049. 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 avatar Nov 13 '22 16:11 ghost

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

    ghost avatar Nov 28 '22 05:11 ghost