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

zhugexubin · 2022-04-06T20:57:35Z

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:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No refresh required for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

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.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

Please follow the link to find more details on PR review process.

…22-01-01-preview

openapi-workflow-bot · 2022-04-06T20:57:38Z

Hi, @zhugexubin 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. vscswagger@microsoft.com

openapi-workflow-bot · 2022-04-06T20:57:39Z

[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.

openapi-pipeline-app · 2022-04-06T20:57:40Z

Swagger pipeline can not start as the pull request has merge conflicts.

openapi-pipeline-app · 2022-04-06T20:57:41Z

Swagger pipeline can not start as the pull request has merge conflicts.

openapi-workflow-bot · 2022-04-06T20:59:54Z

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

propheel

A bunch of corrections but looks great in general.

propheel · 2022-07-21T20:12:56Z

custom-words.txt

@@ -1992,6 +1993,9 @@ streamingendpoint
 streamingjobs
 streamingservice
 structdef
+stylerecipe


We can remove those 3 words now

propheel · 2022-07-21T20:13:58Z

...ne/Creator/preview/2022-01-01-preview/examples/mapconfiguration/MapConfiguration_Create.json

+    "MapConfiguration": {
+      "version": 1.0,
+      "description": "This is Microsoft default indoor map configuration",
+      "defaultStyle": "microsoft_light",


indoor_light

propheel · 2022-07-21T20:21:23Z

...ne/Creator/preview/2022-01-01-preview/examples/mapconfiguration/MapConfiguration_Create.json

+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "https://us.atlas.microsoft.com/styles/mapConfigurations/operations/{operationId}?api-version=2022-01-01-preview",


Should we use just a sample GUID instead of {operationId}?

propheel · 2022-07-21T20:21:37Z

...fication/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json

+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "https://us.atlas.microsoft.com/styles/operations/{operationId}?api-version=2022-01-01-preview",


Should we use just a sample GUID instead of {operationId}?

propheel · 2022-07-21T20:22:18Z

...tion/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json

+  "responses": {
+    "202": {
+      "headers": {
+        "Operation-Location": "https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2022-01-01-preview",


Should we use just a sample GUID instead of {operationId}?

propheel · 2022-07-21T20:57:50Z

specification/maps/data-plane/Creator/preview/2022-01-01-preview/mapconfiguration.json

+        },
+        "layers": {
+          "description": "To configure the style for tileset. You can have one style for the whole tileset. And you can have different styles for different layers in one tileset, for example, one style for `indoor unit` layer and another style for `indoor facility` layer. And you have also have one style for different tileset",
+          "items": {


I think we are missing "type": "array" here

propheel · 2022-07-21T21:00:04Z

...ne/Creator/preview/2022-01-01-preview/examples/mapconfiguration/MapConfiguration_Create.json

+    "api-version": "2022-01-01-preview",
+    "alias": "sample-alias",
+    "description": "This is my first map configuration.",
+    "MapConfiguration": {


Shouldn't this be just a ZIP file body?

propheel · 2022-07-21T21:00:32Z

specification/maps/data-plane/Creator/preview/2022-01-01-preview/mapconfiguration.json

+            "in": "body",
+            "description": "The configuration file used to create the map configuration. If JSON data format is provided, then the request body should follow [MapConfiguration specification](/rest/api/documentation-preview/map-configuration/create?#mapconfiguration). If ZIP data format is provided, you should also provide the thumbnail images referenced in the configuration JSON file.",
+            "required": true,
+            "schema": {


Shouldn't it be just a ZIP file body?

propheel · 2022-07-21T22:32:01Z

specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json

+    },
+    "/styles/operations/{operationId}": {
+      "get": {
+        "description": "This path will be obtained from a call to create a style.  While in progress, an http200 will be returned with no extra headers -  followed by an http200 with Resource-Location header once successfully completed.",


http200 ?

propheel · 2022-07-21T22:34:36Z

specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json

+    },
+    "/tilesets/operations/{operationId}": {
+      "get": {
+        "description": "This path will be obtained from a call to /tilesets/create.  While in progress, an http200 will be returned with no extra headers -  followed by an http200 with Resource-Location header once successfully completed.",


http200 ?

zhugexubin added 4 commits April 5, 2022 12:58

Adds base for updating Creator from version preview/2.0 to version 20…

4457e7a

…22-01-01-preview

Updates readme

2b26c04

Updates API version in new specs and examples

4ee9795

Add tileset, styleRecipe and styleSet API specs

f98571c

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Apr 6, 2022

zhugexubin added 8 commits May 19, 2022 17:36

custom styling api naming changes

1f256c6

Renaming fixes

4a0a80b

optimize tileset swagger

8c95168

Add some reference links

a8e08f9

Add more details for map configuration

0f0a8d1

Update baseMap types reference

1a1bbec

Rename custom styling service name and path

4c6c2e8

update examples

73f943f

czubair added the API Review Scoping This is an issue that will track work on a specific set of API changes. label Jun 2, 2022

czubair linked an issue Jun 2, 2022 that may be closed by this pull request

[Maps - Styling] REST API Review for Azure Maps Styling Service #17312

Closed

zhugexubin added 6 commits July 5, 2022 18:07

Fix some comments

4b79af0

couple fixes from API review board

afa4216

Change response content type

676055c

update examples

59fada9

update samples

c12921a

Fix more validations

a9e01e6

propheel reviewed Jul 21, 2022

View reviewed changes

tjprescott mentioned this pull request Aug 5, 2022

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

Merged

3 tasks

zhugexubin closed this Nov 2, 2022

zhugexubin deleted the dev-maps-Creator-2022-01-01-preview-latest branch November 2, 2022 00:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

zhugexubin commented Apr 6, 2022 •

edited

Loading

openapi-workflow-bot bot commented Apr 6, 2022

openapi-workflow-bot bot commented Apr 6, 2022

openapi-pipeline-app bot commented Apr 6, 2022 •

edited

Loading

openapi-pipeline-app bot commented Apr 6, 2022 •

edited

Loading

openapi-workflow-bot bot commented Apr 6, 2022

propheel left a comment

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

propheel Jul 21, 2022

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

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

Conversation

zhugexubin commented Apr 6, 2022 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Apr 6, 2022

openapi-workflow-bot bot commented Apr 6, 2022

openapi-pipeline-app bot commented Apr 6, 2022 • edited Loading

openapi-pipeline-app bot commented Apr 6, 2022 • edited Loading

openapi-workflow-bot bot commented Apr 6, 2022

propheel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhugexubin commented Apr 6, 2022 •

edited

Loading

openapi-pipeline-app bot commented Apr 6, 2022 •

edited

Loading

openapi-pipeline-app bot commented Apr 6, 2022 •

edited

Loading