[Hub Generated] Review request for Creator to add version preview/2022-09-01-preview

[davsta90]

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

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.

• 💬 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

[openapi-workflow-bot[bot]]

Hi, @davsta90 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 inProgress [Detail]

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

️⌛CredScan pending [Detail]

️🔄LintDiff inProgress [Detail]

️🔄Avocado inProgress [Detail]

️⌛ApiReadinessCheck pending [Detail]

️🔄~[Staging] ServiceAPIReadinessTest inProgress [Detail]

️⌛ModelValidation pending [Detail]

️⌛SemanticValidation pending [Detail]

️⌛PoliCheck pending [Detail]

️🔄SDK Track2 Validation inProgress [Detail]

️⌛PrettierCheck pending [Detail]

️⌛SpellCheck pending [Detail]

️⌛Lint(RPaaS) pending [Detail]

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️⌛PR Summary pending [Detail]

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

[openapi-pipeline-app[bot]]

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

[openapi-pipeline-app[bot]]

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

[openapi-workflow-bot[bot]]

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

[davsta90]

there are model validation fixes which seem to be false positives:

ROUTESET.JSON ERROR (DeleteOperationResponses/R4011/ARMViolation): The delete operation is defined without a 200 or 204 error response implementation,please add it.'

WAYFIND.JSON and ROUTESET.JSON: ERROR (OperationsAPIImplementation/R3023/ARMViolation): Operations API must be implemented for '/providers//operations'. ERROR (SecurityDefinitionsStructure/R2054/SDKViolation): Every swagger/configuration must have a security definitions section and it must adhere to the structure described in: https://github.com/Azure/azure-openapi-validator/blob/master/docs/security-definitions-structure-validation.md

[openapi-pipeline-app[bot]]

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.1)]	new version	base version
2022-09-01-preview	2022-09-01-preview(018f0db)	2022-09-01-preview(main)
types.json	1.0(018f0db)	1.0(main)

Rule	Message
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2022-09-01-preview/routeset.json#L187:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2022-09-01-preview/routeset.json#L256:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2022-09-01-preview/routeset.json#L317:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2022-09-01-preview/wayfind.json#L253:5

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 1 Warnings warning [Detail]

compared tags (via openapi-validator v1.13.0)	new version	base version
package-preview-2022-09	package-preview-2022-09(018f0db)	package-preview-2022-09(main)

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

Rule	Message	Related RPC [For API reviewers]
:warning: R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'RoutesetModel'. Consider using the plural form of 'Routeset' 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: Creator/preview/2022-09-01-preview/routeset.json#L190

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

️❌ModelValidation: 1 Errors, 0 Warnings failed [Detail]

Rule	Message
❌ LRO_RESPONSE_HEADER	Long running operation should return location or azure-AsyncOperation in header but not provided Url: Creator/preview/2022-09-01-preview/routeset.json#L214:22 ExampleUrl: 2022-09-01-preview/examples/wayfind/Routeset_Create.json

️️✔️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?}

[davsta90]

/azp run unifiedPipeline

[azure-pipelines[bot]]

No pipelines are associated with this pull request.

[davsta90]

/azp run unifiedPipeline

[azure-pipelines[bot]]

No pipelines are associated with this pull request.

[openapi-workflow-bot[bot]]

NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[weidongxu-microsoft]

Ignore BreakingChange and ModelValidation

BreakingChanges compare to 2022-09-01-preview in main and figure out several new APIs. Data-plane usually have different jsons.

ModelValidation on "LRO_RESPONSE_HEADER" only apply to ARM.