[Draft] Dot not merge #29118
Open
[Draft] Dot not merge #29118
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danielthank
requested review from
DominikMe and
bexxx
and removed request for
a team
Next Steps to MergeNext steps that must be taken to merge this PR:
Important checks have failed. As of today they are not blocking this PR, but in near future they will. Addressing the following failures is highly recommended:
|
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| asyncBatchManagement.json | 2024-04-01-preview(8da93aa) | 2024-04-01-preview(main) |
| route.json | 2024-04-01-preview(8da93aa) | 2024-04-01-preview(main) |
| search.json | 2024-04-01-preview(8da93aa) | 2024-04-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 specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-04 | package-preview-2024-04(8da93aa) | package-preview-2024-04(main) |
| package-preview-2024-04 | package-preview-2024-04(8da93aa) | package-preview-2024-04(main) |
| package-preview-2024-04 | package-preview-2024-04(8da93aa) | package-preview-2024-04(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
Error schema should define code and message properties as required.Location: AsyncBatchManagement/preview/2024-04-01-preview/asyncBatchManagement.json#L121 |
|
The error property in the error response schema should be required.Location: AsyncBatchManagement/preview/2024-04-01-preview/asyncBatchManagement.json#L121 |
|
Error schema should define code and message properties as required.Location: AsyncBatchManagement/preview/2024-04-01-preview/asyncBatchManagement.json#L161 |
|
The error property in the error response schema should be required.Location: AsyncBatchManagement/preview/2024-04-01-preview/asyncBatchManagement.json#L161 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: AsyncBatchManagement/preview/2024-04-01-preview/asyncBatchManagement.json#L303 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-04-01-preview/route.json#L122 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-04-01-preview/route.json#L137 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-04-01-preview/route.json#L185 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-04-01-preview/route.json#L245 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Route/preview/2024-04-01-preview/route.json#L355 |
|
| Property should have a defined type. Location: Route/preview/2024-04-01-preview/route.json#L849 |
|
| Property should have a defined type. Location: Route/preview/2024-04-01-preview/route.json#L854 |
|
| Property should have a defined type. Location: Route/preview/2024-04-01-preview/route.json#L997 |
|
| Property should have a defined type. Location: Route/preview/2024-04-01-preview/route.json#L1002 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Route/preview/2024-04-01-preview/route.json#L1792 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Route/preview/2024-04-01-preview/route.json#L2049 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-04-01-preview/search.json#L290 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-04-01-preview/search.json#L404 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-04-01-preview/search.json#L404 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-04-01-preview/search.json#L419 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-04-01-preview/search.json#L456 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-04-01-preview/search.json#L456 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-04-01-preview/search.json#L516 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-04-01-preview/search.json#L516 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-04-01-preview/search.json#L586 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-04-01-preview/search.json#L586 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-04-01-preview/search.json#L601 |
|
Error schema should define code and message properties as required.Location: Search/preview/2024-04-01-preview/search.json#L653 |
|
The error property in the error response schema should be required.Location: Search/preview/2024-04-01-preview/search.json#L653 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Search/preview/2024-04-01-preview/search.json#L668 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️⌛Automated merging requirements met pending [Detail]
Swagger Generation Artifacts
|
Generated ApiView
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Is this review for (select one):
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 API Spec document (if applicable), and the root paths that have been updated.
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
❔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
Getting help
Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.