RouteMatrix 2024-06-01-preview #29153
Merged
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
Next Steps to MergeImportant 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.9) | new version | base version |
|---|---|---|
| route.json | 2024-06-01-preview(dea21f7) | 2024-05-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 10 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-preview-2024-06 | package-preview-2024-06(dea21f7) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-06-01-preview/route.json#L513 |
||
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L554 |
||
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L618 |
||
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L667 |
||
The error property in the error response schema should be required.Location: Route/preview/2024-06-01-preview/route.json#L667 |
||
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L720 |
||
| 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-06-01-preview/route.json#L2528 |
||
| Property should have a defined type. Location: Route/preview/2024-06-01-preview/route.json#L3297 |
||
| Property should have a defined type. Location: Route/preview/2024-06-01-preview/route.json#L3302 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Route/preview/2024-06-01-preview/route.json#L3472 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L131 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-06-01-preview/route.json#L146 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L194 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L254 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-06-01-preview/route.json#L269 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L314 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-06-01-preview/route.json#L329 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L376 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-06-01-preview/route.json#L391 |
|
| Schema with type: number should specify format Location: Route/preview/2024-06-01-preview/route.json#L422 |
|
| Schema with type: number should specify format Location: Route/preview/2024-06-01-preview/route.json#L422 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L436 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Route/preview/2024-06-01-preview/route.json#L451 |
|
Error schema should define code and message properties as required.Location: Route/preview/2024-06-01-preview/route.json#L498 |
|
| 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-06-01-preview/route.json#L805 |
|
| 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-06-01-preview/route.json#L913 |
|
| 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-06-01-preview/route.json#L918 |
|
| 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-06-01-preview/route.json#L2962 |
|
| 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-06-01-preview/route.json#L2986 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Route/preview/2024-06-01-preview/route.json#L3052 |
️️✔️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 succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
koyasu221b
changed the title
koyasu221b
force-pushed
the
koyasu221b-maps-Route-2024-06-01-preview
branch
from
9589843
to
792a3c9
Compare
added 3 commits
May 22, 2024 09:47
evaou
reviewed
May 22, 2024
specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json
Outdated
Show resolved
Hide resolved
evaou
reviewed
May 22, 2024
specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json
Show resolved
Hide resolved
FarazGIS
reviewed
May 23, 2024
specification/maps/data-plane/Route/preview/2024-06-01-preview/route.json
Outdated
Show resolved
Hide resolved
added 3 commits
May 24, 2024 11:37
This reverts commit b7b2728.
koyasu221b
requested review from
scgbear and
johanste
and removed request for
a team
JeffreyRichter
approved these changes
May 30, 2024
|
@JeffreyRichter has this been approved by the API review board? |
|
Yes it has |
JeffreyRichter
added
the
APIStewardshipBoard-SignedOff
Francisco-Gamino
pushed a commit
to Francisco-Gamino/azure-rest-api-specs
that referenced
this pull request
Jun 5, 2024
* first commit * fix * Add operationType * rename to pointType * fix * update * Update example * update * update description for default value * update description * Remove axleCount for RouteMatrix * Update vehicleSpec * update description * Update description * remove async result * Revert "remove async result" This reverts commit b7b2728. * Remove Summary * follow azure's convention * Remove Accept-Language for RouteMatrix * Update retention period to 24 hours * Add createdDateTime * Add suppressions * Update description --------- Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Joel Hendrix <jhendrix@microsoft.com>
markcowl
pushed a commit
to markcowl/azure-rest-api-specs
that referenced
this pull request
Jun 7, 2024
* first commit * fix * Add operationType * rename to pointType * fix * update * Update example * update * update description for default value * update description * Remove axleCount for RouteMatrix * Update vehicleSpec * update description * Update description * remove async result * Revert "remove async result" This reverts commit b7b2728. * Remove Summary * follow azure's convention * Remove Accept-Language for RouteMatrix * Update retention period to 24 hours * Add createdDateTime * Add suppressions * Update description --------- Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Joel Hendrix <jhendrix@microsoft.com>
markcowl
pushed a commit
to markcowl/azure-rest-api-specs
that referenced
this pull request
Jun 7, 2024
* first commit * fix * Add operationType * rename to pointType * fix * update * Update example * update * update description for default value * update description * Remove axleCount for RouteMatrix * Update vehicleSpec * update description * Update description * remove async result * Revert "remove async result" This reverts commit b7b2728. * Remove Summary * follow azure's convention * Remove Accept-Language for RouteMatrix * Update retention period to 24 hours * Add createdDateTime * Add suppressions * Update description --------- Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Joel Hendrix <jhendrix@microsoft.com>
markcowl
pushed a commit
that referenced
this pull request
Jun 7, 2024
* first commit * fix * Add operationType * rename to pointType * fix * update * Update example * update * update description for default value * update description * Remove axleCount for RouteMatrix * Update vehicleSpec * update description * Update description * remove async result * Revert "remove async result" This reverts commit b7b2728. * Remove Summary * follow azure's convention * Remove Accept-Language for RouteMatrix * Update retention period to 24 hours * Add createdDateTime * Add suppressions * Update description --------- Co-authored-by: Will Huang <huangwill@microsoft.com> Co-authored-by: Joel Hendrix <jhendrix@microsoft.com>
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 - Pull Request
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
Checks stuck in `queued` state?
If the PR CI checks appear to be stuck in `queued` state, please add a comment with contents `/azp run`. This should result in a new comment denoting a `PR validation pipeline` has started and the checks should be updated after few minutes.