Change two property types for route spec #28576

jecmenicanikola · 2024-04-03T14:53:08Z

While investigating Azure/azure-sdk-for-net#39869 and Azure/azure-sdk-for-net#38719, I found that the type returned by the server and the type that the server expects does not match what is currently on the spec.

This PR changes the type of 'sectionType' property from string to array and the type of 'roundaboutExitNumber' property from string to int.

When the SDK code is regenerated with these changes, custom code will have to be adapted to the new types.

openapi-pipeline-app · 2024-04-03T14:53:12Z

Next Steps to Merge

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:

⚠️ The check named TypeSpec Requirement (data-plane) has failed. TypeSpec usage is required for all new (greenfield) services. This is currently enforced as a warning for data-plane specs, but will be made a blocking error in the near future. For information on converting from OpenAPI specs to TypeSpec specs or on data-plane (DP) policies, refer to aka.ms/azsdk/typespec. If you have general questions on resource provider (RP) policies, refer to aka.ms/rphelp

If you still want to proceed merging this PR without addressing the above failures, refer to step 4 in the PR workflow diagram.

openapi-pipeline-app · 2024-04-03T14:53:12Z

Swagger Validation Report

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

Compared specs (v0.10.9)	new version	base version
route.json	1.0(eb7a854)	1.0(main)

Rule	Message
`❌` 1023 - TypeFormatChanged	The new version has a different format 'int64' than the previous one ''. New: Route/preview/1.0/route.json#L2218:9 Old: Route/preview/1.0/route.json#L2214:9
`❌` 1026 - TypeChanged	The new version has a different type 'array' than the previous one 'string'. New: Route/preview/1.0/route.json#L902:9 Old: Route/preview/1.0/route.json#L898:9
`❌` 1026 - TypeChanged	The new version has a different type 'array' than the previous one 'string'. New: Route/preview/1.0/route.json#L1045:9 Old: Route/preview/1.0/route.json#L1041:9
`❌` 1026 - TypeChanged	The new version has a different type 'array' than the previous one 'string'. New: Route/preview/1.0/route.json#L1152:9 Old: Route/preview/1.0/route.json#L1148:9
`❌` 1026 - TypeChanged	The new version has a different type 'integer' than the previous one 'string'. New: Route/preview/1.0/route.json#L2218:9 Old: Route/preview/1.0/route.json#L2214:9
`❌` 1026 - TypeChanged	The new version has a different type 'array' than the previous one 'string'. New: Route/preview/1.0/route.json#L1325:9 Old: Route/preview/1.0/route.json#L1321:9
`❌` 1026 - TypeChanged	The new version has a different type 'array' than the previous one 'string'. New: Route/preview/1.0/route.json#L609:5 Old: Route/preview/1.0/route.json#L609:5
`❌` 1028 - ArrayCollectionFormatChanged	The new version has a different array collection format than the previous one. New: Route/preview/1.0/route.json#L902:9 Old: Route/preview/1.0/route.json#L898:9
`❌` 1028 - ArrayCollectionFormatChanged	The new version has a different array collection format than the previous one. New: Route/preview/1.0/route.json#L1045:9 Old: Route/preview/1.0/route.json#L1041:9
`❌` 1028 - ArrayCollectionFormatChanged	The new version has a different array collection format than the previous one. New: Route/preview/1.0/route.json#L1152:9 Old: Route/preview/1.0/route.json#L1148:9
`❌` 1028 - ArrayCollectionFormatChanged	The new version has a different array collection format than the previous one. New: Route/preview/1.0/route.json#L1325:9 Old: Route/preview/1.0/route.json#L1321:9
`❌` 1028 - ArrayCollectionFormatChanged	The new version has a different array collection format than the previous one. New: Route/preview/1.0/route.json#L609:5 Old: Route/preview/1.0/route.json#L609:5
`❌` 1049 - RemovedXmsEnum	The new version is missing a 'x-ms-enum' found in the old version. Old: Route/preview/1.0/route.json#L898:9
`❌` 1049 - RemovedXmsEnum	The new version is missing a 'x-ms-enum' found in the old version. Old: Route/preview/1.0/route.json#L1041:9
`❌` 1049 - RemovedXmsEnum	The new version is missing a 'x-ms-enum' found in the old version. Old: Route/preview/1.0/route.json#L1148:9
`❌` 1049 - RemovedXmsEnum	The new version is missing a 'x-ms-enum' found in the old version. Old: Route/preview/1.0/route.json#L1321:9
`❌` 1049 - RemovedXmsEnum	The new version is missing a 'x-ms-enum' found in the old version. New: Route/preview/1.0/route.json#L609:5 Old: Route/preview/1.0/route.json#L609:5

️️✔️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
1.0	1.0(eb7a854)	1.0(main)

The following errors/warnings exist before current PR submission:

Only 30 items are listed, please refer to log for more details.

Rule	Message
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L525
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L533
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L541
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L576
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L766
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L891
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L997
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1038
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1146
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1165
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1176
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1188
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1318
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1338
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1349
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1355
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1502
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1663
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1712
`❌` OperationIdNounVerb	Per the Noun_Verb convention for Operation Ids, the noun 'Route' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Route/preview/1.0/route.json#L1753
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1892
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1897
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1902
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1919
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1924
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1953
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1958
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1963
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1974
`❌` IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Route/preview/1.0/route.json#L1979

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

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

openapi-pipeline-app · 2024-04-03T14:53:13Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

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

openapi-pipeline-app · 2024-04-03T14:53:14Z

Generated ApiView

Language	Package Name	ApiView Link
Swagger	1.0	https://apiview.dev/Assemblies/Review/84982204ccf042a393dc551a152f6a60?revisionId=508ea22a5c534ee7bc8195142753e9b7

microsoft-github-policy-service · 2024-04-03T14:53:25Z

Thank you for your contribution jecmenicanikola! We will review the pull request and get back to you soon.

dubiety · 2024-04-17T11:45:27Z

Hi @mikekistler and @bexxx ,
The API owner PM @FarazGIS already checked the document is wrong. The current and expected behavior should be the same as the current PR. Can you help to approve the PR?

dubiety · 2024-04-17T11:46:30Z

Also adding @FarazGIS as reviewer for awareness

mikekistler

Looks good. 👍

specification/maps/data-plane/Route/preview/1.0/route.json

dubiety · 2024-06-11T10:00:23Z

specification/maps/data-plane/Route/preview/1.0/route.json

-            "description": "Sections of the route that are located within urban areas."
-          }
-        ]
+      "description": "Specifies which of the section types is reported in the route response. <br><br>For example if sectionType = pedestrian the sections which are suited for pedestrians only are returned. Can be specified multiple times in one request, for example, '&sectionType=carTrain&sectionType=pedestrain&sectionType=motorway'. The default sectionType refers to the travelMode input. By default travelMode is set to car",


Typo: pedestrain -> pedestrian

@dubiety done

specification/maps/data-plane/Route/preview/1.0/route.json

Change two property types for route spec

9bce9cd

jecmenicanikola requested a review from a team as a code owner April 3, 2024 14:53

jecmenicanikola requested review from bexxx and mikekistler and removed request for a team April 3, 2024 14:53

microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Apr 3, 2024

AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required data-plane labels Apr 3, 2024

dubiety requested a review from FarazGIS April 17, 2024 11:46

mikekistler added the BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior label Apr 17, 2024

mikekistler approved these changes Apr 17, 2024

View reviewed changes

jecmenicanikola and others added 2 commits April 18, 2024 13:34

Add format to integer type

95ba0a0

Merge branch 'main' into fix-route-property-type-issue

31c94bc

jecmenicanikola mentioned this pull request May 27, 2024

Fix deserialization issue and add multiple support for SectionType Azure/azure-sdk-for-net#44262

Merged

dubiety reviewed May 31, 2024

View reviewed changes

specification/maps/data-plane/Route/preview/1.0/route.json Outdated Show resolved Hide resolved

Change description

a8c1417

dubiety approved these changes Jun 11, 2024

View reviewed changes

dubiety reviewed Jun 11, 2024

View reviewed changes

FarazGIS reviewed Jun 11, 2024

View reviewed changes

specification/maps/data-plane/Route/preview/1.0/route.json Outdated Show resolved Hide resolved

FarazGIS approved these changes Jun 11, 2024

View reviewed changes

Fix typo

eb7a854

dubiety merged commit eeb6a46 into Azure:main Jun 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Change two property types for route spec #28576

Change two property types for route spec #28576

Uh oh!

jecmenicanikola commented Apr 3, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

Uh oh!

microsoft-github-policy-service bot commented Apr 3, 2024

Uh oh!

dubiety commented Apr 17, 2024

Uh oh!

dubiety commented Apr 17, 2024

Uh oh!

mikekistler left a comment

Uh oh!

Uh oh!

dubiety Jun 11, 2024

Uh oh!

jecmenicanikola Jun 12, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Change two property types for route spec #28576

Change two property types for route spec #28576

Uh oh!

Conversation

jecmenicanikola commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Uh oh!

openapi-pipeline-app bot commented Apr 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generated ApiView

Uh oh!

microsoft-github-policy-service bot commented Apr 3, 2024

Uh oh!

dubiety commented Apr 17, 2024

Uh oh!

dubiety commented Apr 17, 2024

Uh oh!

mikekistler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dubiety Jun 11, 2024

Choose a reason for hiding this comment

Uh oh!

jecmenicanikola Jun 12, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jecmenicanikola commented Apr 3, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading

openapi-pipeline-app bot commented Apr 3, 2024 •

edited

Loading