[Marketplace Catalog - Products] - data plane api new branch

[alonhann]

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):

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

• 💬 Teams Channel
• 💌 email

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

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

fix https://github.com/Azure/azure-rest-api-specs/issues/21168

[openapi-workflow-bot[bot]]

Hi, @alonhann 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[bot]]

Swagger Validation Report

️⌛BreakingChange pending [Detail]

️⌛Breaking Change(Cross-Version) pending [Detail]

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️⌛ApiReadinessCheck pending [Detail]

️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]

️⌛~[Staging] TrafficValidation pending [Detail]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️⌛SemanticValidation pending [Detail]

️⌛PoliCheck pending [Detail]

️⌛SDK Track2 Validation pending [Detail]

️🔄PrettierCheck inProgress [Detail]

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️🔄Lint(RPaaS) inProgress [Detail]

️⌛CadlValidation pending [Detail]

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

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

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

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

[ruowan]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[openapi-pipeline-app[bot]]

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: 11 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-09-01-preview	package-2022-09-01-preview(567c3a5)	default(main)

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

Rule	Message	Related RPC [For API reviewers]
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L324
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L336
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L349
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L361
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L373
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L406
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L421
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L434
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L606
:warning: R4020 - DescriptiveDescriptionRequired	The value provided for description is not descriptive enough. Accurate and descriptive description is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L698
:warning: R4022 - OperationDescriptionOrSummaryRequired	SinglePublicOffer_Get lacks 'description' and 'summary' property. Consider adding a 'description'/'summary' element. Accurate description/summary is essential for maintaining reference documentation. Location: Products/preview/2022-09-01-preview/product.json#L14

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️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.

️️✔️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-workflow-bot[bot]]

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

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[tjprescott]

This PR is not structured appropriately for a new API version review. The first commit must be copying the baseline swagger to the new folder. The second should update the API version throughout and subsequent (ideally one) commits should reflect the actual changes.

[alonhann]

hey @tjprescott, thanks for the info. This is a totally new API, we don't have a previous version documented. should I keep updating this PR or create a new one with a single commit?

[tjprescott]

@alonhann thanks for the clarification. In that case, this needs to go before the REST API stewardship board. If it already has, please include a link in the description to the engagement issue that you would already have from the Azure/azure-sdk repo.

[ghost]

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

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