Creator api summary

[stevemunk]

Data Plane API - Pull Request

NO CHANGES TO ANY API, ONLY THE USER DOCUMENTATION.

Update Creator docs so that each services overview page shows a summary of the API, to do so, remove 'Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK.' paragraph.

for example:

Files to be updated: \preview\2.0\alias.json \preview\2.0\dataset.json \preview\2.0\dwgconversion.json \preview\2.0\featurestate.json \preview\2.0\tileset.json \preview\2.0\wfs.json \preview\2023-03-01-preview\alias.json \preview\2023-03-01-preview\dwgconversion.json \preview\2023-03-01-preview\featurestate.json \preview\2023-03-01-preview\mapconfiguration.json \preview\2023-03-01-preview\routeset.json \preview\2023-03-01-preview\wayfind.json

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.

• Link to API Spec engagement record issue:

Is this review for (select one):

• [ ] a private preview
• [ ] a public preview
• [ ] GA release

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

• Design Document:
• Previous API Spec Doc:
• Updated paths:

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 ApiView comment 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.

• 💬 Teams Channel
• 💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

• Open API validation tools were run on this PR. Go here to see how to fix errors
• Spectral Linting
• Open API Hub

Guidelines & Specifications

• Azure REST API Guidelines
• OpenAPI Style Guidelines
• Azure Breaking Change Policy

Helpful Links

• Azure DevTools Wiki

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.

[openapi-pipeline-app[bot]]

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

[openapi-pipeline-app[bot]]

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
alias.json	2.0(eeac337)	2.0(main)
dataset.json	2.0(eeac337)	2.0(main)
dwgconversion.json	2.0(eeac337)	2.0(main)
featurestate.json	2.0(eeac337)	2.0(main)
tileset.json	2.0(eeac337)	2.0(main)
wfs.json	2.0(eeac337)	2.0(main)
alias.json	2023-03-01-preview(eeac337)	2023-03-01-preview(main)
dwgconversion.json	2023-03-01-preview(eeac337)	2023-03-01-preview(main)
featurestate.json	2023-03-01-preview(eeac337)	2023-03-01-preview(main)
mapconfiguration.json	2023-03-01-preview(eeac337)	2023-03-01-preview(main)
style.json	2023-03-01-preview(eeac337)	2023-03-01-preview(main)
tileset.json	2023-03-01-preview(eeac337)	2023-03-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 tags (via openapi-validator v2.1.6)	new version	base version
package-stable-V2	package-stable-V2(eeac337)	package-stable-V2(main)
package-2023-03-preview	package-2023-03-preview(eeac337)	package-2023-03-preview(main)
package-2022-09-preview	package-2022-09-preview(eeac337)	package-2022-09-preview(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: Creator/preview/2.0/tileset.json#L309
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Creator/preview/2.0/tileset.json#L314
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Creator/preview/2.0/wfs.json#L70
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Creator/preview/2.0/wfs.json#L70
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Creator/preview/2.0/wfs.json#L737
❌ IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Creator/preview/2.0/wfs.json#L737
❌ ValidFormats	'file' is not a known format. Location: Creator/preview/2023-03-01-preview/mapconfiguration.json#L212
❌ ValidFormats	'file' is not a known format. Location: Creator/preview/2023-03-01-preview/style.json#L212
:warning: VersionConvention	API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Creator/preview/2.0/alias.json#L5
:warning: VersionConvention	API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: Creator/preview/2.0/alias.json#L5
:warning: OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/alias.json#L98
:warning: OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/alias.json#L98
:warning: ParameterDefaultNotAllowed	A required parameter should not specify a default value. Location: Creator/preview/2.0/alias.json#L108
:warning: ParameterDefaultNotAllowed	A required parameter should not specify a default value. Location: Creator/preview/2.0/alias.json#L108
:warning: Post201Response	Using post for a create operation is discouraged. Location: Creator/preview/2.0/alias.json#L116
:warning: Post201Response	Using post for a create operation is discouraged. Location: Creator/preview/2.0/alias.json#L116
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/alias.json#L128
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2.0/alias.json#L128
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2.0/alias.json#L128
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/alias.json#L128
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2.0/alias.json#L128
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2.0/alias.json#L128
:warning: OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/alias.json#L135
:warning: OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AliasModel'. Consider using the plural form of 'Alias' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Creator/preview/2.0/alias.json#L135
:warning: ParameterDefaultNotAllowed	A required parameter should not specify a default value. Location: Creator/preview/2.0/alias.json#L145
:warning: ParameterDefaultNotAllowed	A required parameter should not specify a default value. Location: Creator/preview/2.0/alias.json#L145
:warning: PaginationResponse	Response body schema of pageable response should contain top-level array property value Location: Creator/preview/2.0/alias.json#L156
:warning: PaginationResponse	Response body schema of pageable response should contain top-level array property value Location: Creator/preview/2.0/alias.json#L156
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2.0/alias.json#L160
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2.0/alias.json#L160

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

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

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

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
Swagger	2.0	https://apiview.dev/Assemblies/Review/6e092b676120412a8ae192ce902e999e?revisionId=844de59d941f4ddda32911ad74885ffb
Swagger	Creator	https://apiview.dev/Assemblies/Review/2a9b4231903d447ca023dc3869e280f9?revisionId=752289fee8b444b3af9f0ebafd470ee5

[stevemunk]

There are Git conflict markers in these files.

What? Where? Which files?

[tjprescott]

There are Git conflict markers in these files.

What? Where? Which files?

But it looks like I was looking at a specific commit. Looking at the PR overall it looks like they've all been removed.

[tjprescott]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 4 pipeline(s).

[scbedd]

@mikekistler ack and confirmed. Thank you for noticing this issue and following up.

@stevemunk on the next PR that comes through, this is the adjustment to WFS_GetFeatures.json that you need. wfs.json remains error free with the below. Even if you're only adjusting documentation, this is a fairly straightforward adjustment.

[stevemunk]

@mikekistler @scbedd

See PR 27516