Skip to content

Conversation

@Harshan01
Copy link
Member

@Harshan01 Harshan01 commented Sep 25, 2022

Data Plane API - Pull Request

Add SDK specific parameters (i.e. x-ms params)

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

@openapi-workflow-bot
Copy link

Hi, @Harshan01 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 Sep 25, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.9.7)] new version base version
    loadtestservice.json 2022-06-01-preview(e53deba) 2022-06-01-preview(main)
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    package-2022-06-01-preview package-2022-06-01-preview(e53deba) package-2022-06-01-preview(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppComponentModel'. Consider using the plural form of 'AppComponent' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.LoadTestService/preview/2022-06-01-preview/loadtestservice.json#L28
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppComponentModel'. Consider using the plural form of 'AppComponent' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.LoadTestService/preview/2022-06-01-preview/loadtestservice.json#L96
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppComponentModel'. Consider using the plural form of 'AppComponent' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.LoadTestService/preview/2022-06-01-preview/loadtestservice.json#L143
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppComponentModel'. Consider using the plural form of 'AppComponent' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.LoadTestService/preview/2022-06-01-preview/loadtestservice.json#L195
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️~[Staging] TrafficValidation 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.
    ️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/e53deba539cc1c1504900e76dfcce183b5a3b031/specification/loadtestservice/data-plane/readme.md#tag-package-2022-06-01-preview">loadtestservice/data-plane/readme.md#package-2022-06-01-preview
    ️️✔️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 Sep 25, 2022

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

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 25, 2022

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

    @AzureRestAPISpecReview AzureRestAPISpecReview added data-plane ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test labels Sep 25, 2022
    @Harshan01
    Copy link
    Member Author

    @mikekistler We had added x-ms-pageable parameter used for SDKs. Requesting review

    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. 👍

    @Harshan01
    Copy link
    Member Author

    @anuchandy Requesting you to review and merge this PR

    @anuchandy anuchandy merged commit 35390ea into Azure:main Oct 7, 2022
    @Harshan01 Harshan01 deleted the loadtest-sdk-params branch October 7, 2022 18:02
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    * pagination
    
    * Add java autorest config
    
    * Fix output-folder path
    
    * Revert operationId breaking change
    
    * Rename patch TestRun OpId
    
    Co-authored-by: Harshan B <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    data-plane ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    4 participants