[Maps Search] Update names based on APIView feedback for Preview 1.0 #16735
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
|
Hi, @alextts627 Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected] |
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The new version is missing a property found in the old version. Was 'error' renamed or removed? New: Search/preview/1.0/search.json#L1807:7 Old: Search/preview/1.0/search.json#L1800:7 |
| The new version has a different type 'integer' than the previous one 'number'. New: Common/preview/1.0/common.json#L119:9 Old: Common/preview/1.0/common.json#L119:9 |
|
| The new version has a different type 'integer' than the previous one 'number'. New: Common/preview/1.0/common.json#L119:9 Old: Common/preview/1.0/common.json#L119:9 |
|
| The new version has a different type 'integer' than the previous one 'number'. New: Common/preview/1.0/common.json#L119:9 Old: Common/preview/1.0/common.json#L119:9 |
|
| The new version has a different type 'integer' than the previous one 'number'. New: Common/preview/1.0/common.json#L119:9 Old: Common/preview/1.0/common.json#L119:9 |
️⚠️LintDiff: 0 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
| Rule | Message |
|---|---|
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Feedback/preview/1.0/feedback.json#L216 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1813 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1855 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1878 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Route/preview/1.0/route.json#L1969 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Search/preview/1.0/search.json#L2075 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1095 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1118 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1148 |
|
Inline/anonymous models must not be used, instead define a schema with a model name in the 'definitions' section and refer to it. This allows operations to share the models. Location: Spatial/preview/1.0/spatial.json#L1175 |
| The operation 'Dataset_Create' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Dataset/preview/2.0/dataset.json#L196 |
|
| The operation 'Conversion_Convert' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: DwgConversion/preview/2.0/dwgconversion.json#L203 |
|
| The operation 'Tileset_Create' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. Location: Tileset/preview/2.0/tileset.json#L216 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: FeatureState/preview/2.0/featurestate.json#L827 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: type Location: Search/preview/1.0/search.json#L3448 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: geometryType Location: WFS/preview/2.0/wfs.json#L887 |
|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_PutStateset', Response code: '200' Location: FeatureState/preview/2.0/featurestate.json#L325 |
|
| 200/201 Responses of long running operations must have a schema definition for return type. OperationId: 'FeatureState_UpdateStates', Response code: '200' Location: FeatureState/preview/2.0/featurestate.json#L465 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️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).
Swagger Generation Artifacts
|
|
Hi @alextts627, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. |
alextts627
changed the title
alextts627
requested review from
tjprescott
and removed request for
JeffreyRichter
JeffreyRichter
added
the
Approved-BreakingChange
tjprescott
reviewed
Nov 10, 2021
| @@ -453,7 +454,7 @@ | |||
| { | |||
| "name": "geometries", | |||
| "in": "query", | |||
| "x-ms-client-name": "geometryIds", | |||
| "x-ms-client-name": "listPolygons", | |||
There was a problem hiding this comment.
Was this from the Python APIView or something else? This seems like a strange name.
There was a problem hiding this comment.
@tjprescott I might misunderstood your comments on async def get_polygon method. I will change it back.
tjprescott
changed the title
alextts627
force-pushed
the
dev-maps-Search-1.0
branch
from
6401b71 to
8b9743d
Compare
|
Hi @tjprescott This PR was mean to be the updated of the swagger following by the feedback you gave, mostly are name changes for the parameters. For rest of the issues such as Coordinate type, optional params, etc.. I believe those will be done in the convenience layer for the SDK. Thank you! |
alextts627
force-pushed
the
dev-maps-Search-1.0
branch
from
8b9743d to
e2c0969
Compare
tjprescott
approved these changes
Nov 10, 2021
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
…zure#16735) * Update names * Update names, Type by feedback
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further questions about AME onboarding or validation tools, please view the FAQ.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.