From 1463c8326dc73adc34c94fc2463eb069ef15be7a Mon Sep 17 00:00:00 2001 From: Xubin Date: Wed, 8 Dec 2021 17:13:08 -0800 Subject: [PATCH 01/23] Adds base for updating Creator from version preview/2.0 to version 2022-01-01-preview --- .../preview/2022-01-01-preview/alias.json | 312 +++++++ .../preview/2022-01-01-preview/data.json | 471 +++++++++++ .../preview/2022-01-01-preview/dataset.json | 353 ++++++++ .../2022-01-01-preview/dwgconversion.json | 351 ++++++++ .../examples/alias/Alias_Assign.json | 18 + .../examples/alias/Alias_Create.json | 17 + .../examples/alias/Alias_Delete.json | 10 + .../examples/alias/Alias_Get.json | 17 + .../examples/alias/Alias_List.json | 26 + .../conversion/Conversion_Conversion.json | 26 + .../conversion/Conversion_Delete.json | 10 + .../examples/conversion/Conversion_Get.json | 26 + .../conversion/Conversion_GetOperation.json | 33 + .../Conversion_GetOperationStillRunning.json | 16 + .../examples/conversion/Conversion_List.json | 44 + .../examples/data/Data_Delete.json | 10 + .../examples/data/Data_Download.json | 12 + .../examples/data/Data_GetOperation.json | 19 + .../data/Data_GetOperationStillRunning.json | 16 + .../examples/data/Data_List.json | 32 + .../examples/data/Data_Update.json | 53 ++ .../examples/data/Data_Upload.json | 53 ++ .../examples/dataset/Dataset_Create.json | 25 + .../examples/dataset/Dataset_Delete.json | 10 + .../examples/dataset/Dataset_GetDetails.json | 39 + .../dataset/Dataset_GetOperation.json | 19 + .../Dataset_GetOperationStillRunning.json | 16 + .../examples/dataset/Dataset_List.json | 57 ++ .../Featurestate_CreateStateset.json | 72 ++ .../Featurestate_DeleteFeatureState.json | 12 + .../Featurestate_DeleteStateset.json | 10 + .../Featurestate_GetStateset.json | 73 ++ .../featurestate/Featurestate_List.json | 77 ++ .../featurestate/Featurestate_ListStates.json | 21 + .../Featurestate_UpdateStates.json | 20 + .../Featurestate_UpdateStateset.json | 56 ++ .../examples/tileset/Tileset_Create.json | 25 + .../examples/tileset/Tileset_Delete.json | 10 + .../examples/tileset/Tileset_Get.json | 24 + .../tileset/Tileset_GetOperation.json | 19 + .../Tileset_GetOperationStillRunning.json | 16 + .../examples/tileset/Tileset_List.json | 40 + .../examples/wfs/WFS_DeleteFeature.json | 12 + .../examples/wfs/WFS_GetCollection.json | 34 + .../wfs/WFS_GetCollectionDefinition.json | 152 ++++ .../examples/wfs/WFS_GetCollections.json | 253 ++++++ .../examples/wfs/WFS_GetFeature.json | 84 ++ .../examples/wfs/WFS_GetFeatures.json | 93 +++ .../examples/wfs/WFS_GetLandingPage.json | 41 + .../examples/wfs/WFS_ListConformance.json | 19 + .../2022-01-01-preview/featurestate.json | 694 ++++++++++++++++ .../preview/2022-01-01-preview/tileset.json | 326 ++++++++ .../preview/2022-01-01-preview/wfs.json | 772 ++++++++++++++++++ 53 files changed, 5046 insertions(+) create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json new file mode 100644 index 000000000000..91d2e5d3e70e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json @@ -0,0 +1,312 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Alias Service", + "version": "2.0", + "description": "APIs for managing aliases in Azure Maps." + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "CreateCreatorDataItemId": { + "name": "creatorDataItemId", + "description": "The unique id that references a creator data item to be aliased.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "AssignCreatorDataItemId": { + "name": "creatorDataItemId", + "description": "The unique id that references a creator data item to be aliased.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "AliasId": { + "name": "aliasId", + "description": "The unique id that references an existing alias.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/aliases": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "operationId": "Alias_Create", + "x-ms-examples": { + "Create an alias that does not reference any resource": { + "$ref": "./examples/alias/Alias_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/CreateCreatorDataItemId" + } + ], + "responses": { + "201": { + "description": "Content created successfully. The response body contains the newly created alias id `aliasId`.", + "schema": { + "$ref": "#/definitions/Alias" + }, + "headers": { + "Access-Control-Expose-Headers": { + "type": "string", + "description": "The list of response headers that can be read by the client." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", + "operationId": "Alias_List", + "x-ms-examples": { + "List all the previously created aliases": { + "$ref": "./examples/alias/Alias_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "aliases", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List alias request completed successfully. The response body contains a list of all the previously created aliases.", + "schema": { + "$ref": "#/definitions/AliasListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/aliases/{aliasId}": { + "put": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "operationId": "Alias_Assign", + "x-ms-examples": { + "Assign an alias to a resource": { + "$ref": "./examples/alias/Alias_Assign.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/AssignCreatorDataItemId" + } + ], + "responses": { + "200": { + "description": "Alias was assigned successfully.", + "schema": { + "$ref": "#/definitions/Alias" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", + "operationId": "Alias_Delete", + "x-ms-examples": { + "Delete previously created alias": { + "$ref": "./examples/alias/Alias_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "204": { + "description": "Alias delete request completed successfully. The content for `aliasId` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", + "operationId": "Alias_Get", + "x-ms-examples": { + "Get a previously created alias": { + "$ref": "./examples/alias/Alias_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/AliasId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "Get alias request completed successfully. The response body contains the previously created alias.", + "schema": { + "$ref": "#/definitions/Alias" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "AliasListResult": { + "description": "The response model for the List API. Returns a list of all the previously created aliases.", + "type": "object", + "properties": { + "aliases": { + "description": "A list of all the previously created aliases.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Alias" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "Alias": { + "description": "Detailed information for the alias.", + "type": "object", + "properties": { + "createdTimestamp": { + "description": "The created timestamp for the alias.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "aliasId": { + "description": "The id for the alias.", + "type": "string", + "readOnly": true + }, + "creatorDataItemId": { + "description": "The id for the creator data item that this alias references (could be null if the alias has not been assigned).", + "type": "string", + "x-nullable": true, + "readOnly": true + }, + "lastUpdatedTimestamp": { + "description": "The timestamp of the last time the alias was assigned.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json new file mode 100644 index 000000000000..0db86c566229 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json @@ -0,0 +1,471 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Data Service", + "version": "2.0", + "description": "APIs for uploading map data to Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "DataFormat": { + "name": "dataFormat", + "description": "Data format of the content being uploaded.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "geojson", + "zip", + "dwgzippackage" + ], + "x-ms-enum": { + "name": "DataFormat", + "modelAsString": true, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + }, + { + "value": "zip", + "description": "Compressed data format." + }, + { + "name": "dwgZipPackage", + "value": "dwgzippackage", + "description": "ZIP package containing DWG file." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "UniqueDataId": { + "name": "udid", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "UploadDataDescription": { + "name": "description", + "description": "The description to be given to the upload.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "DataUploadOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the data upload request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/mapData": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", + "operationId": "Data_Upload", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Upload GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Upload.json" + } + }, + "consumes": [ + "application/json", + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UploadDataDescription" + }, + { + "$ref": "#/parameters/DataFormat" + }, + { + "name": "UploadContent", + "in": "body", + "description": "The content to upload.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "409": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
", + "operationId": "Data_List", + "x-ms-examples": { + "List all the previously uploaded data": { + "$ref": "./examples/data/Data_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "List data request completed successfully. The response body contains a list of all the previously uploaded data.", + "schema": { + "$ref": "#/definitions/MapDataListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/mapData/{udid}": { + "put": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", + "operationId": "Data_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Update.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UniqueDataId" + }, + { + "$ref": "#/parameters/UploadDataDescription" + }, + { + "name": "UpdateContent", + "in": "body", + "description": "The new content that will update/replace the previously uploaded content.", + "required": true, + "schema": { + "type": "object" + } + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "409": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", + "operationId": "Data_Download", + "x-ms-examples": { + "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Download.json" + } + }, + "produces": [ + "application/json", + "application/vnd.geo+json", + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UniqueDataId" + } + ], + "responses": { + "200": { + "description": "Data download request completed successfully. The response body will contain the content for the passed in `udid`.", + "schema": { + "type": "file" + }, + "headers": { + "Content-Type": { + "type": "string", + "description": "The content-type for the Download API response." + } + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", + "operationId": "Data_Delete", + "x-ms-examples": { + "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { + "$ref": "./examples/data/Data_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UniqueDataId" + } + ], + "responses": { + "204": { + "description": "Data delete request completed successfully. The content for `udid` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/mapData/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to POST /mapData. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once completed.", + "operationId": "Data_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/data/Data_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/data/Data_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DataUploadOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "MapDataListResult": { + "description": "The response model for the Data List API. Returns a list of all the previously uploaded data.", + "type": "object", + "properties": { + "mapDataList": { + "description": "A list of all the previously uploaded data.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MapData" + } + } + } + }, + "DataFormat": { + "description": "Data format of the uploaded content.", + "type": "string", + "readOnly": true, + "enum": [ + "geojson", + "zip", + "dwgzippackage" + ], + "x-ms-enum": { + "name": "DataFormat", + "modelAsString": true, + "values": [ + { + "value": "geojson", + "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." + }, + { + "value": "zip", + "description": "Compressed data format." + }, + { + "name": "dwgZipPackage", + "value": "dwgzippackage", + "description": "ZIP package containing DWG file." + } + ] + } + }, + "UploadStatus": { + "description": "The current upload status of the content.", + "type": "string", + "readOnly": true, + "enum": [ + "Pending", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "UploadStatus", + "values": [ + { + "value": "Pending", + "description": "Upload is processing" + }, + { + "value": "Completed", + "description": "Upload validation and processing completed" + }, + { + "value": "Failed", + "description": "Upload validation and/or processing failure" + } + ] + } + }, + "MapData": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "udid": { + "description": "The unique data id for the data.", + "type": "string", + "readOnly": true + }, + "location": { + "x-ms-client-name": "locationURL", + "description": "The location of the data. Execute a HTTP `GET` on this location to download the data.", + "type": "string", + "format": "uri", + "readOnly": true + }, + "sizeInBytes": { + "description": "The size of the content in bytes.", + "type": "integer", + "format": "int64", + "readOnly": true + }, + "uploadStatus": { + "$ref": "#/definitions/UploadStatus" + }, + "dataFormat": { + "$ref": "#/definitions/DataFormat" + }, + "description": { + "description": "The current description.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json new file mode 100644 index 000000000000..6a724a677cd8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json @@ -0,0 +1,353 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Dataset Service", + "version": "2.0", + "description": "APIs for managing datasets from uploaded data in Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "ConversionIdQuery": { + "name": "conversionId", + "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "DatasetDescription": { + "name": "description", + "description": "The description to be given to the dataset.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "DatasetId": { + "name": "datasetId", + "type": "string", + "in": "path", + "description": "The identifier for the dataset to query from.", + "required": true, + "x-ms-parameter-location": "method" + }, + "AppendDatasetId": { + "name": "datasetId", + "type": "string", + "in": "query", + "description": "The ID for the dataset to append with. The dataset must originate from a previous dataset creation call that matches the datasetId", + "x-ms-parameter-location": "method" + }, + "DatasetOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the dataset create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/datasets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Service and converted using the Azure Maps Conversion Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps Conversion Service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n### Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter will be the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).\n\nThe Create API is a [long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "Dataset_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create dataset from a converted CAD file provided by conversionId": { + "$ref": "./examples/dataset/Dataset_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ConversionIdQuery" + }, + { + "$ref": "#/parameters/AppendDatasetId" + }, + { + "$ref": "#/parameters/DatasetDescription" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", + "operationId": "Dataset_List", + "x-ms-examples": { + "List all the previously created datasets": { + "$ref": "./examples/dataset/Dataset_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "datasets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The dataset request completed successfully. The response body contains the previously created dataset.", + "schema": { + "$ref": "#/definitions/DatasetListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/datasets/{datasetId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", + "operationId": "Dataset_Get", + "x-ms-examples": { + "Get details for a previously created dataset": { + "$ref": "./examples/dataset/Dataset_GetDetails.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "The get dataset request completed successfully.", + "schema": { + "$ref": "#/definitions/Dataset" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", + "operationId": "Dataset_Delete", + "x-ms-examples": { + "Delete previously created dataset": { + "$ref": "./examples/dataset/Dataset_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetId" + } + ], + "responses": { + "204": { + "description": "The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/datasets/operations/{operationId}": { + "get": { + "description": "This API allows the caller to view the current progress of a dataset operation and the path is obtained from a call to the Create API.\n\n### Submit Operations Request\n\nTo view the current progress of a dataset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned.", + "operationId": "Dataset_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/dataset/Dataset_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/dataset/Dataset_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "DatasetListResult": { + "description": "The response model for the Dataset List API. The response body will contain a list of all the previously created datasets.", + "type": "object", + "properties": { + "datasets": { + "description": "A list of all the previously created datasets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Dataset" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "Dataset": { + "description": "Detail information for the dataset.", + "type": "object", + "properties": { + "created": { + "description": "The created timestamp for the dataset.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "datasetId": { + "description": "The id for the dataset.", + "type": "string", + "readOnly": true + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "description": { + "description": "The description for the dataset.", + "type": "string", + "readOnly": true + }, + "datasetSources": { + "$ref": "#/definitions/DatasetSources" + }, + "featureCounts": { + "description": "The feature counts for the dataset.", + "type": "object", + "readOnly": true + } + } + }, + "DatasetSources": { + "description": "Information about the details of the create request for the dataset.", + "type": "object", + "properties": { + "conversionIds": { + "description": "The list of `conversionId` that were used to create the dataset.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "appendDatasetId": { + "description": "The dataset that was appended to to create the current dataset.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json new file mode 100644 index 000000000000..ca5b9048a125 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json @@ -0,0 +1,351 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Conversion Service", + "version": "2.0", + "description": "APIs for converting DWG Packages in Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "UdidQuery": { + "name": "udid", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "ConversionId": { + "name": "conversionId", + "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "OutputOntology": { + "name": "outputOntology", + "description": "Output ontology version. \"facility-2.0\" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", + "type": "string", + "in": "query", + "required": true, + "enum": [ + "facility-2.0" + ], + "x-ms-enum": { + "name": "OutputOntology", + "modelAsString": true, + "values": [ + { + "value": "facility-2.0", + "description": "Facility ontology defines how Azure Maps Creator internally stores facility data in a Creator dataset." + } + ] + }, + "x-ms-client-default": "facility-2.0", + "x-ms-parameter-location": "method" + }, + "DescriptionDwgConversion": { + "name": "description", + "description": "User provided description of the content being converted.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "ConversionOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the Conversion create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/conversions": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", + "operationId": "Conversion_Convert", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Convert previously uploaded DWG Package": { + "$ref": "./examples/conversion/Conversion_Conversion.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/UdidQuery" + }, + { + "$ref": "#/parameters/OutputOntology" + }, + { + "$ref": "#/parameters/DescriptionDwgConversion" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", + "operationId": "Conversion_List", + "x-ms-examples": { + "Returns a list of all the data processed by the Conversion Service for the account": { + "$ref": "./examples/conversion/Conversion_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "conversions", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List request completed successfully.", + "schema": { + "$ref": "#/definitions/ConversionListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/conversions/{conversionId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). ", + "operationId": "Conversion_Get", + "x-ms-examples": { + "Get the details for one conversion operation": { + "$ref": "./examples/conversion/Conversion_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ConversionId" + } + ], + "responses": { + "200": { + "description": "Returns details of the specified conversion.", + "schema": { + "$ref": "#/definitions/Conversion" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", + "operationId": "Conversion_Delete", + "x-ms-examples": { + "Delete previously converted content": { + "$ref": "./examples/conversion/Conversion_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ConversionId" + } + ], + "responses": { + "204": { + "description": "Conversion delete request completed successfully. The content for `conversionId` was deleted on the server." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/conversions/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to POST /conversions. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "operationId": "Conversion_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/conversion/Conversion_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully, with non-fatal warnings": { + "$ref": "./examples/conversion/Conversion_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ConversionOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "ConversionListResult": { + "description": "The response model for the Conversion List API.", + "type": "object", + "properties": { + "conversions": { + "description": "A list of all the previously submitted conversion requests.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Conversion" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "Conversion": { + "description": "Detail information for the conversion requests.", + "type": "object", + "properties": { + "conversionId": { + "description": "A unique id that represents the artifact of a _successfully_ completed conversion process.", + "type": "string", + "readOnly": true + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "udid": { + "description": "The unique id of the content provided to create this conversion.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The date and time of this conversion.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "User provided description of the content being converted.", + "type": "string", + "readOnly": true + }, + "featureCounts": { + "description": "A summary of feature counts in this conversion.", + "additionalProperties": { + "type": "integer", + "format": "int64" + }, + "type": "object", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json new file mode 100644 index 000000000000..08e05a94045e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "aliasId": "[aliasId]", + "creatorDataItemId": "[creatorDataItemId]" + }, + "responses": { + "200": { + "body": { + "createdTimestamp": "2021-05-01T01:02:03.456Z", + "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012", + "creatorDataItemId": "633a009a-dfa2-4d51-a419-420122e11c94", + "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json new file mode 100644 index 000000000000..c1fff0412624 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdTimestamp": "2021-05-01T01:02:03.456Z", + "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012", + "creatorDataItemId": null, + "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json new file mode 100644 index 000000000000..1fc205ce43c3 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "aliasId": "[aliasId]" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json new file mode 100644 index 000000000000..55034a1c734f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "aliasId": "[aliasId]" + }, + "responses": { + "200": { + "body": { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", + "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", + "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json new file mode 100644 index 000000000000..12612ec5ff9c --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "aliases": [ + { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", + "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", + "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" + }, + { + "createdTimestamp": "2020-02-13T21:19:11+00:00", + "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6", + "creatorDataItemId": null, + "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json new file mode 100644 index 000000000000..149a34a8eda2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012", + "outputOntology": "facility-2.0" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json new file mode 100644 index 000000000000..5cf093ae5d8a --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "conversionId": "99884fb7-87a9-0920-7f93-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json new file mode 100644 index 000000000000..f081d3945f4e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d" + }, + "responses": { + "200": { + "body": { + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", + "udid": "31838736-8b84-11ea-bc55-0242ac130003", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json new file mode 100644 index 000000000000..0b718ab1da2e --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded", + "warning": { + "code": "dwgConversionProblem", + "details": [ + { + "code": "warning", + "details": [ + { + "code": "manifestWarning", + "message": "Ignoring unexpected JSON property: unitProperties[0].nonWheelchairAccessible with value False" + } + ] + } + ] + } + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/conversions/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json new file mode 100644 index 000000000000..158b416cefb8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "conversions": [ + { + "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", + "udid": "31838736-8b84-11ea-bc55-0242ac130003", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + }, + { + "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003", + "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039", + "created": "5/19/2020 9:00:00 AM +00:00", + "description": "User provided description.", + "featureCounts": { + "directoryInfo": 1, + "level": 3, + "facility": 1, + "unit": 150, + "category": 8, + "areaElement": 0, + "opening": 10 + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json new file mode 100644 index 000000000000..2e897dae615d --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json new file mode 100644 index 000000000000..8c6658d7bbe2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json new file mode 100644 index 000000000000..d200cddb0cf6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json new file mode 100644 index 000000000000..132cab23e1b5 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "mapDataList": [ + { + "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2", + "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0", + "sizeInBytes": 29920, + "uploadStatus": "Completed" + }, + { + "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0", + "sizeInBytes": 1339, + "uploadStatus": "Completed" + }, + { + "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", + "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0", + "sizeInBytes": 1650, + "uploadStatus": "Pending" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json new file mode 100644 index 000000000000..a6057f3ec929 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "udid": "25084fb7-307a-4720-8f91-7952a0b91012", + "UpdateContent": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + }, + "409": { + "headers": {}, + "body": { + "error": { + "code": "409 Conflict", + "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads." + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json new file mode 100644 index 000000000000..f1736046f20f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "dataFormat": "geojson", + "UploadContent": { + "type": "FeatureCollection", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Point", + "coordinates": [ + -122.126986, + 47.639754 + ] + }, + "properties": { + "geometryId": "001", + "radius": 500 + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + }, + "409": { + "headers": {}, + "body": { + "error": { + "code": "409 Conflict", + "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads." + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json new file mode 100644 index 000000000000..df5d8e659524 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "conversionId": "[conversionId]" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json new file mode 100644 index 000000000000..b2193a7993db --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "[datasetId]" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json new file mode 100644 index 000000000000..33836ce57754 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "[datasetId]" + }, + "responses": { + "200": { + "headers": { + "Location": "https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0", + "Access-Control-Expose-Headers": "Resource-Location" + }, + "body": { + "created": "2021-05-21T01:02:03.456Z", + "datasetId": "[datasetId]", + "description": "Some description or comment about the dataset", + "datasetSources": { + "conversionIds": [ + "15d21452-c9bb-27b6-5e79-743ca5c3205d", + "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d" + ], + "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733" + }, + "featureCounts": { + "directoryInfo": 2, + "category": 10, + "facility": 1, + "level": 3, + "unit": 183, + "zone": 3, + "verticalPenetration": 6, + "opening": 48, + "areaElement": 108 + }, + "ontology": "facility-2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json new file mode 100644 index 000000000000..8ea9c0cb5da0 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json new file mode 100644 index 000000000000..13e4eda45125 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "datasets": [ + { + "created": "2021-05-21T03:04:05.678Z", + "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2", + "description": "Some description or comment for the dataset.", + "datasetSources": { + "conversionIds": [ + "db63843c-3c70-4b4e-94ff-dfcf4013c4a9" + ] + }, + "featureCounts": { + "directoryInfo": 1, + "category": 18, + "facility": 1, + "level": 6, + "unit": 775, + "opening": 471, + "areaElement": 496 + }, + "ontology": "facility-2.0" + }, + { + "created": "2021-05-21T03:04:05.678Z", + "datasetId": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", + "description": "Some other description or comment for the dataset.", + "datasetSources": { + "conversionIds": [ + "15d21452-c9bb-27b6-5e79-743ca5c3205d" + ], + "appendDatasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "featureCounts": { + "directoryInfo": 2, + "category": 10, + "facility": 1, + "level": 3, + "unit": 183, + "zone": 3, + "verticalPenetration": 6, + "opening": 48, + "areaElement": 108 + }, + "ontology": "facility-2.0" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json new file mode 100644 index 000000000000..80d3be39e2f1 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "description": "Stateset for Azure Maps POC.", + "datasetId": "5d34fbe8-87b7-f7c0-3144-c50e003a3c75", + "styleRules": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FF0000", + "false": "#00FF00" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "exclusiveMaximum": "50" + }, + "color": "#343deb" + }, + { + "range": { + "minimum": "50", + "exclusiveMaximum": "70" + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": "70", + "exclusiveMaximum": "90" + }, + "color": "#eba834" + }, + { + "range": { + "minimum": "90" + }, + "color": "#eb3434" + } + ] + }, + { + "keyName": "s3", + "type": "string", + "rules": [ + { + "stateValue1": "#FF0000", + "stateValue2": "#FF00AA", + "stateValueN": "#00FF00" + } + ] + } + ] + } + }, + "responses": { + "200": { + "body": { + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json new file mode 100644 index 000000000000..1b5f29227d13 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709", + "stateKeyName": "keyName1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json new file mode 100644 index 000000000000..ae9a27be981f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json new file mode 100644 index 000000000000..ff6d43f4b6a0 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64" + }, + "responses": { + "200": { + "body": { + "description": "Stateset for Azure Maps POC.", + "datasetIds": [ + "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" + ], + "statesetStyle": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FFFF00", + "false": "#FFFFFF" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "minimum": null, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": "50" + }, + "color": "#343deb" + }, + { + "range": { + "minimum": "50", + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": "69" + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": "69", + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": "90" + }, + "color": "#eba834" + }, + { + "range": { + "minimum": "90", + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": null + }, + "color": "#eb3434" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json new file mode 100644 index 000000000000..b810b73a8c1f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "statesets": [ + { + "statesetId": "09abcdf8-cad0-b3dd-a38f-d5ee3cff5eea", + "description": "Stateset for Main campus.", + "datasetIds": [ + "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" + ], + "statesetStyle": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#0FFF00", + "false": "#00FFF0" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "minimum": null, + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": "50" + }, + "color": "#343deb" + }, + { + "range": { + "minimum": "50", + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": "69" + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": "69", + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": "90" + }, + "color": "#eba834" + }, + { + "range": { + "minimum": "90", + "maximum": null, + "exclusiveMinimum": null, + "exclusiveMaximum": null + }, + "color": "#eb3434" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json new file mode 100644 index 000000000000..24af0a5fc1cc --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709" + }, + "responses": { + "200": { + "body": { + "states": [ + { + "keyName": "s1", + "value": "true", + "eventTimestamp": "2019-08-16 13:01" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json new file mode 100644 index 000000000000..ee6316364a98 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "featureId": "SPC4709", + "featureStates": { + "states": [ + { + "keyName": "s1", + "value": "true", + "eventTimestamp": "2019-08-16 13:01" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json new file mode 100644 index 000000000000..7bc6f55f1718 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", + "styleRules": { + "styles": [ + { + "keyName": "s1", + "type": "boolean", + "rules": [ + { + "true": "#FFFF00", + "false": "#FFFFFF" + } + ] + }, + { + "keyName": "s2", + "type": "number", + "rules": [ + { + "range": { + "exclusiveMaximum": "50" + }, + "color": "#343deb" + }, + { + "range": { + "minimum": "50", + "exclusiveMaximum": "69" + }, + "color": "#34ebb1" + }, + { + "range": { + "minimum": "69", + "exclusiveMaximum": "90" + }, + "color": "#eba834" + }, + { + "range": { + "minimum": "90" + }, + "color": "#eb3434" + } + ] + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json new file mode 100644 index 000000000000..0ca2acebc8d8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "[dataset-Id]" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2.0", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json new file mode 100644 index 000000000000..71049ceba9d2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "tilesetId": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json new file mode 100644 index 000000000000..f4078cebc0b9 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84" + }, + "responses": { + "200": { + "body": { + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b", + "description": "My first tileset", + "minZoom": 16, + "maxZoom": 18, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json new file mode 100644 index 000000000000..671289b480bb --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/tilesets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json new file mode 100644 index 000000000000..52d48d34f311 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json new file mode 100644 index 000000000000..93cf5ac3c2d2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0" + }, + "responses": { + "200": { + "body": { + "tilesets": [ + { + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "datasetId": "63b18a6b-ac35-4b23-a1d9-ffa1003ad50b", + "description": "My first tileset", + "minZoom": 16, + "maxZoom": 18, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + }, + { + "tilesetId": "b8dca8b3-8aad-4afe-abd6-0efe37b5a2e3", + "datasetId": "c0a01139-662e-4d5a-bf5f-92ea4a292aad", + "description": "My second tileset", + "minZoom": 19, + "maxZoom": 19, + "bbox": [ + -122.13595, + 47.636524, + -122.1329, + 47.637525 + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json new file mode 100644 index 000000000000..e27d3eff14bf --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "facility", + "featureId": "FCL39" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json new file mode 100644 index 000000000000..9f263859487b --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit" + }, + "responses": { + "200": { + "body": { + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "ontology": "Facility-2.0", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "rel": "data", + "title": "unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for unit" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json new file mode 100644 index 000000000000..e2e020b432c8 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json @@ -0,0 +1,152 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit" + }, + "responses": { + "200": { + "body": { + "idPrefix": "UNIT", + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "ontology": "Facility-2.0", + "geometryType": "Polygon", + "featureTypes": [], + "properties": [ + { + "name": "externalId", + "required": false, + "type": "text" + }, + { + "name": "originalId", + "required": false, + "type": "text" + }, + { + "name": "categoryId", + "required": true, + "type": { + "featureId": "category" + } + }, + { + "name": "isOpenArea", + "required": false, + "type": "boolean" + }, + { + "name": "navigableBy", + "required": false, + "type": { + "array": { + "enum": [ + "pedestrian", + "wheelchair", + "machine", + "bicycle", + "automobile", + "hiredAuto", + "bus", + "railcar", + "emergency", + "ferry", + "boat" + ] + } + } + }, + { + "name": "isRoutable", + "required": false, + "type": "boolean" + }, + { + "name": "routeThroughBehavior", + "required": false, + "type": { + "enum": [ + "disallowed", + "allowed", + "preferred" + ] + } + }, + { + "name": "nonPublic", + "required": false, + "type": "boolean" + }, + { + "name": "levelId", + "required": true, + "type": { + "featureId": "level" + } + }, + { + "name": "occupants", + "required": false, + "type": { + "array": { + "featureId": "directoryInfo" + } + } + }, + { + "name": "addressId", + "required": false, + "type": { + "featureId": "directoryInfo" + } + }, + { + "name": "addressRoomNumber", + "required": false, + "type": "text" + }, + { + "name": "name", + "required": false, + "type": "text" + }, + { + "name": "nameSubtitle", + "required": false, + "type": "text" + }, + { + "name": "nameAlt", + "required": false, + "type": "text" + }, + { + "name": "anchorPoint", + "required": false, + "type": { + "geometry": [ + "Point" + ], + "isFragmented": false, + "srid": 4326 + } + } + ], + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "rel": "data", + "title": "unit" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json new file mode 100644 index 000000000000..ab9196a76fc6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json @@ -0,0 +1,253 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" + }, + "responses": { + "200": { + "body": { + "ontology": "Facility-2.0", + "collections": [ + { + "name": "unit", + "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "rel": "data", + "title": "unit" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for unit" + } + ] + }, + { + "name": "zone", + "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for zone" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0", + "rel": "data", + "title": "zone" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for zone" + } + ] + }, + { + "name": "level", + "description": "An indication of the extent and vertical position of a set of features.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for level" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0", + "rel": "data", + "title": "level" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for level" + } + ] + }, + { + "name": "facility", + "description": "Area of the site, building footprint etc.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for facility" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0", + "rel": "data", + "title": "facility" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for facility" + } + ] + }, + { + "name": "verticalPenetration", + "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for verticalPenetration" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0", + "rel": "data", + "title": "verticalPenetration" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for verticalPenetration" + } + ] + }, + { + "name": "opening", + "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for opening" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0", + "rel": "data", + "title": "opening" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for opening" + } + ] + }, + { + "name": "directoryInfo", + "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for directoryInfo" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0", + "rel": "data", + "title": "directoryInfo" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for directoryInfo" + } + ] + }, + { + "name": "pointElement", + "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for pointElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0", + "rel": "data", + "title": "pointElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for pointElement" + } + ] + }, + { + "name": "lineElement", + "description": "A line feature in a unit, such as a dividing wall, window.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for lineElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0", + "rel": "data", + "title": "lineElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for lineElement" + } + ] + }, + { + "name": "areaElement", + "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for areaElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0", + "rel": "data", + "title": "areaElement" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for areaElement" + } + ] + }, + { + "name": "category", + "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0", + "rel": "describedBy", + "title": "Metadata catalogue for category" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0", + "rel": "data", + "title": "category" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0", + "rel": "self", + "title": "Metadata catalogue for category" + } + ] + } + ], + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0", + "rel": "self" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json new file mode 100644 index 000000000000..2d90e3409188 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit", + "featureId": "UNIT39" + }, + "responses": { + "200": { + "body": { + "ontology": "Facility-2.0", + "feature": { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 139.63304057829211, + 35.457686686108559 + ], + [ + 139.63296283234274, + 35.457783904258683 + ], + [ + 139.63308672404617, + 35.457850229062018 + ], + [ + 139.63314516916711, + 35.457777145699858 + ], + [ + 139.63312747036289, + 35.457767670747167 + ], + [ + 139.63314677109963, + 35.457743535881377 + ], + [ + 139.63304057829211, + 35.457686686108559 + ] + ] + ] + }, + "properties": { + "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", + "categoryId": "CTG10", + "isOpenArea": false, + "navigableBy": [ + "pedestrian" + ], + "isRoutable": false, + "routeThroughBehavior": "allowed", + "nonPublic": false, + "levelId": "LVL18", + "occupants": [], + "addressId": "DIR16", + "addressRoomNumber": "", + "name": "21N13", + "nameSubtitle": "", + "nameAlt": "" + }, + "id": "UNIT39", + "featureType": "" + }, + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2.0", + "rel": "self" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "data" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json new file mode 100644 index 000000000000..baadf9b72821 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "018fda98-e638-0edf-5ef7-28491ff3bed4", + "collectionId": "unit", + "limit": 1, + "bbox": "-122, 47, -120, 46" + }, + "responses": { + "200": { + "body": { + "type": "FeatureCollection", + "ontology": "Facility-2.0", + "features": [ + { + "type": "Feature", + "geometry": { + "type": "Polygon", + "coordinates": [ + [ + [ + 139.63304057829211, + 35.457686686108559 + ], + [ + 139.63296283234274, + 35.457783904258683 + ], + [ + 139.63308672404617, + 35.457850229062018 + ], + [ + 139.63314516916711, + 35.457777145699858 + ], + [ + 139.63312747036289, + 35.457767670747167 + ], + [ + 139.63314677109963, + 35.457743535881377 + ], + [ + 139.63304057829211, + 35.457686686108559 + ] + ] + ] + }, + "properties": { + "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", + "categoryId": "CTG10", + "isOpenArea": false, + "navigableBy": [ + "pedestrian" + ], + "isRoutable": false, + "routeThroughBehavior": "allowed", + "nonPublic": false, + "levelId": "LVL18", + "occupants": [], + "addressId": "DIR16", + "addressRoomNumber": "", + "name": "21N13", + "nameSubtitle": "", + "nameAlt": "" + }, + "id": "UNIT39", + "featureType": "" + } + ], + "numberReturned": 1, + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1", + "rel": "self" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "rel": "data" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1", + "rel": "next" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json new file mode 100644 index 000000000000..488dc128f5fc --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" + }, + "responses": { + "200": { + "body": { + "ontology": "Facility-2.0", + "links": [ + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4", + "rel": "self", + "title": "Azure Maps WFS" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api", + "rel": "service", + "title": "The API definition" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance", + "rel": "conformance", + "title": "WFS 3.0 conformance classes implemented by this server" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/version", + "rel": "data", + "title": "The version information" + }, + { + "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections", + "rel": "data", + "title": "Metadata about the feature collections" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json new file mode 100644 index 000000000000..00fc7956f640 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2.0", + "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" + }, + "responses": { + "200": { + "body": { + "conformsTo": [ + "http://www.opengis.net/spec/wfs-1/3.0/req/core", + "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", + "http://www.opengis.net/spec/wfs-1/3.0/req/geojson", + "http://tempuri.org/wfs/3.0/edit" + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json new file mode 100644 index 000000000000..96bbaf6ee5b6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json @@ -0,0 +1,694 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Feature State Service", + "version": "2.0", + "description": "APIs for managing the dynamic feature states in Azure Maps." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "FeatureStateSetDescription": { + "name": "description", + "description": "Description for the stateset. Max length allowed is 1000.", + "type": "string", + "in": "query", + "required": false, + "x-ms-parameter-location": "method" + }, + "DatasetIdForCreate": { + "name": "datasetId", + "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "StatesetIdInPath": { + "name": "statesetId", + "description": "The stateset id that was created.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdSet": { + "name": "featureId", + "description": "The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdGet": { + "name": "featureId", + "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "FeatureIdDelete": { + "name": "featureId", + "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "StateKeyName": { + "name": "stateKeyName", + "x-ms-client-name": "keyName", + "description": "The Name of the state to be deleted.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/featureStateSets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/en-us/rest/api/maps/render/get-map-state-tile-preview) for more information.", + "operationId": "FeatureState_CreateStateset", + "x-ms-examples": { + "Create a new stateset with a datasetId": { + "$ref": "./examples/featurestate/Featurestate_CreateStateset.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetIdForCreate" + }, + { + "$ref": "#/parameters/FeatureStateSetDescription" + }, + { + "name": "styleRules", + "in": "body", + "description": "The stateset style JSON data.", + "required": true, + "schema": { + "$ref": "#/definitions/StyleRules" + } + } + ], + "responses": { + "200": { + "description": "Stateset created.", + "schema": { + "$ref": "#/definitions/StatesetCreatedResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", + "operationId": "FeatureState_ListStatesets", + "x-ms-examples": { + "List all the previously created statesets": { + "$ref": "./examples/featurestate/Featurestate_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "statesets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The list stateset request completed successfully. The response body contains a list of all the previously created statesets.", + "schema": { + "$ref": "#/definitions/StatesetListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/featureStateSets/{statesetId}": { + "put": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the stateset style rules.", + "operationId": "FeatureState_UpdateStateset", + "x-ms-examples": { + "Update stateset style rules with a statesetId": { + "$ref": "./examples/featurestate/Featurestate_UpdateStateset.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "name": "styleRules", + "in": "body", + "description": "The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed.", + "required": true, + "schema": { + "$ref": "#/definitions/StyleRules" + } + } + ], + "responses": { + "200": { + "description": "Stateset styles are updated successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This DELETE API allows the user to delete the stateset and the associated data.", + "operationId": "FeatureState_DeleteStateset", + "x-ms-examples": { + "Delete an existing stateset": { + "$ref": "./examples/featurestate/Featurestate_DeleteStateset.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + } + ], + "responses": { + "204": { + "description": "Stateset Deleted." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", + "operationId": "FeatureState_GetStateset", + "x-ms-examples": { + "Get stateset information with a statesetId": { + "$ref": "./examples/featurestate/Featurestate_GetStateset.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + } + ], + "responses": { + "200": { + "description": "Get request completed successfully.", + "schema": { + "$ref": "#/definitions/Stateset" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/featureStateSets/{statesetId}/featureStates/{featureId}": { + "put": { + "operationId": "FeatureState_UpdateStates", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", + "x-ms-examples": { + "Update the states of a feature": { + "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "$ref": "#/parameters/FeatureIdSet" + }, + { + "name": "featureStates", + "in": "body", + "description": "The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation.", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureStatesStructure" + } + } + ], + "responses": { + "200": { + "description": "Feature states are updated successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "operationId": "FeatureState_DeleteState", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", + "x-ms-examples": { + "Delete the given feature state": { + "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "$ref": "#/parameters/FeatureIdDelete" + }, + { + "$ref": "#/parameters/StateKeyName" + } + ], + "responses": { + "204": { + "description": "Feature states deleted successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "operationId": "FeatureState_ListStates", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API returns the current state information associated with the given feature in the given stateset.", + "x-ms-examples": { + "Get the current states of a feature": { + "$ref": "./examples/featurestate/Featurestate_ListStates.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StatesetIdInPath" + }, + { + "$ref": "#/parameters/FeatureIdGet" + } + ], + "responses": { + "200": { + "description": "Get request completed successfully.", + "schema": { + "$ref": "#/definitions/FeatureStatesStructure" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "Stateset": { + "description": "The response model for the successful Stateset Get API.", + "type": "object", + "properties": { + "description": { + "description": "Description associated with the stateset.", + "type": "string", + "readOnly": true + }, + "datasetIds": { + "description": "Dataset ID associated with the stateset.", + "type": "array", + "items": { + "type": "string" + } + }, + "statesetStyle": { + "x-ms-client-name": "styleRules", + "$ref": "#/definitions/StyleRules" + } + } + }, + "StatesetListResult": { + "description": "The response model for the successful Stateset List API.", + "type": "object", + "properties": { + "statesets": { + "description": "A list of statesets information.", + "type": "array", + "items": { + "$ref": "#/definitions/StatesetInfo" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "StatesetInfo": { + "description": "The stateset information detail.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Stateset" + } + ], + "properties": { + "statesetId": { + "description": "The stateset ID of this stateset.", + "type": "string", + "readOnly": true + } + } + }, + "StatesetCreatedResult": { + "description": "The response model for the successful Stateset Create API.", + "type": "object", + "properties": { + "statesetId": { + "description": "The ID for the new stateset created.", + "type": "string", + "readOnly": true + } + } + }, + "FeatureStatesStructure": { + "description": "The feature states model for a feature.", + "type": "object", + "properties": { + "states": { + "description": "The feature states array.", + "type": "array", + "items": { + "$ref": "#/definitions/FeatureState" + } + } + } + }, + "FeatureState": { + "description": "Single feature state model.", + "type": "object", + "properties": { + "keyName": { + "description": "Feature state Keyname. Maximum length allowed is 1000.", + "type": "string" + }, + "value": { + "description": "Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024.", + "type": "string" + }, + "eventTimestamp": { + "description": "Valid Timestamp when the feature state was captured.", + "type": "string" + } + } + }, + "StyleRules": { + "description": "The styles model.", + "type": "object", + "properties": { + "styles": { + "x-ms-client-name": "styleRules", + "description": "An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ", + "type": "array", + "items": { + "$ref": "#/definitions/StyleRule" + } + } + } + }, + "NumberRule": { + "description": "The numeric rule. The color is selected from the first range it falls into.", + "type": "object", + "properties": { + "range": { + "$ref": "#/definitions/Range" + }, + "color": { + "description": "The color when value is within the range. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + } + }, + "Range": { + "description": "The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.", + "type": "object", + "properties": { + "minimum": { + "description": "All the number x that x ≥ minimum.", + "type": "string" + }, + "maximum": { + "description": "All the number x that x ≤ maximum.", + "type": "string" + }, + "exclusiveMinimum": { + "description": "All the number x that x > exclusiveMinimum.", + "type": "string" + }, + "exclusiveMaximum": { + "description": "All the number x that x < exclusiveMaximum.", + "type": "string" + } + } + }, + "BooleanRule": { + "description": "The boolean rule. The color is selected based on the logic value of the key.", + "type": "object", + "properties": { + "true": { + "description": "The color when value is true. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + }, + "false": { + "description": "The color when value is false. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + } + }, + "StringRuleObject": { + "description": "The string rule. The string value matching is case sensitive. If a feature's state doesn't match any of the values defined here, that feature will not have any dynamic style. If duplicate string values are given, the first one takes precedence.", + "type": "object", + "additionalProperties": { + "description": "The color when the keyName value string is equal to this property name. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", + "type": "string" + } + }, + "StyleRule": { + "description": "The stateset style model. The style rule could be a numeric type style rule or a boolean type style rule. Refer to NumberRule, StringRuleObject and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ", + "discriminator": "type", + "type": "object", + "required": [ + "keyName", + "type" + ], + "properties": { + "keyName": { + "description": "Stateset style key name. Key names are random strings but they should be unique inside style array.", + "type": "string" + }, + "type": { + "description": "The type of stateset style.", + "type": "string", + "enum": [ + "boolean", + "number", + "string" + ], + "x-ms-enum": { + "name": "StyleRuleType", + "modelAsString": true, + "values": [ + { + "value": "boolean", + "description": "Boolean type of stateset style." + }, + { + "value": "number", + "description": "Number type of stateset style." + }, + { + "value": "string", + "description": "String type of stateset style." + } + ] + } + } + } + }, + "BooleanStyleRule": { + "description": "The boolean type style rule object.", + "x-ms-discriminator-value": "boolean", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleRule" + } + ], + "properties": { + "rules": { + "description": "Boolean style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/BooleanRule" + } + } + }, + "required": [ + "rules" + ] + }, + "NumberStyleRule": { + "description": "The numeric type style rule object.", + "x-ms-discriminator-value": "number", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleRule" + } + ], + "properties": { + "rules": { + "description": "Numeric style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/NumberRule" + } + } + }, + "required": [ + "rules" + ] + }, + "StringStyleRule": { + "description": "The string type style rule object.", + "x-ms-discriminator-value": "string", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/StyleRule" + } + ], + "properties": { + "rules": { + "description": "String style rules.", + "type": "array", + "items": { + "$ref": "#/definitions/StringRuleObject" + } + } + }, + "required": [ + "rules" + ] + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json new file mode 100644 index 000000000000..fa2e258968a6 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -0,0 +1,326 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Tileset Service", + "version": "2.0", + "description": "APIs for managing Tilesets." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "DatasetIdQuery": { + "name": "datasetId", + "description": "The unique `datasetId` that the tileset create API uses to retrieve features to generate tiles. The `datasetId` must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "TilesetId": { + "name": "tilesetId", + "description": "The Tileset Id", + "type": "string", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "DescriptionTileset": { + "name": "description", + "description": "User provided description of the tileset.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "TilesetOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the tileset create/import request.", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/tilesets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Tileset Create API allows the caller to create a tileset from a dataset. A tileset contains a set of tiles that can be consumed \nfrom the [Get Map Tile](/rest/api/maps/render/getmaptile) to retrieve custom tiles. To make a dataset, use the \n[DataSet Create API](/rest/api/maps/dataset/createpreview).\n\n## Submit Create Request\n\nTo create your tileset you will make a `POST` request with an empty body. The `datasetId` query parameter will be \nused as the source of the tileset data.\n\nThe Create Tileset API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "Tileset_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Create Tileset by providing a Dataset Id": { + "$ref": "./examples/tileset/Tileset_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetIdQuery" + }, + { + "$ref": "#/parameters/DescriptionTileset" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all tilesets created. \n
", + "operationId": "Tileset_List", + "x-ms-examples": { + "Get a list of all tilesets": { + "$ref": "./examples/tileset/Tileset_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "tilesets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", + "schema": { + "$ref": "#/definitions/TilesetListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/tilesets/{tilesetId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a tileset.", + "operationId": "Tileset_Get", + "x-ms-examples": { + "Gets the details for a single tileset": { + "$ref": "./examples/tileset/Tileset_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "responses": { + "200": { + "description": "List tileset request completed successfully. The response body contains a list of all tilesets.", + "schema": { + "$ref": "#/definitions/Tileset" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a created tileset.
\nYou can use this API if a tileset is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `tilesetId` of the tileset to delete.
\n\n#### Delete request \"Successful\"\n\nThe Tileset Delete API returns a HTTP `204 No Content` response with an empty body, if the tileset was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the tileset with the passed-in `tilesetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Tileset Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "operationId": "Tileset_Delete", + "x-ms-examples": { + "Delete a created tileset": { + "$ref": "./examples/tileset/Tileset_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "responses": { + "204": { + "description": "Tileset delete request completed successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/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.", + "operationId": "Tileset_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/tileset/Tileset_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/tileset/Tileset_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/TilesetOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "TilesetListResult": { + "description": "The response model for the Tileset List API. Returns a list of all tilesets.", + "type": "object", + "properties": { + "tilesets": { + "description": "A list of all tilesets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Tileset" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "Tileset": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "tilesetId": { + "description": "The unique tileset id for the tileset.", + "type": "string", + "readOnly": true + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "datasetId": { + "description": "The unique dataset Id used to create the tileset.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the tileset. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + }, + "minZoom": { + "description": "The lowest tile zoom level tile generated for the tileset.", + "type": "integer", + "readOnly": true + }, + "maxZoom": { + "description": "The highest tile zoom level tile generated for the tileset.", + "type": "integer", + "readOnly": true + }, + "bbox": { + "description": "Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.", + "$ref": "../../../Common/preview/1.0/common.json#/definitions/BoundingBox" + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json new file mode 100644 index 000000000000..b944c8c21255 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json @@ -0,0 +1,772 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Web Feature Service", + "version": "2.0", + "description": "Azure Maps Web Feature REST APIs" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2.0", + "x-ms-parameter-location": "client" + }, + "LimitWfs": { + "name": "limit", + "in": "query", + "type": "integer", + "minimum": 1, + "maximum": 500, + "description": "The optional limit parameter limits the number of features that are presented in the response document.\nOnly features that are on the first level of the collection in the response document are counted. Nested objects contained within the explicitly requested features shall not be counted.\n* Minimum = 1 * Maximum = 500 * Default = 10", + "x-ms-parameter-location": "method" + }, + "Filter": { + "name": "filter", + "in": "query", + "type": "string", + "description": "Filter expression to search for features with specific property values in a given collection. Only feature properties of scalar type and equals operator are supported.\nThis is a special parameter where the parameter name is a case sensitive property name. The scheme for this parameter is {property name}={property value}. Unless \"filter\" is one of the property names in the collection, \"filter\" should not be used as a parameter name. To search for features with \"name\" property value \"21N13\", use \"name=21N13\".\nMultiple filters are supported and should be represented as multiple query parameters. E.g., =&= String values are case sensitive.", + "x-ms-parameter-location": "method" + }, + "Bbox": { + "name": "bbox", + "x-ms-client-name": "boundingBox", + "in": "query", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "number", + "format": "double" + }, + "description": "Only features that have a geometry that intersects the supplied bounding box are selected.\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).", + "x-ms-parameter-location": "method" + }, + "CollectionId": { + "name": "collectionId", + "in": "path", + "type": "string", + "required": true, + "description": "Identifier (name) of a specific collection", + "x-ms-parameter-location": "method" + }, + "FeatureId": { + "name": "featureId", + "in": "path", + "type": "string", + "description": "Local identifier of a specific feature", + "required": true, + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/wfs/datasets/{datasetId}/": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", + "operationId": "WFS_GetLandingPage", + "x-ms-examples": { + "GetLandingPage": { + "$ref": "./examples/wfs/WFS_GetLandingPage.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/LandingPageResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/conformance": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", + "operationId": "WFS_ListConformance", + "x-ms-examples": { + "GetConformance": { + "$ref": "./examples/wfs/WFS_ListConformance.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ConformanceResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", + "operationId": "WFS_GetCollections", + "x-ms-examples": { + "GetCollections": { + "$ref": "./examples/wfs/WFS_GetCollections.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionsResponse" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", + "operationId": "WFS_GetCollection", + "x-ms-examples": { + "GetCollection": { + "$ref": "./examples/wfs/WFS_GetCollection.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/Collection" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}/definition": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", + "operationId": "WFS_GetCollectionDefinition", + "x-ms-examples": { + "GetCollectionDefinition": { + "$ref": "./examples/wfs/WFS_GetCollectionDefinition.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/CollectionDefinition" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}/items": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", + "operationId": "WFS_GetFeatures", + "x-ms-examples": { + "GetFeatures": { + "$ref": "./examples/wfs/WFS_GetFeatures.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/LimitWfs" + }, + { + "$ref": "#/parameters/Bbox" + }, + { + "$ref": "#/parameters/Filter" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/ExtendedGeoJsonFeatureCollection" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/wfs/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", + "operationId": "WFS_GetFeature", + "x-ms-examples": { + "GetFeature": { + "$ref": "./examples/wfs/WFS_GetFeature.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/FeatureId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FeatureResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", + "operationId": "WFS_DeleteFeature", + "x-ms-examples": { + "DeleteFeature": { + "$ref": "./examples/wfs/WFS_DeleteFeature.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "dataset.json#/parameters/DatasetId" + }, + { + "$ref": "#/parameters/CollectionId" + }, + { + "$ref": "#/parameters/FeatureId" + } + ], + "responses": { + "204": { + "description": "Feature Deleted." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "LandingPageResult": { + "type": "object", + "required": [ + "links" + ], + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WFSEndpointLink" + } + } + } + }, + "ConformanceResult": { + "type": "object", + "required": [ + "conformsTo" + ], + "properties": { + "conformsTo": { + "description": "List of requirements classes that the server conforms to.", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "http://www.opengis.net/spec/wfs-1/3.0/req/core", + "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", + "http://www.opengis.net/spec/wfs-1/3.0/req/html", + "http://www.opengis.net/spec/wfs-1/3.0/req/geojson" + ] + } + } + }, + "WFSEndpointLink": { + "description": "Links to other WFS endpoints", + "type": "object", + "required": [ + "href" + ], + "properties": { + "href": { + "description": "The link target.", + "type": "string" + }, + "rel": { + "description": "The relation type.", + "type": "string", + "example": "prev" + }, + "type": { + "description": "A hint indicating what the media type of the result of dereferencing the link should be.", + "type": "string", + "example": "application/geo+json" + }, + "hreflang": { + "x-ms-client-name": "hrefLang", + "description": "A hint indicating what the language of the result of dereferencing the link should be.", + "type": "string", + "example": "en" + }, + "title": { + "description": "Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present).", + "type": "string" + } + } + }, + "CollectionsResponse": { + "type": "object", + "required": [ + "links", + "collections" + ], + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WFSEndpointLink" + }, + "example": [ + { + "href": "http://data.example.org/collections.json", + "rel": "self", + "type": "application/json", + "title": "this document" + }, + { + "href": "http://data.example.org/collections.html", + "rel": "alternate", + "type": "text/html", + "title": "this document as HTML" + }, + { + "href": "http://schemas.example.org/1.0/foobar.xsd", + "rel": "describedBy", + "type": "application/xml", + "title": "XML schema for Acme Corporation data" + } + ] + }, + "collections": { + "description": "All the collections in a given dataset.", + "type": "array", + "items": { + "$ref": "#/definitions/Collection" + } + } + } + }, + "Collection": { + "type": "object", + "required": [ + "name", + "links" + ], + "properties": { + "name": { + "description": "identifier of the collection used, for example, in URIs", + "type": "string", + "example": "buildings" + }, + "title": { + "description": "human readable title of the collection", + "type": "string", + "example": "Buildings" + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "description": { + "description": "a description of the features in the collection", + "type": "string", + "example": "Buildings in the city of Bonn." + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WFSEndpointLink" + }, + "example": [ + { + "href": "http://data.example.org/collections/buildings/items", + "rel": "item", + "type": "application/geo+json", + "title": "Buildings" + }, + { + "href": "http://example.org/concepts/building.html", + "rel": "describedBy", + "type": "text/html", + "title": "Feature catalogue for buildings" + } + ] + } + } + }, + "CollectionDefinition": { + "description": "collection of GeoJSON features", + "type": "object", + "required": [ + "idPrefix", + "name", + "geometryType", + "featureTypes" + ], + "properties": { + "description": { + "description": "describes the collection", + "type": "string" + }, + "idPrefix": { + "description": "prefix of the collection used", + "type": "string", + "example": "BLD" + }, + "name": { + "description": "identifier of the collection used, for example, in URIs", + "type": "string", + "example": "buildings" + }, + "title": { + "description": "title of collection", + "type": "string", + "example": "Feature Class buildings" + }, + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "geometryType": { + "description": "type of geometry returned", + "type": "string", + "enum": [ + "Point", + "MultiPoint", + "LineString", + "MultiLineString", + "Polygon", + "MultiPolygon", + "GeometryCollection" + ], + "x-ms-enum": { + "name": "GeoJsonGeometryType", + "modelAsString": true, + "values": [ + { + "value": "Point", + "description": "`GeoJSON Point` geometry.", + "name": "GeoJsonPoint" + }, + { + "value": "MultiPoint", + "description": "`GeoJSON MultiPoint` geometry.", + "name": "GeoJsonMultiPoint" + }, + { + "value": "LineString", + "description": "`GeoJSON LineString` geometry.", + "name": "GeoJsonLineString" + }, + { + "value": "MultiLineString", + "description": "`GeoJSON MultiLineString` geometry.", + "name": "GeoJsonMultiLineString" + }, + { + "value": "Polygon", + "description": "`GeoJSON Polygon` geometry.", + "name": "GeoJsonPolygon" + }, + { + "value": "MultiPolygon", + "description": "`GeoJSON MultiPolygon` geometry.", + "name": "GeoJsonMultiPolygon" + }, + { + "value": "GeometryCollection", + "description": "`GeoJSON GeometryCollection` geometry.", + "name": "GeoJsonGeometryCollection" + } + ] + } + }, + "featureTypes": { + "description": "type of features returned", + "type": "array", + "items": { + "type": "string" + } + }, + "properties": { + "description": "attributes of the collection used", + "type": "array", + "items": { + "$ref": "#/definitions/DefinitionProperty" + } + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WFSEndpointLink" + } + } + } + }, + "DefinitionProperty": { + "type": "object", + "required": [ + "name", + "required", + "type" + ], + "properties": { + "name": { + "description": "name of attribute", + "type": "string", + "example": "external_id" + }, + "required": { + "description": "is attribute required", + "type": "boolean" + }, + "type": { + "description": "type of attribute", + "type": "object" + } + } + }, + "ExtendedGeoJsonFeatureCollection": { + "description": "A valid `GeoJSON FeatureCollection` object type extended with numberReturned and links array. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollectionData" + }, + { + "$ref": "#/definitions/ExtendedGeoJsonFeatureCollectionData" + } + ], + "properties": { + "type": { + "description": "Specifies the `GeoJSON` type: FeatureCollection.", + "type": "string", + "enum": [ + "FeatureCollection" + ], + "x-ms-enum": { + "name": "GeoJsonObjectType", + "modelAsString": false, + "values": [ + { + "value": "FeatureCollection", + "description": "`GeoJSON FeatureCollection` object." + } + ] + } + } + } + }, + "ExtendedGeoJsonFeatureCollectionData": { + "type": "object", + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "numberReturned": { + "description": "Number of returned features.", + "type": "integer" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WFSEndpointLink" + } + } + } + }, + "FeatureResult": { + "type": "object", + "required": [ + "feature" + ], + "properties": { + "ontology": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" + }, + "feature": { + "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeature" + }, + "links": { + "description": "Links to other WFS endpoints.", + "type": "array", + "items": { + "$ref": "#/definitions/WFSEndpointLink" + } + } + } + } + } +} From 6aa59c6e6358e524145665e38a86f43ec0146b9e Mon Sep 17 00:00:00 2001 From: Xubin Date: Wed, 8 Dec 2021 17:13:11 -0800 Subject: [PATCH 02/23] Updates readme --- .../maps/data-plane/Creator/readme.md | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md index 21e84387e125..e5339a18d86b 100644 --- a/specification/maps/data-plane/Creator/readme.md +++ b/specification/maps/data-plane/Creator/readme.md @@ -27,14 +27,27 @@ These are the global settings for Creator Client. ``` yaml title: CreatorClient openapi-type: data-plane -tag: 2.0-preview -# at some point those credentials will move away to Swagger according to [this](https://github.com/Azure/autorest/issues/3718) +tag: package-preview-2022-01 add-credentials: true credential-default-policy-type: BearerTokenCredentialPolicy -credential-scopes: https://atlas.microsoft.com/.default +credential-scopes: 'https://atlas.microsoft.com/.default' ``` +### Tag: package-preview-2022-01 + +These settings apply only when `--tag=package-preview-2022-01` is specified on the command line. + +```yaml $(tag) == 'package-preview-2022-01' +input-file: + - preview/2022-01-01-preview/alias.json + - preview/2022-01-01-preview/data.json + - preview/2022-01-01-preview/dataset.json + - preview/2022-01-01-preview/dwgconversion.json + - preview/2022-01-01-preview/featurestate.json + - preview/2022-01-01-preview/tileset.json + - preview/2022-01-01-preview/wfs.json +``` ### Tag: 2.0-preview These settings apply only when `--tag=2.0-preview` is specified on the command line. @@ -58,7 +71,7 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -```yaml $(swagger-to-sdk) +``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java @@ -75,6 +88,7 @@ swagger-to-sdk: #manually generate for now with track2 - repo: azure-sdk-for-net ``` + ## Python See configuration in [readme.python.md](./readme.python.md) From 8650d2dbafc8c87251cbd6882202f02d7bb2ce38 Mon Sep 17 00:00:00 2001 From: Xubin Date: Wed, 8 Dec 2021 17:13:13 -0800 Subject: [PATCH 03/23] Updates API version in new specs and examples --- .../preview/2022-01-01-preview/alias.json | 8 +-- .../preview/2022-01-01-preview/data.json | 8 +-- .../preview/2022-01-01-preview/dataset.json | 12 ++-- .../2022-01-01-preview/dwgconversion.json | 16 ++--- .../examples/alias/Alias_Assign.json | 2 +- .../examples/alias/Alias_Create.json | 2 +- .../examples/alias/Alias_Delete.json | 2 +- .../examples/alias/Alias_Get.json | 2 +- .../examples/alias/Alias_List.json | 2 +- .../conversion/Conversion_Conversion.json | 8 +-- .../conversion/Conversion_Delete.json | 2 +- .../examples/conversion/Conversion_Get.json | 2 +- .../conversion/Conversion_GetOperation.json | 4 +- .../Conversion_GetOperationStillRunning.json | 2 +- .../examples/conversion/Conversion_List.json | 2 +- .../examples/data/Data_Delete.json | 2 +- .../examples/data/Data_Download.json | 2 +- .../examples/data/Data_GetOperation.json | 4 +- .../data/Data_GetOperationStillRunning.json | 2 +- .../examples/data/Data_List.json | 2 +- .../examples/data/Data_Update.json | 4 +- .../examples/data/Data_Upload.json | 6 +- .../examples/dataset/Dataset_Create.json | 6 +- .../examples/dataset/Dataset_Delete.json | 2 +- .../examples/dataset/Dataset_GetDetails.json | 4 +- .../dataset/Dataset_GetOperation.json | 4 +- .../Dataset_GetOperationStillRunning.json | 2 +- .../examples/dataset/Dataset_List.json | 6 +- .../Featurestate_CreateStateset.json | 2 +- .../Featurestate_DeleteFeatureState.json | 2 +- .../Featurestate_DeleteStateset.json | 2 +- .../Featurestate_GetStateset.json | 2 +- .../featurestate/Featurestate_List.json | 2 +- .../featurestate/Featurestate_ListStates.json | 2 +- .../Featurestate_UpdateStates.json | 2 +- .../Featurestate_UpdateStateset.json | 2 +- .../examples/tileset/Tileset_Create.json | 6 +- .../examples/tileset/Tileset_Delete.json | 2 +- .../examples/tileset/Tileset_Get.json | 2 +- .../tileset/Tileset_GetOperation.json | 4 +- .../Tileset_GetOperationStillRunning.json | 2 +- .../examples/tileset/Tileset_List.json | 2 +- .../examples/wfs/WFS_DeleteFeature.json | 2 +- .../examples/wfs/WFS_GetCollection.json | 10 +-- .../wfs/WFS_GetCollectionDefinition.json | 8 +-- .../examples/wfs/WFS_GetCollections.json | 72 +++++++++---------- .../examples/wfs/WFS_GetFeature.json | 8 +-- .../examples/wfs/WFS_GetFeatures.json | 10 +-- .../examples/wfs/WFS_GetLandingPage.json | 4 +- .../examples/wfs/WFS_ListConformance.json | 2 +- .../2022-01-01-preview/featurestate.json | 8 +-- .../preview/2022-01-01-preview/tileset.json | 8 +-- .../preview/2022-01-01-preview/wfs.json | 8 +-- 53 files changed, 147 insertions(+), 147 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json index 91d2e5d3e70e..43dba70f256e 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Alias Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "APIs for managing aliases in Azure Maps." }, "schemes": [ @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "CreateCreatorDataItemId": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json index 0db86c566229..a6e9fdff02cf 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Data Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "APIs for uploading map data to Azure Maps." }, "x-ms-parameterized-host": { @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "DataFormat": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json index 6a724a677cd8..9af02f4cb7c4 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Dataset Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "APIs for managing datasets from uploaded data in Azure Maps." }, "x-ms-parameterized-host": { @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "ConversionIdQuery": { @@ -150,7 +150,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2022-01-01-preview\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2022-01-01-preview\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", "operationId": "Dataset_List", "x-ms-examples": { "List all the previously created datasets": { @@ -184,7 +184,7 @@ }, "/datasets/{datasetId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2.0\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2022-01-01-preview\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", "operationId": "Dataset_Get", "x-ms-examples": { "Get details for a previously created dataset": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json index ca5b9048a125..90675c7ac198 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Conversion Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "APIs for converting DWG Packages in Azure Maps." }, "x-ms-parameterized-host": { @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "UdidQuery": { @@ -85,24 +85,24 @@ }, "OutputOntology": { "name": "outputOntology", - "description": "Output ontology version. \"facility-2.0\" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", + "description": "Output ontology version. \"facility-2022-01-01-preview\" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", "type": "string", "in": "query", "required": true, "enum": [ - "facility-2.0" + "facility-2022-01-01-preview" ], "x-ms-enum": { "name": "OutputOntology", "modelAsString": true, "values": [ { - "value": "facility-2.0", + "value": "facility-2022-01-01-preview", "description": "Facility ontology defines how Azure Maps Creator internally stores facility data in a Creator dataset." } ] }, - "x-ms-client-default": "facility-2.0", + "x-ms-client-default": "facility-2022-01-01-preview", "x-ms-parameter-location": "method" }, "DescriptionDwgConversion": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json index 08e05a94045e..4a5de37f6ab3 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "aliasId": "[aliasId]", "creatorDataItemId": "[creatorDataItemId]" }, diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json index c1fff0412624..ce991eb9ef45 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "201": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json index 1fc205ce43c3..9421cf14a2ed 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "aliasId": "[aliasId]" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json index 55034a1c734f..6058f7a23d53 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "aliasId": "[aliasId]" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json index 12612ec5ff9c..b47f6d0aab52 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json index 149a34a8eda2..be2ac477847e 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json @@ -1,9 +1,9 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "udid": "25084fb7-307a-4720-8f91-7952a0b91012", - "outputOntology": "facility-2.0" + "outputOntology": "facility-2022-01-01-preview" }, "responses": { "200": { @@ -13,12 +13,12 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2.0", + "Operation-Location": "https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2022-01-01-preview", "Access-Control-Expose-Headers": "Operation-Location" } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json index 5cf093ae5d8a..ba939b309cdc 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "conversionId": "99884fb7-87a9-0920-7f93-7952a0b91012" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json index f081d3945f4e..b8b395859c7d 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json index 0b718ab1da2e..017a2c1c8e8f 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { @@ -26,7 +26,7 @@ } }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/conversions/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/conversions/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json index 52d48d34f311..245506ef8536 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json index 158b416cefb8..628648a80d23 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json index 2e897dae615d..0dc5569ca805 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "udid": "25084fb7-307a-4720-8f91-7952a0b91012" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json index 8c6658d7bbe2..834587cd4130 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "udid": "25084fb7-307a-4720-8f91-7952a0b91012" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json index d200cddb0cf6..f65e31a4b034 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { @@ -12,7 +12,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json index 52d48d34f311..245506ef8536 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json index 132cab23e1b5..626f163f94af 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json index a6057f3ec929..a13d8458d634 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "udid": "25084fb7-307a-4720-8f91-7952a0b91012", "UpdateContent": { "type": "FeatureCollection", @@ -31,7 +31,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json index f1736046f20f..e9e43fa86368 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "dataFormat": "geojson", "UploadContent": { "type": "FeatureCollection", @@ -31,12 +31,12 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2.0", + "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2022-01-01-preview", "Access-Control-Expose-Headers": "Operation-Location" } }, diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json index df5d8e659524..20ddfb37a5ee 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "conversionId": "[conversionId]" }, "responses": { @@ -12,12 +12,12 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2.0", + "Operation-Location": "https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2022-01-01-preview", "Access-Control-Expose-Headers": "Operation-Location" } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json index b2193a7993db..bcdc4f9ee667 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "[datasetId]" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json index 33836ce57754..cbc36c7d0ef5 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "[datasetId]" }, "responses": { @@ -32,7 +32,7 @@ "opening": 48, "areaElement": 108 }, - "ontology": "facility-2.0" + "ontology": "facility-2022-01-01-preview" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json index 8ea9c0cb5da0..d890ffbfcfe2 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { @@ -12,7 +12,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json index 52d48d34f311..245506ef8536 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json index 13e4eda45125..149352cc7594 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "200": { @@ -25,7 +25,7 @@ "opening": 471, "areaElement": 496 }, - "ontology": "facility-2.0" + "ontology": "facility-2022-01-01-preview" }, { "created": "2021-05-21T03:04:05.678Z", @@ -48,7 +48,7 @@ "opening": 48, "areaElement": 108 }, - "ontology": "facility-2.0" + "ontology": "facility-2022-01-01-preview" } ] } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json index 80d3be39e2f1..ef512cfe39f4 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "description": "Stateset for Azure Maps POC.", "datasetId": "5d34fbe8-87b7-f7c0-3144-c50e003a3c75", "styleRules": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json index 1b5f29227d13..e34410c90334 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", "featureId": "SPC4709", "stateKeyName": "keyName1" diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json index ae9a27be981f..3811cd5051b5 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json index ff6d43f4b6a0..17296ac5a5fd 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "statesetId": "b24bdb73-1305-3212-1909-a428d937b64" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json index b810b73a8c1f..0d129cd85bbf 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json index 24af0a5fc1cc..36abc3fdb1e1 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", "featureId": "SPC4709" }, diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json index ee6316364a98..bfedcc72426f 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", "featureId": "SPC4709", "featureStates": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json index 7bc6f55f1718..99ae6595a578 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", "styleRules": { "styles": [ diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json index 0ca2acebc8d8..fb4bf535606d 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "[dataset-Id]" }, "responses": { @@ -12,12 +12,12 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2.0", + "Operation-Location": "https://us.atlas.microsoft.com/tilesets/operations/{operationId}?api-version=2022-01-01-preview", "Access-Control-Expose-Headers": "Operation-Location" } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json index 71049ceba9d2..470b4fcf8e54 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Delete.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "tilesetId": "25084fb7-307a-4720-8f91-7952a0b91012" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json index f4078cebc0b9..415a0bd28413 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Get.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json index 671289b480bb..901d785d4e68 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperation.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { @@ -12,7 +12,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/tilesets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2.0" + "Resource-Location": "https://us.atlas.microsoft.com/tilesets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json index 52d48d34f311..245506ef8536 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetOperationStillRunning.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json index 93cf5ac3c2d2..a2011ca61420 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_List.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0" + "api-version": "2022-01-01-preview" }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json index e27d3eff14bf..1754991bc271 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", "collectionId": "facility", "featureId": "FCL39" diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json index 9f263859487b..8ad44a3b60c9 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", "collectionId": "unit" }, @@ -10,20 +10,20 @@ "body": { "name": "unit", "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", - "ontology": "Facility-2.0", + "ontology": "Facility-2022-01-01-preview", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for unit" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview", "rel": "data", "title": "unit" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for unit" } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json index e2e020b432c8..cce385955930 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", "collectionId": "unit" }, @@ -11,7 +11,7 @@ "idPrefix": "UNIT", "name": "unit", "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", - "ontology": "Facility-2.0", + "ontology": "Facility-2022-01-01-preview", "geometryType": "Polygon", "featureTypes": [], "properties": [ @@ -136,12 +136,12 @@ ], "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for unit" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview", "rel": "data", "title": "unit" } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json index ab9196a76fc6..fc6352e37d46 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json @@ -1,30 +1,30 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" }, "responses": { "200": { "body": { - "ontology": "Facility-2.0", + "ontology": "Facility-2022-01-01-preview", "collections": [ { "name": "unit", "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for unit" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview", "rel": "data", "title": "unit" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for unit" } @@ -35,17 +35,17 @@ "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for zone" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2022-01-01-preview", "rel": "data", "title": "zone" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for zone" } @@ -56,17 +56,17 @@ "description": "An indication of the extent and vertical position of a set of features.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for level" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2022-01-01-preview", "rel": "data", "title": "level" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for level" } @@ -77,17 +77,17 @@ "description": "Area of the site, building footprint etc.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for facility" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2022-01-01-preview", "rel": "data", "title": "facility" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for facility" } @@ -98,17 +98,17 @@ "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for verticalPenetration" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2022-01-01-preview", "rel": "data", "title": "verticalPenetration" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for verticalPenetration" } @@ -119,17 +119,17 @@ "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for opening" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2022-01-01-preview", "rel": "data", "title": "opening" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for opening" } @@ -140,17 +140,17 @@ "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for directoryInfo" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2022-01-01-preview", "rel": "data", "title": "directoryInfo" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for directoryInfo" } @@ -161,17 +161,17 @@ "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for pointElement" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2022-01-01-preview", "rel": "data", "title": "pointElement" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for pointElement" } @@ -182,17 +182,17 @@ "description": "A line feature in a unit, such as a dividing wall, window.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for lineElement" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2022-01-01-preview", "rel": "data", "title": "lineElement" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for lineElement" } @@ -203,17 +203,17 @@ "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for areaElement" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2022-01-01-preview", "rel": "data", "title": "areaElement" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for areaElement" } @@ -224,17 +224,17 @@ "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.", "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2022-01-01-preview", "rel": "describedBy", "title": "Metadata catalogue for category" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2022-01-01-preview", "rel": "data", "title": "category" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2022-01-01-preview", "rel": "self", "title": "Metadata catalogue for category" } @@ -243,7 +243,7 @@ ], "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2022-01-01-preview", "rel": "self" } ] diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json index 2d90e3409188..225286fa1436 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", "collectionId": "unit", "featureId": "UNIT39" @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "ontology": "Facility-2.0", + "ontology": "Facility-2022-01-01-preview", "feature": { "type": "Feature", "geometry": { @@ -70,11 +70,11 @@ }, "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2022-01-01-preview", "rel": "self" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", "rel": "data" } ] diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json index baadf9b72821..ca67a8127fc3 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "018fda98-e638-0edf-5ef7-28491ff3bed4", "collectionId": "unit", "limit": 1, @@ -11,7 +11,7 @@ "200": { "body": { "type": "FeatureCollection", - "ontology": "Facility-2.0", + "ontology": "Facility-2022-01-01-preview", "features": [ { "type": "Feature", @@ -75,15 +75,15 @@ "numberReturned": 1, "links": [ { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2.0&limit=1", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview&limit=1", "rel": "self" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2.0", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", "rel": "data" }, { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2.0&limit=1", + "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2022-01-01-preview&limit=1", "rel": "next" } ] diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json index 488dc128f5fc..e84ea1accc61 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json @@ -1,13 +1,13 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" }, "responses": { "200": { "body": { - "ontology": "Facility-2.0", + "ontology": "Facility-2022-01-01-preview", "links": [ { "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json index 00fc7956f640..b41afc38fee7 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json @@ -1,7 +1,7 @@ { "parameters": { "geography": "us", - "api-version": "2.0", + "api-version": "2022-01-01-preview", "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json index 96bbaf6ee5b6..070379bfcdf0 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Feature State Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "APIs for managing the dynamic feature states in Azure Maps." }, "x-ms-parameterized-host": { @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "FeatureStateSetDescription": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index fa2e258968a6..78800114d41f 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Tileset Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "APIs for managing Tilesets." }, "x-ms-parameterized-host": { @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "DatasetIdQuery": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json index b944c8c21255..897f1a67eb88 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json @@ -1,8 +1,8 @@ { - "swagger": "2.0", + "swagger": "2022-01-01-preview", "info": { "title": "Azure Maps Web Feature Service", - "version": "2.0", + "version": "2022-01-01-preview", "description": "Azure Maps Web Feature REST APIs" }, "x-ms-parameterized-host": { @@ -25,7 +25,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } @@ -64,7 +64,7 @@ "type": "string", "in": "query", "required": true, - "default": "2.0", + "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, "LimitWfs": { From 991ea4e8aecf94a9baf686dc0b4bc48bcafe952a Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 9 Dec 2021 01:20:11 -0800 Subject: [PATCH 04/23] swagger version back to 2.0 --- .../data-plane/Creator/preview/2022-01-01-preview/alias.json | 2 +- .../data-plane/Creator/preview/2022-01-01-preview/data.json | 2 +- .../data-plane/Creator/preview/2022-01-01-preview/dataset.json | 2 +- .../Creator/preview/2022-01-01-preview/dwgconversion.json | 2 +- .../Creator/preview/2022-01-01-preview/featurestate.json | 2 +- .../data-plane/Creator/preview/2022-01-01-preview/tileset.json | 2 +- .../maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json index 43dba70f256e..b9e926f7000b 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Alias Service", "version": "2022-01-01-preview", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json index a6e9fdff02cf..17ba723ca5a1 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Data Service", "version": "2022-01-01-preview", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json index 9af02f4cb7c4..352f270e6580 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Dataset Service", "version": "2022-01-01-preview", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json index 90675c7ac198..c8dedc7933a3 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Conversion Service", "version": "2022-01-01-preview", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json index 070379bfcdf0..a547dd8f7b22 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Feature State Service", "version": "2022-01-01-preview", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index 78800114d41f..9bd0755c26c6 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Tileset Service", "version": "2022-01-01-preview", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json index 897f1a67eb88..fad45ae51ae8 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json @@ -1,5 +1,5 @@ { - "swagger": "2022-01-01-preview", + "swagger": "2.0", "info": { "title": "Azure Maps Web Feature Service", "version": "2022-01-01-preview", From 996b3d8251121d6545f3e6cebf9e7c5189b5cda0 Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 9 Dec 2021 01:45:20 -0800 Subject: [PATCH 05/23] Add tileset recipe for tileset API specs --- .../examples/tileset/Tileset_Create.json | 2 +- .../preview/2022-01-01-preview/tileset.json | 78 +++++++++++++++++++ 2 files changed, 79 insertions(+), 1 deletion(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json index fb4bf535606d..76961a7fa13f 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json @@ -12,7 +12,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + "Resource-Location": "https://us.atlas.microsoft.com/tilesets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index 9bd0755c26c6..852cc5080d09 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -125,6 +125,15 @@ }, { "$ref": "#/parameters/DescriptionTileset" + }, + { + "name": "TilesetRecipe", + "in": "body", + "description": "The custom tileset recipe to use.", + "required": false, + "schema": { + "type": "json" + } } ], "responses": { @@ -319,6 +328,75 @@ "bbox": { "description": "Bounding box which all features of the tileset lay within. Projection used - EPSG:3857. Format : 'minLon, minLat, maxLon, maxLat'.", "$ref": "../../../Common/preview/1.0/common.json#/definitions/BoundingBox" + }, + "tilesetRecipe": { + "description": "Tileset recipe which is used to build the tileset.", + "$ref": "#/definitions/TilesetRecipe" + } + } + }, + "TilesetRecipe": { + "description": "A tileset recipe object. Please refer to [Tileset Recipe Specification]() for details.", + "type": "object", + "required": [ + "version", "layers" + ], + "properties": { + "version": { + "description": "The version of Azure Maps Tiling service recipe reference that the recipe uses.", + "type": "integer" + }, + "layers": { + "description": "The names of the layers and their configuration options.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/LayerObject" + } + } + } + }, + "LayerObject": { + "description": "Layer object for tileset recipe.", + "type": "object", + "required": [ + "features", "minzoom", "maxzoom" + ], + "properties": { + "features": { + "description": "Specifies the output on a per feature basis.", + "$ref": "#/definitions/Feature" + }, + "minzoom": { + "description": "The lowest zoom level for the layer to build.", + "type": "integer" + }, + "maxzoom": { + "description": "The highest zoom level for the layer to build.", + "type": "integer" + } + } + }, + "Feature": { + "description": "Feature configuration for tileset recipe.", + "type": "object", + "required": [ + "featureClasses" + ], + "properties": { + "featureClasses": { + "description": "The list of featureClasses that will be used to build the layer.", + "type": "array", + "items":{ + "type": "string" + } + }, + "minzoom": { + "description": "The lowest zoom level for the layer to build.", + "type": "integer" + }, + "maxzoom": { + "description": "The highest zoom level for the layer to build.", + "type": "integer" } } } From 13b92f284d545a5cacc2ac51008a754e4ecb4b56 Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 9 Dec 2021 02:44:18 -0800 Subject: [PATCH 06/23] Add style API specs --- .../examples/style/Style_Delete.json | 10 + .../examples/style/Style_Export.json | 32 ++ .../examples/style/Style_GetOperation.json | 19 ++ .../style/Style_GetOperationStillRunning.json | 16 + .../examples/style/Style_Import.json | 44 +++ .../examples/style/Style_List.json | 33 ++ .../preview/2022-01-01-preview/style.json | 321 ++++++++++++++++++ .../preview/2022-01-01-preview/tileset.json | 10 +- .../maps/data-plane/Creator/readme.md | 1 + 9 files changed, 479 insertions(+), 7 deletions(-) create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperationStillRunning.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json new file mode 100644 index 000000000000..404112fcbbd1 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "styleId": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json new file mode 100644 index 000000000000..9c7fc71357ff --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "styleId": "25084fb7-307a-4720-8f91-7952a0b91012", + "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84" + }, + "responses": { + "200": { + "body": { + "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", + "version": 1, + "created": "2021-05-21T03:04:05.678Z", + "description": "Some optional description", + "source": "azuremaps://tilesets/d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "sprite": "azuremaps://sprite/e33700db-127e-4ed0-bfec-7a1830eca06d", + "layers": [ + { + "id": "background", + "type": "background", + "source-layer": "bg-source", + "layout": {}, + "paint": { + "background-color": [] + } + }, + {} + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json new file mode 100644 index 000000000000..6ef1fbefe5bf --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/styles/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperationStillRunning.json new file mode 100644 index 000000000000..245506ef8536 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json new file mode 100644 index 000000000000..2d1c14168ee2 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "format": "mapbox", + "UploadContent": { + "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", + "version": 1, + "created": "2021-05-21T03:04:05.678Z", + "description": "Some optional description", + "sprite": "azuremaps://sprite/e33700db-127e-4ed0-bfec-7a1830eca06d", + "layers": [ + { + "id": "background", + "type": "background", + "source-layer": "bg-source", + "layout": {}, + "paint": { + "background-color": [] + } + }, + {} + ] + } + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/styles/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/styles/operations/{operationId}?api-version=2022-01-01-preview", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json new file mode 100644 index 000000000000..a9730aaeb967 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview" + }, + "responses": { + "200": { + "body": { + "tilesets": [ + { + "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", + "version": 1, + "created": "2021-05-21T03:04:05.678Z", + "description": "Some optional description", + "sprite": "azuremaps://sprite/e33700db-127e-4ed0-bfec-7a1830eca06d", + "layers": [ + { + "id": "background", + "type": "background", + "source-layer": "bg-source", + "layout": {}, + "paint": { + "background-color": [] + } + }, + {} + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json new file mode 100644 index 000000000000..e2b0ce639870 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json @@ -0,0 +1,321 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps Style Service", + "version": "2022-01-01-preview", + "description": "This is an extension of the Azure Maps Tileset API to serve custom styles. It will allow a client to create a list of map styling information which can be combined with tilesetIds to compose a Mapbox style that can be consumed directly by front-end services (map control web & mobile SDKs, styling tools like [Maputnik](https://maputnik.github.io/editor/))." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2022-01-01-preview", + "x-ms-parameter-location": "client" + }, + "StyleId": { + "name": "styleId", + "description": "The Style Id.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "TilesetId": { + "name": "tilesetId", + "description": "The Tileset Id", + "type": "string", + "in": "path", + "required": false, + "x-ms-parameter-location": "method" + }, + "DescriptionStyle": { + "name": "description", + "description": "User provided description of the style.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "StyleOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the style create/import request.", + "required": true, + "x-ms-parameter-location": "method" + }, + "Format": { + "name": "format", + "in": "query", + "description": "Defines the type of input file for a style to be created from", + "required": false, + "schema": { + "type": "string", + "default": "JSON", + "enum": [ + "JSON", + "ZIP" + ] + } + } + }, + "paths": { + "/styles": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Style Import API allows the caller to import a style from a their style json file.\n\n## Submit Import Request\n\nTo import your style you will make a `POST` request with an azure maps style or mapbox style. \n\nThe Import Style API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "Style_Import", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Import Style by providing a azure maps or mapbox style json file": { + "$ref": "./examples/style/Style_Import.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/Format" + }, + { + "$ref": "#/parameters/DescriptionStyle" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all styles imported. \n
", + "operationId": "Style_List", + "x-ms-examples": { + "Get a list of all styles": { + "$ref": "./examples/style/Style_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "styles", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List style request completed successfully. The response body contains a list of all styles.", + "schema": { + "$ref": "#/definitions/StyleListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/styles/{styleId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a style.", + "operationId": "Style_Export", + "x-ms-examples": { + "Exports the details for a single style": { + "$ref": "./examples/style/Style_Export.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleId" + }, + { + "$ref": "#/parameters/TilesetId" + } + ], + "responses": { + "200": { + "description": "List style request completed successfully. The response body contains a list of all styles.", + "schema": { + "$ref": "#/definitions/Style" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a imported style.
\nYou can use this API if a style is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `styleId` of the style to delete.
\n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "operationId": "Style_Delete", + "x-ms-examples": { + "Delete a imported style": { + "$ref": "./examples/style/Style_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleId" + } + ], + "responses": { + "204": { + "description": "Style delete request completed successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/styles/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to /styles/import. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "operationId": "Style_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/style/Style_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/style/Style_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "StyleListResult": { + "description": "The response model for the Style List API. Returns a list of all styles.", + "type": "object", + "properties": { + "styles": { + "description": "A list of all styles.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Style" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "Style": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "styleId": { + "description": "The unique style id for the style.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the style. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index 852cc5080d09..deae99b8a93f 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -390,13 +390,9 @@ "type": "string" } }, - "minzoom": { - "description": "The lowest zoom level for the layer to build.", - "type": "integer" - }, - "maxzoom": { - "description": "The highest zoom level for the layer to build.", - "type": "integer" + "filter": { + "description": "Removes features that do not match a pattern.", + "type": "Expression" } } } diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md index e5339a18d86b..53497cf6a958 100644 --- a/specification/maps/data-plane/Creator/readme.md +++ b/specification/maps/data-plane/Creator/readme.md @@ -47,6 +47,7 @@ input-file: - preview/2022-01-01-preview/featurestate.json - preview/2022-01-01-preview/tileset.json - preview/2022-01-01-preview/wfs.json + - preview/2022-01-01-preview/style.json ``` ### Tag: 2.0-preview From 66e551b9ae2dbd2592cec0eddde068542bef7aca Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 9 Dec 2021 17:18:34 -0800 Subject: [PATCH 07/23] Add swagger doc for styleSet APIs --- .../examples/dataset/Dataset_Create.json | 2 +- .../examples/styleset/StyleSet_Create.json | 26 ++ .../examples/styleset/StyleSet_Delete.json | 10 + .../examples/styleset/StyleSet_Get.json | 34 ++ .../styleset/StyleSet_GetOperation.json | 19 ++ .../StyleSet_GetOperationStillRunning.json | 16 + .../examples/styleset/StyleSet_List.json | 37 ++ .../preview/2022-01-01-preview/style.json | 4 +- .../preview/2022-01-01-preview/styleset.json | 323 ++++++++++++++++++ .../maps/data-plane/Creator/readme.md | 1 + 10 files changed, 469 insertions(+), 3 deletions(-) create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Delete.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperation.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperationStillRunning.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json index 20ddfb37a5ee..d7013015d494 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json @@ -12,7 +12,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json new file mode 100644 index 000000000000..48bede23286f --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "styleSetId": "25084fb7-307a-4720-8f91-7952a0b91012", + "description": "This is my first styleset." + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2022-01-01T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/styles/styleSets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + } + }, + "202": { + "headers": { + "Operation-Location": "https://us.atlas.microsoft.com/styles/styleSets/operations/{operationId}?api-version=2022-01-01-preview", + "Access-Control-Expose-Headers": "Operation-Location" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Delete.json new file mode 100644 index 000000000000..8dc4e34eaf71 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Delete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "styleSetId": "25084fb7-307a-4720-8f91-7952a0b91012" + }, + "responses": { + "204": {} + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json new file mode 100644 index 000000000000..c6fd2b3048e1 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "styleSetId": "[styleSetId]" + }, + "responses": { + "200": { + "body": { + "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", + "version": 1, + "created": "2021-05-21T03:04:05.678Z", + "description": "My greatest style set", + "defaultStyle": "indoor-light", + "styles": [ + { + "name": "indoor-light", + "displayName": "My cool map styling", + "theme": "light", + "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-light.png", + "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-light" + }, + { + "name": "indoor-dark", + "displayName": "Awesome map styling", + "theme": "dark", + "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-dark.png", + "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-dark" + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperation.json new file mode 100644 index 000000000000..8302d2677ac4 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperation.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-20T22:43:14.9401559+00:00", + "status": "Succeeded" + }, + "headers": { + "Resource-Location": "https://us.atlas.microsoft.com/styles/styleSets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperationStillRunning.json new file mode 100644 index 000000000000..245506ef8536 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetOperationStillRunning.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" + }, + "responses": { + "200": { + "body": { + "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", + "created": "2021-04-23T19:14:03.2452596+00:00", + "status": "Running" + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json new file mode 100644 index 000000000000..c8cf9b540f49 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview" + }, + "responses": { + "200": { + "body": { + "styleSets": [ + { + "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", + "version": 1, + "created": "2021-05-21T03:04:05.678Z", + "description": "My greatest style set", + "defaultStyle": "indoor-light", + "styles": [ + { + "name": "indoor-light", + "displayName": "My cool map styling", + "theme": "light", + "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-light.png", + "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-light" + }, + { + "name": "indoor-dark", + "displayName": "Awesome map styling", + "theme": "dark", + "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-dark.png", + "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-dark" + } + ] + } + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json index e2b0ce639870..7d063c2d01f4 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json @@ -211,7 +211,7 @@ ], "responses": { "200": { - "description": "List style request completed successfully. The response body contains a list of all styles.", + "description": "Export style request completed successfully. The response body contains a single style.", "schema": { "$ref": "#/definitions/Style" } @@ -252,7 +252,7 @@ }, "/styles/operations/{operationId}": { "get": { - "description": "This path will be obtained from a call to /styles/import. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "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.", "operationId": "Style_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json new file mode 100644 index 000000000000..74c38add73f0 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -0,0 +1,323 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Maps StyleSet Service", + "version": "2022-01-01-preview", + "description": "This is an extension of the Azure Maps Tileset API to serve custom styles. It will allow a client to create a list of map styling information which can be combined with tilesetIds to compose a Mapbox style that can be consumed directly by front-end services (map control web & mobile SDKs, styling tools like [Maputnik](https://maputnik.github.io/editor/)). StyleSet can be viewed as the backend representation for a style picker at frontend." + }, + "x-ms-parameterized-host": { + "hostTemplate": "{geography}.atlas.microsoft.com", + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" + } + }, + "SharedKey": { + "type": "apiKey", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "name": "subscription-key", + "in": "query" + }, + "SasToken": { + "type": "apiKey", + "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", + "name": "SAS Token", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://atlas.microsoft.com/.default" + ] + }, + { + "SharedKey": [] + }, + { + "SasToken": [] + } + ], + "responses": {}, + "parameters": { + "ApiVersion": { + "name": "api-version", + "description": "Version number of Azure Maps API.", + "type": "string", + "in": "query", + "required": true, + "default": "2022-01-01-preview", + "x-ms-parameter-location": "client" + }, + "StyleSetId": { + "name": "styleSetId", + "description": "The StyleSet Id.", + "type": "string", + "in": "query", + "required": true, + "x-ms-parameter-location": "method" + }, + "TilesetId": { + "name": "tilesetId", + "description": "The Tileset Id", + "type": "string", + "in": "path", + "required": false, + "x-ms-parameter-location": "method" + }, + "DescriptionStyleSet": { + "name": "description", + "description": "User provided description of the styleSet.", + "type": "string", + "in": "query", + "x-ms-parameter-location": "method" + }, + "StyleSetOperationId": { + "name": "operationId", + "type": "string", + "in": "path", + "description": "The ID to query the status for the styleSet create request.", + "required": true, + "x-ms-parameter-location": "method" + }, + "DataFormat": { + "name": "dataFormat", + "in": "query", + "description": "Defines the type of input file for a style set to be created from", + "required": false, + "schema": { + "type": "string", + "default": "JSON", + "enum": [ + "JSON", + "ZIP" + ] + } + } + }, + "paths": { + "styles/stylesets": { + "post": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe StyleSet Create API allows the caller to create a styleSet from their styleSet configuration file.\n\n## Submit Create Request\n\nTo create your styleset you will make a `POST` request with a styleSet configration file. \n\nThe Create StyleSet API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "StyleSet_Create", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Import Style by providing a azure maps or mapbox style json file": { + "$ref": "./examples/styleset/StyleSet_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DataFormat" + }, + { + "$ref": "#/parameters/DescriptionStyleSet" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "202": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all styleSets created. \n
", + "operationId": "StyleSet_List", + "x-ms-examples": { + "Get a list of all styleSets": { + "$ref": "./examples/style/StyleSet_List.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "itemName": "styleSets", + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "List styleSets request completed successfully. The response body contains a list of all styleSets.", + "schema": { + "$ref": "#/definitions/StyleSetListResult" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/styles/stylesets/{styleId}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a styleSet.", + "operationId": "StyleSet_Get", + "x-ms-examples": { + "Gets the details for a single styleSet": { + "$ref": "./examples/styleset/StyleSet_Get.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleSetId" + } + ], + "responses": { + "200": { + "description": "Get styleSet request completed successfully. The response body contains a single styleSet.", + "schema": { + "$ref": "#/definitions/Style" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + }, + "delete": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a created styleSet.
\nYou can use this API if a style is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `styleSetId` of the styleSet to delete.
\n\n#### Delete request \"Successful\"\n\nThe StyleSet Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the styleSet with the passed-in `styleSetId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - StyleSet Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "operationId": "StyleSet_Delete", + "x-ms-examples": { + "Delete a imported style": { + "$ref": "./examples/styleset/StyleSet_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleSetId" + } + ], + "responses": { + "204": { + "description": "StyleSet delete request completed successfully." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/styles/operations/{operationId}": { + "get": { + "description": "This path will be obtained from a call to create a styleSet. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "operationId": "StyleSet_GetOperation", + "x-ms-examples": { + "Get the status of an operation which is still running": { + "$ref": "./examples/styleset/StyleSet_GetOperationStillRunning.json" + }, + "Get the status of an operation which has finished successfully": { + "$ref": "./examples/styleset/StyleSet_GetOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleSetOperationId" + } + ], + "responses": { + "200": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + } + }, + "definitions": { + "StyleSetListResult": { + "description": "The response model for the StyleSet List API. Returns a list of all styleSets.", + "type": "object", + "properties": { + "styles": { + "description": "A list of all styleSets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/StyleSet" + } + }, + "nextLink": { + "description": "If present, the location of the next page of data.", + "type": "string", + "readOnly": true + } + } + }, + "StyleSet": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "styleSetId": { + "description": "The unique styleSet id for the styleSet.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the styleSet. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The creation date and time of this styleSet.", + "type": "string", + "readOnly": true + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md index 53497cf6a958..b91622228268 100644 --- a/specification/maps/data-plane/Creator/readme.md +++ b/specification/maps/data-plane/Creator/readme.md @@ -48,6 +48,7 @@ input-file: - preview/2022-01-01-preview/tileset.json - preview/2022-01-01-preview/wfs.json - preview/2022-01-01-preview/style.json + - preview/2022-01-01-preview/styleset.json ``` ### Tag: 2.0-preview From 21cfcecebae53abb1568fa00823eca9e181f699c Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 9 Dec 2021 17:57:20 -0800 Subject: [PATCH 08/23] fix build error and add styleset style get API specs --- .../preview/2022-01-01-preview/styleset.json | 65 +++++++++++++++++-- 1 file changed, 61 insertions(+), 4 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index 74c38add73f0..5e3e29286e83 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -71,7 +71,15 @@ "name": "styleSetId", "description": "The StyleSet Id.", "type": "string", - "in": "query", + "in": "path", + "required": true, + "x-ms-parameter-location": "method" + }, + "StyleName": { + "name": "styleName", + "description": "The StyleSet style name.", + "type": "string", + "in": "path", "required": true, "x-ms-parameter-location": "method" }, @@ -111,6 +119,19 @@ "ZIP" ] } + }, + "StyleFormat": { + "name": "styleFormat", + "in": "query", + "description": "Defines the type of JSON object that is exported", + "required": false, + "schema": { + "type": "string", + "default": "mapbox", + "enum": [ + "mapbox" + ] + } } }, "paths": { @@ -158,7 +179,7 @@ "operationId": "StyleSet_List", "x-ms-examples": { "Get a list of all styleSets": { - "$ref": "./examples/style/StyleSet_List.json" + "$ref": "./examples/styleset/StyleSet_List.json" } }, "parameters": [ @@ -186,7 +207,7 @@ } } }, - "/styles/stylesets/{styleId}": { + "/styles/stylesets/{styleSetId}": { "get": { "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a styleSet.", "operationId": "StyleSet_Get", @@ -210,7 +231,7 @@ "200": { "description": "Get styleSet request completed successfully. The response body contains a single styleSet.", "schema": { - "$ref": "#/definitions/Style" + "$ref": "#/definitions/StyleSet" } }, "default": { @@ -247,6 +268,42 @@ } } }, + "/styles/stylesets/{styleSetId}/{styleName}": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to export a composed style defined in the styleSet.", + "operationId": "StyleSet_GetStyle", + "x-ms-examples": { + "Gets the details for a single styleSet": { + "$ref": "./examples/styleset/StyleSet_GetStyle.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StyleSetId" + }, + { + "$ref": "#/parameters/StyleName" + }, + { + "$ref": "#/parameters/StyleFormat" + } + ], + "responses": { + "200": { + "description": "Get composed styleSet style request completed successfully. The response body contains a single style." + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, "/styles/operations/{operationId}": { "get": { "description": "This path will be obtained from a call to create a styleSet. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", From fd4b119a0d49cfffd703f3a45828d8506fa2996f Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 9 Dec 2021 23:48:32 -0800 Subject: [PATCH 09/23] add missing styleset get style example json file --- .../examples/styleset/StyleSet_GetStyle.json | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json new file mode 100644 index 000000000000..2107c93dcec3 --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "styleSetId": "[styleSetId]", + "styleName": "composedStyle" + }, + "responses": { + "200": { + "body": { + "version": 8, + "name": "My cool map styling", + "sources": { + "microsoft.base": { + "url": "https://us.atlas.microsoft.com/map/tileset?api-version=2.1&tilesetId=microsoft.base", + "type": "vector" + }, + "64d79640-1db8-42e9-8e4a-714be32543c6": { + "url": "https://us.atlas.microsoft.com/tileset/64d79640-1db8-42e9-8e4a-714be32543c6", + "type": "vector" + } + }, + "sprite": "https://us.atlas.microsoft.com/styling/sprite/019db5fd-1792-4a84-9e39-7a82ceaea311", + "glyphs": "https://us.atlas.microsoft.com/styling/glyphs/{fontstack}/{range}.pbf", + "layers": [ + { + "id": "microsoft.maps.base.base.background:grayscale_light:microsoft.base", + "source": "microsoft.base", + "type": "background", + "layout": {}, + "paint": { + "background-color": "hsl(55, 11%, 96%)" + } + }, + { + "id": "indoorLayer:9c451b0a-6527-49a7-9154-1b3d9486487f:64d79640-1db8-42e9-8e4a-714be32543c6", + "source": "microsoft.base", + "type": "background", + "layout": {}, + "paint": { + "background-color": "hsl(55, 11%, 96%)" + } + } + ] + } + } + } +} From 79ed7259710350297d56e820bf4c33ba77ce3467 Mon Sep 17 00:00:00 2001 From: Xubin Date: Fri, 10 Dec 2021 00:08:14 -0800 Subject: [PATCH 10/23] Add tileset recipe get and validate docs --- .../examples/tileset/Tileset_GetRecipe.json | 36 +++++++++++ .../tileset/Tileset_ValidateRecipe.json | 18 ++++++ .../preview/2022-01-01-preview/tileset.json | 63 +++++++++++++++++++ 3 files changed, 117 insertions(+) create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetRecipe.json create mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetRecipe.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetRecipe.json new file mode 100644 index 000000000000..1d3f60fe31db --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_GetRecipe.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "datasetId": "[datasetId]" + }, + "responses": { + "200": { + "body": { + "version": 1, + "layers": { + "Indoor unit": { + "minzoom": 10, + "maxzoom": 18, + "features": { + "featureClasses": [ "unit", "wall" ], + "filter": [ + "any", + [ + "!=", + [ "get", "roomType" ], + "conference" + ], + [ + ">=", + [ "zoom" ], + 12 + ] + ] + } + } + } + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json new file mode 100644 index 000000000000..e2eb9ab2852d --- /dev/null +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "geography": "us", + "api-version": "2022-01-01-preview", + "datasetId": "[datasetId]" + }, + "responses": { + "200": { + "body": { + "valid": false, + "warnings": [], + "errors": [ + "minzoom 12 cannot be larger than maxzoom 11 for Indoor unit layer." + ] + } + } + } +} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index deae99b8a93f..2f32e08cc762 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -242,6 +242,69 @@ } } }, + "/tilesets/recipes": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to get a default tileset recipe based on the dataset provided.", + "operationId": "Tileset_GetRecipe", + "x-ms-examples": { + "Gets the tileset recipe for a given dataset ontology": { + "$ref": "./examples/tileset/Tileset_GetRecipe.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetIdQuery" + } + ], + "responses": { + "200": { + "description": "Get tileset recipe request completed successfully. The response body contains a default tileset recipe generated for the given dataset ontology.", + "schema": { + "$ref": "#/definitions/TilesetRecipe" + } + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, + "/tilesets/recipes/validate": { + "get": { + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to validate a tileset recipe.", + "operationId": "Tileset_ValidateRecipe", + "x-ms-examples": { + "Validates the correctness of a tileset recipe": { + "$ref": "./examples/tileset/Tileset_ValidateRecipe.json" + } + }, + "parameters": [ + { + "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/DatasetIdQuery" + } + ], + "responses": { + "200": { + "description": "Validate tileset recipe request completed successfully. The response body contains the validation results.", + }, + "default": { + "$ref": "../../../Common/preview/1.0/common.json#/responses/default" + } + } + } + }, "/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.", From 760cc76bf0ce66499cc7a169fddaaec8e8f3989b Mon Sep 17 00:00:00 2001 From: Xubin Date: Sun, 12 Dec 2021 23:17:12 -0800 Subject: [PATCH 11/23] fix validation errors --- .../StyleRecipe_Delete.json} | 2 +- .../StyleRecipe_Export.json} | 4 +- .../StyleRecipe_GetOperation.json} | 2 +- ...StyleRecipe_GetOperationStillRunning.json} | 0 .../StyleRecipe_Import.json} | 7 +- .../StyleRecipe_List.json} | 2 +- .../preview/2022-01-01-preview/style.json | 154 +++++++++++++----- .../preview/2022-01-01-preview/styleset.json | 43 ++++- .../preview/2022-01-01-preview/tileset.json | 6 +- 9 files changed, 161 insertions(+), 59 deletions(-) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/{style/Style_Delete.json => stylerecipe/StyleRecipe_Delete.json} (67%) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/{style/Style_Export.json => stylerecipe/StyleRecipe_Export.json} (83%) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/{style/Style_GetOperation.json => stylerecipe/StyleRecipe_GetOperation.json} (84%) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/{style/Style_GetOperationStillRunning.json => stylerecipe/StyleRecipe_GetOperationStillRunning.json} (100%) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/{style/Style_Import.json => stylerecipe/StyleRecipe_Import.json} (83%) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/{style/Style_List.json => stylerecipe/StyleRecipe_List.json} (96%) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Delete.json similarity index 67% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Delete.json index 404112fcbbd1..7c87b65254e6 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Delete.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Delete.json @@ -2,7 +2,7 @@ "parameters": { "geography": "us", "api-version": "2022-01-01-preview", - "styleId": "25084fb7-307a-4720-8f91-7952a0b91012" + "styleRecipeId": "25084fb7-307a-4720-8f91-7952a0b91012" }, "responses": { "204": {} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json similarity index 83% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json index 9c7fc71357ff..d52de7497eca 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Export.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json @@ -2,7 +2,7 @@ "parameters": { "geography": "us", "api-version": "2022-01-01-preview", - "styleId": "25084fb7-307a-4720-8f91-7952a0b91012", + "styleRecipeId": "25084fb7-307a-4720-8f91-7952a0b91012", "tilesetId": "d8fa86de-bb0f-4a02-a6ff-62ae7545dd84" }, "responses": { @@ -12,7 +12,7 @@ "version": 1, "created": "2021-05-21T03:04:05.678Z", "description": "Some optional description", - "source": "azuremaps://tilesets/d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "sources": "azuremaps://tilesets/d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", "sprite": "azuremaps://sprite/e33700db-127e-4ed0-bfec-7a1830eca06d", "layers": [ { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_GetOperation.json similarity index 84% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_GetOperation.json index 6ef1fbefe5bf..baf565099c8b 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperation.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_GetOperation.json @@ -12,7 +12,7 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/styles/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + "Resource-Location": "https://us.atlas.microsoft.com/styles/styleRecipes/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_GetOperationStillRunning.json similarity index 100% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_GetOperationStillRunning.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_GetOperationStillRunning.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json similarity index 83% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json index 2d1c14168ee2..11ffd927e92d 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_Import.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json @@ -2,7 +2,8 @@ "parameters": { "geography": "us", "api-version": "2022-01-01-preview", - "format": "mapbox", + "styleFormat": "mapbox", + "dataFormat": "JSON", "UploadContent": { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", "version": 1, @@ -31,12 +32,12 @@ "status": "Succeeded" }, "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/styles/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" + "Resource-Location": "https://us.atlas.microsoft.com/styles/styleRecipes/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" } }, "202": { "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/styles/operations/{operationId}?api-version=2022-01-01-preview", + "Operation-Location": "https://us.atlas.microsoft.com/styles/styleRecipes/operations/{operationId}?api-version=2022-01-01-preview", "Access-Control-Expose-Headers": "Operation-Location" } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json similarity index 96% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json index a9730aaeb967..727803947aa5 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/style/Style_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json @@ -6,7 +6,7 @@ "responses": { "200": { "body": { - "tilesets": [ + "styleRecipes": [ { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", "version": 1, diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json index 7d063c2d01f4..9708979813dd 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json @@ -67,11 +67,11 @@ "default": "2022-01-01-preview", "x-ms-parameter-location": "client" }, - "StyleId": { - "name": "styleId", - "description": "The Style Id.", + "StyleRecipeId": { + "name": "styleRecipeId", + "description": "The Style Recipe Id.", "type": "string", - "in": "query", + "in": "path", "required": true, "x-ms-parameter-location": "method" }, @@ -79,7 +79,7 @@ "name": "tilesetId", "description": "The Tileset Id", "type": "string", - "in": "path", + "in": "query", "required": false, "x-ms-parameter-location": "method" }, @@ -90,18 +90,32 @@ "in": "query", "x-ms-parameter-location": "method" }, - "StyleOperationId": { + "StyleRecipeOperationId": { "name": "operationId", "type": "string", "in": "path", - "description": "The ID to query the status for the style create/import request.", + "description": "The ID to query the status for the style recipe create/import request.", "required": true, "x-ms-parameter-location": "method" }, - "Format": { - "name": "format", + "DataFormat": { + "name": "dataFormat", + "in": "query", + "description": "Defines the type of input file for a style to be created from.", + "required": false, + "schema": { + "type": "string", + "default": "mapbox", + "enum": [ + "mapbox", + "azureMapsStyleRecipe" + ] + } + }, + "StyleFormat": { + "name": "styleFormat", "in": "query", - "description": "Defines the type of input file for a style to be created from", + "description": " Defines the type of JSON object that is imported.", "required": false, "schema": { "type": "string", @@ -114,17 +128,17 @@ } }, "paths": { - "/styles": { + "/styles/styleRecipes": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Style Import API allows the caller to import a style from a their style json file.\n\n## Submit Import Request\n\nTo import your style you will make a `POST` request with an azure maps style or mapbox style. \n\nThe Import Style API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", - "operationId": "Style_Import", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Style Import API allows the caller to import a style recipe from a their style json file.\n\n## Submit Import Request\n\nTo import your style recipe you will make a `POST` request with an azure maps style or mapbox style. \n\nThe Import Style Recipe API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "operationId": "StyleRecipe_Import", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-examples": { - "Import Style by providing a azure maps or mapbox style json file": { - "$ref": "./examples/style/Style_Import.json" + "Import Style Recipe by providing a azure maps or mapbox style json file": { + "$ref": "./examples/stylerecipe/StyleRecipe_Import.json" } }, "parameters": [ @@ -135,7 +149,10 @@ "$ref": "#/parameters/ApiVersion" }, { - "$ref": "#/parameters/Format" + "$ref": "#/parameters/DataFormat" + }, + { + "$ref": "#/parameters/StyleFormat" }, { "$ref": "#/parameters/DescriptionStyle" @@ -154,11 +171,11 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all styles imported. \n
", - "operationId": "Style_List", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all style recipes imported. \n
", + "operationId": "StyleRecipe_List", "x-ms-examples": { "Get a list of all styles": { - "$ref": "./examples/style/Style_List.json" + "$ref": "./examples/stylerecipe/StyleRecipe_List.json" } }, "parameters": [ @@ -170,14 +187,14 @@ } ], "x-ms-pageable": { - "itemName": "styles", + "itemName": "styleRecipes", "nextLinkName": "nextLink" }, "responses": { "200": { - "description": "List style request completed successfully. The response body contains a list of all styles.", + "description": "List style recipe request completed successfully. The response body contains a list of all style recipes.", "schema": { - "$ref": "#/definitions/StyleListResult" + "$ref": "#/definitions/StyleRecipeListResult" } }, "default": { @@ -186,13 +203,13 @@ } } }, - "/styles/{styleId}": { + "/styles/styleRecipes/{styleRecipeId}": { "get": { "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a style.", - "operationId": "Style_Export", + "operationId": "StyleRecipe_Export", "x-ms-examples": { - "Exports the details for a single style": { - "$ref": "./examples/style/Style_Export.json" + "Exports the details for a single style recipe": { + "$ref": "./examples/stylerecipe/StyleRecipe_Export.json" } }, "parameters": [ @@ -203,7 +220,7 @@ "$ref": "#/parameters/ApiVersion" }, { - "$ref": "#/parameters/StyleId" + "$ref": "#/parameters/StyleRecipeId" }, { "$ref": "#/parameters/TilesetId" @@ -213,7 +230,7 @@ "200": { "description": "Export style request completed successfully. The response body contains a single style.", "schema": { - "$ref": "#/definitions/Style" + "$ref": "#/definitions/StyleRecipe" } }, "default": { @@ -223,10 +240,10 @@ }, "delete": { "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a imported style.
\nYou can use this API if a style is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `styleId` of the style to delete.
\n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", - "operationId": "Style_Delete", + "operationId": "StyleRecipe_Delete", "x-ms-examples": { - "Delete a imported style": { - "$ref": "./examples/style/Style_Delete.json" + "Delete a imported style recipe": { + "$ref": "./examples/stylerecipe/StyleRecipe_Delete.json" } }, "parameters": [ @@ -237,12 +254,12 @@ "$ref": "#/parameters/ApiVersion" }, { - "$ref": "#/parameters/StyleId" + "$ref": "#/parameters/StyleRecipeId" } ], "responses": { "204": { - "description": "Style delete request completed successfully." + "description": "Style recipe delete request completed successfully." }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" @@ -250,16 +267,16 @@ } } }, - "/styles/operations/{operationId}": { + "/styles/styleRecipes/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.", - "operationId": "Style_GetOperation", + "description": "This path will be obtained from a call to create a style recipe. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", + "operationId": "StyleRecipe_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { - "$ref": "./examples/style/Style_GetOperationStillRunning.json" + "$ref": "./examples/stylerecipe/Style_GetOperationStillRunning.json" }, "Get the status of an operation which has finished successfully": { - "$ref": "./examples/style/Style_GetOperation.json" + "$ref": "./examples/stylerecipe/Style_GetOperation.json" } }, "parameters": [ @@ -267,7 +284,7 @@ "$ref": "#/parameters/ApiVersion" }, { - "$ref": "#/parameters/StyleOperationId" + "$ref": "#/parameters/StyleRecipeOperationId" } ], "responses": { @@ -282,16 +299,16 @@ } }, "definitions": { - "StyleListResult": { - "description": "The response model for the Style List API. Returns a list of all styles.", + "StyleRecipeListResult": { + "description": "The response model for the Style Recipe List API. Returns a list of all styleRecipes.", "type": "object", "properties": { - "styles": { + "styleRecipes": { "description": "A list of all styles.", "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/Style" + "$ref": "#/definitions/StyleRecipeListItem" } }, "nextLink": { @@ -301,12 +318,43 @@ } } }, - "Style": { + "StyleRecipeListItem": { "description": "Detail information for the data.", "type": "object", "properties": { "styleId": { - "description": "The unique style id for the style.", + "description": "The unique styleRecipe id for the style.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the style. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The creation date and time of this styleSet.", + "type": "string", + "readOnly": true + } + } + }, + "StyleRecipe": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "id": { + "description": "The unique style recipe id for the style.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the style recipe.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The creation date and time of this style recipe.", "type": "string", "readOnly": true }, @@ -314,6 +362,22 @@ "description": "The description the caller provided when creating the style. Maximum length 1024 characters.", "type": "string", "readOnly": true + }, + "sources": { + "description": "Data source specifications.", + "type": "object", + "readOnly": true + }, + "sprite": { + "description": "A base URL for retrieving the sprite image and metadata.", + "type": "string", + "readOnly": true + }, + "layers": { + "description": "A style's layers property lists all the layers available in that style", + "type": "array", + "readOnly": true, + "items": "object" } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index 5e3e29286e83..f991a1080b52 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -231,7 +231,7 @@ "200": { "description": "Get styleSet request completed successfully. The response body contains a single styleSet.", "schema": { - "$ref": "#/definitions/StyleSet" + "$ref": "#/definitions/StyleSetListItem" } }, "default": { @@ -340,12 +340,12 @@ "description": "The response model for the StyleSet List API. Returns a list of all styleSets.", "type": "object", "properties": { - "styles": { + "styleSets": { "description": "A list of all styleSets.", "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/StyleSet" + "$ref": "#/definitions/StyleSetListItem" } }, "nextLink": { @@ -355,6 +355,43 @@ } } }, + "StyleSetListItem": { + "description": "Detail information for the data.", + "type": "object", + "properties": { + "id": { + "description": "The unique styleSet id for the styleSet.", + "type": "string", + "readOnly": true + }, + "defaultStyle": { + "description": "The default style used for the style set.", + "type": "string", + "readOnly": true + }, + "version": { + "description": "The version of the style set.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description the caller provided when creating the styleSet. Maximum length 1024 characters.", + "type": "string", + "readOnly": true + }, + "created": { + "description": "The creation date and time of this styleSet.", + "type": "string", + "readOnly": true + }, + "styles": { + "description": "The creation date and time of this styleSet.", + "type": "array", + "readOnly": true, + "items": "object" + } + } + }, "StyleSet": { "description": "Detail information for the data.", "type": "object", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index 2f32e08cc762..1d607e40f4e6 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -276,7 +276,7 @@ } }, "/tilesets/recipes/validate": { - "get": { + "post": { "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to validate a tileset recipe.", "operationId": "Tileset_ValidateRecipe", "x-ms-examples": { @@ -297,7 +297,7 @@ ], "responses": { "200": { - "description": "Validate tileset recipe request completed successfully. The response body contains the validation results.", + "description": "Validate tileset recipe request completed successfully. The response body contains the validation results." }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" @@ -455,7 +455,7 @@ }, "filter": { "description": "Removes features that do not match a pattern.", - "type": "Expression" + "type": "object" } } } From 858c346fec18e2584c6bc415f210400a83264a30 Mon Sep 17 00:00:00 2001 From: Xubin Date: Sun, 12 Dec 2021 23:45:29 -0800 Subject: [PATCH 12/23] more validation errors --- .../examples/tileset/Tileset_Create.json | 30 +++++++++++++++++-- .../tileset/Tileset_ValidateRecipe.json | 27 ++++++++++++++++- .../preview/2022-01-01-preview/style.json | 4 +-- 3 files changed, 55 insertions(+), 6 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json index 76961a7fa13f..b559fa0fd3b0 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json @@ -1,8 +1,32 @@ { "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "[dataset-Id]" + "geography": "us", + "api-version": "2022-01-01-preview", + "datasetId": "[dataset-Id]", + "TilesetRecipe": { + "version": 1, + "layers": { + "Indoor unit": { + "minzoom": 10, + "maxzoom": 18, + "features": { + "featureClasses": [ "unit", "wall" ], + "filter": [ + "any", + [ + "!=", + [ "get", "roomType" ], + "conference" + ], + [ + "!=", + [ "get", "roomType" ], + "restroom" + ] + ] + } + } + } }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json index e2eb9ab2852d..bca8bd08b2ca 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_ValidateRecipe.json @@ -2,7 +2,32 @@ "parameters": { "geography": "us", "api-version": "2022-01-01-preview", - "datasetId": "[datasetId]" + "datasetId": "[datasetId]", + "TilesetRecipe": { + "version": 1, + "layers": { + "Indoor unit": { + "minzoom": 10, + "maxzoom": 18, + "features": { + "featureClasses": [ "unit", "wall" ], + "filter": [ + "any", + [ + "!=", + [ "get", "roomType" ], + "conference" + ], + [ + "!=", + [ "get", "roomType" ], + "restroom" + ] + ] + } + } + } + } }, "responses": { "200": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json index 9708979813dd..da188f299e54 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json @@ -273,10 +273,10 @@ "operationId": "StyleRecipe_GetOperation", "x-ms-examples": { "Get the status of an operation which is still running": { - "$ref": "./examples/stylerecipe/Style_GetOperationStillRunning.json" + "$ref": "./examples/stylerecipe/StyleRecipe_GetOperationStillRunning.json" }, "Get the status of an operation which has finished successfully": { - "$ref": "./examples/stylerecipe/Style_GetOperation.json" + "$ref": "./examples/stylerecipe/StyleRecipe_GetOperation.json" } }, "parameters": [ From 0fad615101b587d07ab39085ae259cfb1ef3878a Mon Sep 17 00:00:00 2001 From: Xubin Date: Sun, 12 Dec 2021 23:47:13 -0800 Subject: [PATCH 13/23] formatting issue --- .../examples/tileset/Tileset_Create.json | 47 ++++++++++--------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json index b559fa0fd3b0..800cf211c421 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json @@ -1,29 +1,30 @@ { "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "[dataset-Id]", - "TilesetRecipe": { - "version": 1, - "layers": { - "Indoor unit": { - "minzoom": 10, - "maxzoom": 18, - "features": { - "featureClasses": [ "unit", "wall" ], - "filter": [ - "any", - [ - "!=", - [ "get", "roomType" ], - "conference" - ], - [ - "!=", - [ "get", "roomType" ], - "restroom" + "geography": "us", + "api-version": "2022-01-01-preview", + "datasetId": "[dataset-Id]", + "TilesetRecipe": { + "version": 1, + "layers": { + "Indoor unit": { + "minzoom": 10, + "maxzoom": 18, + "features": { + "featureClasses": [ "unit", "wall" ], + "filter": [ + "any", + [ + "!=", + [ "get", "roomType" ], + "conference" + ], + [ + "!=", + [ "get", "roomType" ], + "restroom" + ] ] - ] + } } } } From d4c0713c499917f862e39d726c14f9239364c4b6 Mon Sep 17 00:00:00 2001 From: Xubin Date: Tue, 14 Dec 2021 01:15:20 -0800 Subject: [PATCH 14/23] couple fixes --- .../examples/tileset/Tileset_Create.json | 1 + .../preview/2022-01-01-preview/styleset.json | 2 +- .../preview/2022-01-01-preview/tileset.json | 29 ++++++++++++++++++- 3 files changed, 30 insertions(+), 2 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json index 800cf211c421..5847f671f35e 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/tileset/Tileset_Create.json @@ -3,6 +3,7 @@ "geography": "us", "api-version": "2022-01-01-preview", "datasetId": "[dataset-Id]", + "description": "Example description.", "TilesetRecipe": { "version": 1, "layers": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index f991a1080b52..ee4ed81c5da4 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -135,7 +135,7 @@ } }, "paths": { - "styles/stylesets": { + "/styles/stylesets": { "post": { "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe StyleSet Create API allows the caller to create a styleSet from their styleSet configuration file.\n\n## Submit Create Request\n\nTo create your styleset you will make a `POST` request with a styleSet configration file. \n\nThe Create StyleSet API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", "operationId": "StyleSet_Create", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index 1d607e40f4e6..ef5bf56cfdf7 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -297,7 +297,10 @@ ], "responses": { "200": { - "description": "Validate tileset recipe request completed successfully. The response body contains the validation results." + "description": "Validate tileset recipe request completed successfully. The response body contains the validation results.", + "schema": { + "$ref": "#/definitions/TilesetRecipeValidationResult" + } }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" @@ -458,6 +461,30 @@ "type": "object" } } + }, + "TilesetRecipeValidationResult": { + "description": "Tileset recipe validation result.", + "type": "object", + "properties": { + "valid": { + "description": "Validation result.", + "type": "boolean" + }, + "warnings": { + "description": "The list of validation warnings.", + "type": "array", + "items":{ + "type": "string" + } + }, + "errors": { + "description": "The list of validation errors", + "type": "array", + "items":{ + "type": "string" + } + } + } } } } From c370cb9db1c474a23fdcf66e1b8833f39eefd700 Mon Sep 17 00:00:00 2001 From: Xubin Date: Tue, 14 Dec 2021 02:39:18 -0800 Subject: [PATCH 15/23] change tileset request body format --- .../Creator/preview/2022-01-01-preview/tileset.json | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json index ef5bf56cfdf7..a6867833e36e 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/tileset.json @@ -132,7 +132,7 @@ "description": "The custom tileset recipe to use.", "required": false, "schema": { - "type": "json" + "$ref": "#/definitions/TilesetRecipe" } } ], @@ -293,6 +293,15 @@ }, { "$ref": "#/parameters/DatasetIdQuery" + }, + { + "name": "TilesetRecipe", + "in": "body", + "description": "The custom tileset recipe to use.", + "required": false, + "schema": { + "$ref": "#/definitions/TilesetRecipe" + } } ], "responses": { From 2a23a50036bf476b3c684fd58c8865ebb1eb7ba0 Mon Sep 17 00:00:00 2001 From: Xubin Date: Wed, 5 Jan 2022 22:18:11 -0800 Subject: [PATCH 16/23] Change filename --- .../stylerecipe/StyleRecipe_Import.json | 2 +- .../{style.json => stylerecipe.json} | 19 ++++++++++++++----- .../maps/data-plane/Creator/readme.md | 2 +- 3 files changed, 16 insertions(+), 7 deletions(-) rename specification/maps/data-plane/Creator/preview/2022-01-01-preview/{style.json => stylerecipe.json} (89%) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json index 11ffd927e92d..7f4a572fff71 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json @@ -4,7 +4,7 @@ "api-version": "2022-01-01-preview", "styleFormat": "mapbox", "dataFormat": "JSON", - "UploadContent": { + "ImportContent": { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", "version": 1, "created": "2021-05-21T03:04:05.678Z", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json similarity index 89% rename from specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json rename to specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json index da188f299e54..c686cad415ab 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/style.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json @@ -32,7 +32,7 @@ }, "SharedKey": { "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", + "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", "name": "subscription-key", "in": "query" }, @@ -130,7 +130,7 @@ "paths": { "/styles/styleRecipes": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Style Import API allows the caller to import a style recipe from a their style json file.\n\n## Submit Import Request\n\nTo import your style recipe you will make a `POST` request with an azure maps style or mapbox style. \n\nThe Import Style Recipe API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Style Import API allows the caller to import a style recipe from their style json file.\n\n## Submit Import Request\n\nTo import your style recipe you will make a `POST` request with an azure maps style or mapbox style. \n\nThe Import Style Recipe API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", "operationId": "StyleRecipe_Import", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -156,6 +156,15 @@ }, { "$ref": "#/parameters/DescriptionStyle" + }, + { + "name": "ImportContent", + "in": "body", + "description": "The style recipe content to be imported.", + "required": true, + "schema": { + "type": "object" + } } ], "responses": { @@ -205,7 +214,7 @@ }, "/styles/styleRecipes/{styleRecipeId}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a style.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to export a style recipe.", "operationId": "StyleRecipe_Export", "x-ms-examples": { "Exports the details for a single style recipe": { @@ -239,10 +248,10 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a imported style.
\nYou can use this API if a style is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `styleId` of the style to delete.
\n\n#### Delete request \"Successful\"\n\nThe Style Delete API returns a HTTP `204 No Content` response with an empty body, if the style was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style with the passed-in `styleId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - Style Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete an imported style recipe.
\nYou can use this API if a style recipe is no longer needed. \n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `styleRecipeId` of the style recipe to delete.
\n\n#### Delete request \"Successful\"\n\nThe Style Recipe Delete API returns a HTTP `204 No Content` response with an empty body, if the style recipe was deleted successfully.
\n\n#### Delete request \"Failed\"\n\nA HTTP `400 Bad Request` error response will be returned if the style recipe with the passed-in `styleRecipeId` is not found. \n\nHere is a sample error response:\n\n
\n\n```json\n{\n \"error\": {\n \"code\": \"400 BadRequest\",\n \"message\": \"Bad request - StyleRecipe Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist.\"\n }\n}\n```", "operationId": "StyleRecipe_Delete", "x-ms-examples": { - "Delete a imported style recipe": { + "Delete an imported style recipe": { "$ref": "./examples/stylerecipe/StyleRecipe_Delete.json" } }, diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md index b91622228268..7aa95e6a1689 100644 --- a/specification/maps/data-plane/Creator/readme.md +++ b/specification/maps/data-plane/Creator/readme.md @@ -47,7 +47,7 @@ input-file: - preview/2022-01-01-preview/featurestate.json - preview/2022-01-01-preview/tileset.json - preview/2022-01-01-preview/wfs.json - - preview/2022-01-01-preview/style.json + - preview/2022-01-01-preview/stylerecipe.json - preview/2022-01-01-preview/styleset.json ``` ### Tag: 2.0-preview From ff86cfb3f73e7d6fb61bcc3e69e294a9db8102e4 Mon Sep 17 00:00:00 2001 From: Xubin Date: Wed, 5 Jan 2022 23:37:07 -0800 Subject: [PATCH 17/23] Remove unchanged API specs --- .../preview/2022-01-01-preview/alias.json | 312 ------- .../preview/2022-01-01-preview/data.json | 471 ----------- .../preview/2022-01-01-preview/dataset.json | 353 -------- .../2022-01-01-preview/dwgconversion.json | 351 -------- .../examples/alias/Alias_Assign.json | 18 - .../examples/alias/Alias_Create.json | 17 - .../examples/alias/Alias_Delete.json | 10 - .../examples/alias/Alias_Get.json | 17 - .../examples/alias/Alias_List.json | 26 - .../conversion/Conversion_Conversion.json | 26 - .../conversion/Conversion_Delete.json | 10 - .../examples/conversion/Conversion_Get.json | 26 - .../conversion/Conversion_GetOperation.json | 33 - .../Conversion_GetOperationStillRunning.json | 16 - .../examples/conversion/Conversion_List.json | 44 - .../examples/data/Data_Delete.json | 10 - .../examples/data/Data_Download.json | 12 - .../examples/data/Data_GetOperation.json | 19 - .../data/Data_GetOperationStillRunning.json | 16 - .../examples/data/Data_List.json | 32 - .../examples/data/Data_Update.json | 53 -- .../examples/data/Data_Upload.json | 53 -- .../examples/dataset/Dataset_Create.json | 25 - .../examples/dataset/Dataset_Delete.json | 10 - .../examples/dataset/Dataset_GetDetails.json | 39 - .../dataset/Dataset_GetOperation.json | 19 - .../Dataset_GetOperationStillRunning.json | 16 - .../examples/dataset/Dataset_List.json | 57 -- .../Featurestate_CreateStateset.json | 72 -- .../Featurestate_DeleteFeatureState.json | 12 - .../Featurestate_DeleteStateset.json | 10 - .../Featurestate_GetStateset.json | 73 -- .../featurestate/Featurestate_List.json | 77 -- .../featurestate/Featurestate_ListStates.json | 21 - .../Featurestate_UpdateStates.json | 20 - .../Featurestate_UpdateStateset.json | 56 -- .../examples/wfs/WFS_DeleteFeature.json | 12 - .../examples/wfs/WFS_GetCollection.json | 34 - .../wfs/WFS_GetCollectionDefinition.json | 152 ---- .../examples/wfs/WFS_GetCollections.json | 253 ------ .../examples/wfs/WFS_GetFeature.json | 84 -- .../examples/wfs/WFS_GetFeatures.json | 93 --- .../examples/wfs/WFS_GetLandingPage.json | 41 - .../examples/wfs/WFS_ListConformance.json | 19 - .../2022-01-01-preview/featurestate.json | 694 ---------------- .../2022-01-01-preview/stylerecipe.json | 48 +- .../preview/2022-01-01-preview/wfs.json | 772 ------------------ .../maps/data-plane/Creator/readme.md | 6 - 48 files changed, 36 insertions(+), 4604 deletions(-) delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json delete mode 100644 specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json deleted file mode 100644 index b9e926f7000b..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/alias.json +++ /dev/null @@ -1,312 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Alias Service", - "version": "2022-01-01-preview", - "description": "APIs for managing aliases in Azure Maps." - }, - "schemes": [ - "https" - ], - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "2022-01-01-preview", - "x-ms-parameter-location": "client" - }, - "CreateCreatorDataItemId": { - "name": "creatorDataItemId", - "description": "The unique id that references a creator data item to be aliased.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "AssignCreatorDataItemId": { - "name": "creatorDataItemId", - "description": "The unique id that references a creator data item to be aliased.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "AliasId": { - "name": "aliasId", - "description": "The unique id that references an existing alias.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/aliases": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to create an alias. You can also assign the alias during the create request. An alias can reference an ID generated by a creator service, but cannot reference another alias ID.\n\n### Submit Create Request\n\nTo create your alias, you will use a `POST` request. If you would like to assign the alias during the creation, you will pass the `resourceId` query parameter.\n\n### Create Alias Response\n\nThe Create API returns a HTTP `201 Created` response with the alias resource in the body.\n\nA sample response from creating an alias:\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", - "operationId": "Alias_Create", - "x-ms-examples": { - "Create an alias that does not reference any resource": { - "$ref": "./examples/alias/Alias_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/CreateCreatorDataItemId" - } - ], - "responses": { - "201": { - "description": "Content created successfully. The response body contains the newly created alias id `aliasId`.", - "schema": { - "$ref": "#/definitions/Alias" - }, - "headers": { - "Access-Control-Expose-Headers": { - "type": "string", - "description": "The list of response headers that can be read by the client." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created aliases.\n\n### Submit List Request\n\nTo list all your aliases, you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe List API returns the complete list of all aliases in `json` format. The response contains the following details for each alias resource:\n > createdTimestamp - The timestamp that the alias was created. Format yyyy-MM-ddTHH:mm:ss.sssZ\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource. Format yyyy-MM-ddTHH:mm:ss.sssZ\n\nA sample response returning 2 alias resources:\n\n```json\n{\n \"aliases\": [\n {\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n },\n {\n \"createdTimestamp\": \"2020-02-18T19:53:33.123Z\",\n \"aliasId\": \"1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6\",\n \"creatorDataItemId\": null,\n \"lastUpdatedTimestamp\": \"2020-02-18T19:53:33.123Z\"\n }\n ]\n}\n```", - "operationId": "Alias_List", - "x-ms-examples": { - "List all the previously created aliases": { - "$ref": "./examples/alias/Alias_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "aliases", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List alias request completed successfully. The response body contains a list of all the previously created aliases.", - "schema": { - "$ref": "#/definitions/AliasListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/aliases/{aliasId}": { - "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to assign an alias to reference a resource.\n\n### Submit Assign Request\n\nTo assign your alias to a resource, you will use a `PUT` request with the `aliasId` in the path and the `creatorDataItemId` passed as a query parameter.\n\n### Assign Alias Response\n\nThe Assign API returns a HTTP `200 OK` response with the updated alias resource in the body, if the alias was assigned successfully. A sample of the assign response is\n\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", - "operationId": "Alias_Assign", - "x-ms-examples": { - "Assign an alias to a resource": { - "$ref": "./examples/alias/Alias_Assign.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/AliasId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/AssignCreatorDataItemId" - } - ], - "responses": { - "200": { - "description": "Alias was assigned successfully.", - "schema": { - "$ref": "#/definitions/Alias" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete a previously created alias. You can also use this API to delete old/unused aliases to create space for new content.This API does not delete the references resource, only the alias referencing the resource.\n\n### Submit Delete Request\n\nTo delete your alias you will issue a `DELETE` request where the path will contain the `aliasId` of the alias to delete.\n\n### Delete Alias Response\n\nThe Delete API returns a HTTP `204 No Content` response with an empty body, if the alias was deleted successfully.", - "operationId": "Alias_Delete", - "x-ms-examples": { - "Delete previously created alias": { - "$ref": "./examples/alias/Alias_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/AliasId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "204": { - "description": "Alias delete request completed successfully. The content for `aliasId` was deleted on the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch the details of a previously created alias.\n\n### Submit Get Details Request\n\nTo get the details of your alias, you will issue a `GET` request with the `aliasId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the previously created alias in `json` format. The response contains the following details for the alias resource:\n > createdTimestamp - The timestamp that the alias was created.\n > aliasId - The id for the alias.\n > creatorDataItemId - The id for the creator data item that this alias references (could be null if the alias has not been assigned).\n > lastUpdatedTimestamp - The last time the alias was assigned to a resource.\n\nHere's a sample response:\n```json\n{\n \"createdTimestamp\": \"2020-02-13T21:19:11.123Z\",\n \"aliasId\": \"a8a4b8bb-ecf4-fb27-a618-f41721552766\",\n \"creatorDataItemId\": \"e89aebb9-70a3-8fe1-32bb-1fbd0c725f14\",\n \"lastUpdatedTimestamp\": \"2020-02-13T21:19:22.123Z\"\n}\n```", - "operationId": "Alias_Get", - "x-ms-examples": { - "Get a previously created alias": { - "$ref": "./examples/alias/Alias_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/AliasId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "Get alias request completed successfully. The response body contains the previously created alias.", - "schema": { - "$ref": "#/definitions/Alias" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "AliasListResult": { - "description": "The response model for the List API. Returns a list of all the previously created aliases.", - "type": "object", - "properties": { - "aliases": { - "description": "A list of all the previously created aliases.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Alias" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "Alias": { - "description": "Detailed information for the alias.", - "type": "object", - "properties": { - "createdTimestamp": { - "description": "The created timestamp for the alias.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "aliasId": { - "description": "The id for the alias.", - "type": "string", - "readOnly": true - }, - "creatorDataItemId": { - "description": "The id for the creator data item that this alias references (could be null if the alias has not been assigned).", - "type": "string", - "x-nullable": true, - "readOnly": true - }, - "lastUpdatedTimestamp": { - "description": "The timestamp of the last time the alias was assigned.", - "type": "string", - "format": "date-time", - "readOnly": true - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json deleted file mode 100644 index 17ba723ca5a1..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/data.json +++ /dev/null @@ -1,471 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Data Service", - "version": "2022-01-01-preview", - "description": "APIs for uploading map data to Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "2022-01-01-preview", - "x-ms-parameter-location": "client" - }, - "DataFormat": { - "name": "dataFormat", - "description": "Data format of the content being uploaded.", - "type": "string", - "in": "query", - "required": true, - "enum": [ - "geojson", - "zip", - "dwgzippackage" - ], - "x-ms-enum": { - "name": "DataFormat", - "modelAsString": true, - "values": [ - { - "value": "geojson", - "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." - }, - { - "value": "zip", - "description": "Compressed data format." - }, - { - "name": "dwgZipPackage", - "value": "dwgzippackage", - "description": "ZIP package containing DWG file." - } - ] - }, - "x-ms-parameter-location": "method" - }, - "UniqueDataId": { - "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "UploadDataDescription": { - "name": "description", - "description": "The description to be given to the upload.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "DataUploadOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the data upload request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/mapData": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", - "operationId": "Data_Upload", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Upload GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/data/Data_Upload.json" - } - }, - "consumes": [ - "application/json", - "application/octet-stream" - ], - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/UploadDataDescription" - }, - { - "$ref": "#/parameters/DataFormat" - }, - { - "name": "UploadContent", - "in": "body", - "description": "The content to upload.", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "409": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview). \n\n\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
", - "operationId": "Data_List", - "x-ms-examples": { - "List all the previously uploaded data": { - "$ref": "./examples/data/Data_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "List data request completed successfully. The response body contains a list of all the previously uploaded data.", - "schema": { - "$ref": "#/definitions/MapDataListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/mapData/{udid}": { - "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \n[long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", - "operationId": "Data_Update", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Update previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/data/Data_Update.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/UniqueDataId" - }, - { - "$ref": "#/parameters/UploadDataDescription" - }, - { - "name": "UpdateContent", - "in": "body", - "description": "The new content that will update/replace the previously uploaded content.", - "required": true, - "schema": { - "type": "object" - } - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "409": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/409StorageLimit" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", - "operationId": "Data_Download", - "x-ms-examples": { - "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/data/Data_Download.json" - } - }, - "produces": [ - "application/json", - "application/vnd.geo+json", - "application/octet-stream" - ], - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/UniqueDataId" - } - ], - "responses": { - "200": { - "description": "Data download request completed successfully. The response body will contain the content for the passed in `udid`.", - "schema": { - "type": "file" - }, - "headers": { - "Content-Type": { - "type": "string", - "description": "The content-type for the Download API response." - } - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", - "operationId": "Data_Delete", - "x-ms-examples": { - "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { - "$ref": "./examples/data/Data_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/UniqueDataId" - } - ], - "responses": { - "204": { - "description": "Data delete request completed successfully. The content for `udid` was deleted on the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/mapData/operations/{operationId}": { - "get": { - "description": "This path will be obtained from a call to POST /mapData. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once completed.", - "operationId": "Data_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/data/Data_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/data/Data_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DataUploadOperationId" - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "MapDataListResult": { - "description": "The response model for the Data List API. Returns a list of all the previously uploaded data.", - "type": "object", - "properties": { - "mapDataList": { - "description": "A list of all the previously uploaded data.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/MapData" - } - } - } - }, - "DataFormat": { - "description": "Data format of the uploaded content.", - "type": "string", - "readOnly": true, - "enum": [ - "geojson", - "zip", - "dwgzippackage" - ], - "x-ms-enum": { - "name": "DataFormat", - "modelAsString": true, - "values": [ - { - "value": "geojson", - "description": "[GeoJSON](https://tools.ietf.org/html/rfc7946) is a JSON based geospatial data interchange format." - }, - { - "value": "zip", - "description": "Compressed data format." - }, - { - "name": "dwgZipPackage", - "value": "dwgzippackage", - "description": "ZIP package containing DWG file." - } - ] - } - }, - "UploadStatus": { - "description": "The current upload status of the content.", - "type": "string", - "readOnly": true, - "enum": [ - "Pending", - "Completed", - "Failed" - ], - "x-ms-enum": { - "name": "UploadStatus", - "values": [ - { - "value": "Pending", - "description": "Upload is processing" - }, - { - "value": "Completed", - "description": "Upload validation and processing completed" - }, - { - "value": "Failed", - "description": "Upload validation and/or processing failure" - } - ] - } - }, - "MapData": { - "description": "Detail information for the data.", - "type": "object", - "properties": { - "udid": { - "description": "The unique data id for the data.", - "type": "string", - "readOnly": true - }, - "location": { - "x-ms-client-name": "locationURL", - "description": "The location of the data. Execute a HTTP `GET` on this location to download the data.", - "type": "string", - "format": "uri", - "readOnly": true - }, - "sizeInBytes": { - "description": "The size of the content in bytes.", - "type": "integer", - "format": "int64", - "readOnly": true - }, - "uploadStatus": { - "$ref": "#/definitions/UploadStatus" - }, - "dataFormat": { - "$ref": "#/definitions/DataFormat" - }, - "description": { - "description": "The current description.", - "type": "string", - "readOnly": true - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json deleted file mode 100644 index 352f270e6580..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dataset.json +++ /dev/null @@ -1,353 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Dataset Service", - "version": "2022-01-01-preview", - "description": "APIs for managing datasets from uploaded data in Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "2022-01-01-preview", - "x-ms-parameter-location": "client" - }, - "ConversionIdQuery": { - "name": "conversionId", - "description": "The unique ID used to create the dataset. The `conversionId` must have been obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "DatasetDescription": { - "name": "description", - "description": "The description to be given to the dataset.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "DatasetId": { - "name": "datasetId", - "type": "string", - "in": "path", - "description": "The identifier for the dataset to query from.", - "required": true, - "x-ms-parameter-location": "method" - }, - "AppendDatasetId": { - "name": "datasetId", - "type": "string", - "in": "query", - "description": "The ID for the dataset to append with. The dataset must originate from a previous dataset creation call that matches the datasetId", - "x-ms-parameter-location": "method" - }, - "DatasetOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the dataset create/import request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/datasets": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to create a dataset from data that was uploaded to the Azure Maps Data Service and converted using the Azure Maps Conversion Service.\n\nYou can use this API in a scenario like uploading a DWG zip package for a building, converting the zip package using the Azure Maps Conversion Service, and creating a dataset from the converted zip package. The created dataset can be used to create tilesets using the Azure Maps Tileset Service and can be queried via the Azure Maps WFS Service.\n\n### Submit Create Request\n\nTo create your dataset, you will use a `POST` request where the `conversionId` query parameter is an ID that represents the converted DWG zip package, the `datasetId` parameter will be the ID of a previously created dataset to append with the current dataset and, optionally, the `description` query parameter will contain a description (if description is not provided a default description will be given).\n\nThe Create API is a [long-running request](https://aka.ms/am-creator-lrt-v2).", - "operationId": "Dataset_Create", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Create dataset from a converted CAD file provided by conversionId": { - "$ref": "./examples/dataset/Dataset_Create.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionIdQuery" - }, - { - "$ref": "#/parameters/AppendDatasetId" - }, - { - "$ref": "#/parameters/DatasetDescription" - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all previously successfully created datasets.\n\n### Submit List Request\n\nTo list all your datasets, you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe List API returns the complete list of all datasets in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of 3 dataset resources:\n\n\n```json\n{\n \"datasets\": [\n {\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ], },\n \"\": \"facility-2022-01-01-preview\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n },\n {\n \"timestamp\": \"2020-01-01T22:57:53.123Z\",\n \"datasetId\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"description\": \"Create from upload '0c1288fa-2058-4a1b-b68d-13a5f5af7d7c'.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"0c1288fa-2058-4a1b-b68d-13a5f5af7d7c\"\n ],\n \"appendDatasetId\": \"46d1edb6-d29e-4786-9589-dbd4efd7a977\"\n },\n \"ontology\": \"facility-2022-01-01-preview\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n ]\n}\n```", - "operationId": "Dataset_List", - "x-ms-examples": { - "List all the previously created datasets": { - "$ref": "./examples/dataset/Dataset_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "datasets", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "The dataset request completed successfully. The response body contains the previously created dataset.", - "schema": { - "$ref": "#/definitions/DatasetListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/datasets/{datasetId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a previously successfully created dataset.\n\n### Submit Get Details Request\n\nTo get the details for a previously created dataset, you will issue a `GET` request with the `datasetId` in the path.\n\n### Get Details Response\n\nThe Get Details API returns the details for a dataset in `json` format. The response contains the following fields (if they are not null or empty):\n> created - The timestamp the dataset was created.\n> datasetId - The id for the dataset.\n> description - The description for the dataset.\n> datasetSources - The source data that was used when the create request was issued.\n> ontology - The source [ontology](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) that was used in the conversion service for the input data.
\n\nThe `datasetSources` describes the source data that was used when the create request was issued and contains the following elements (if they are not null or empty):\n> conversionIds - The list of `conversionId` (null if none were provided).\n> appendDatasetId - The `datasetId` that was used for an append operation (null if none was used).\n>featureCounts - The counts for each feature type in the dataset.
\n\nHere's a sample response returning the `timestamp`, `datasetId`, `description`, `datasetSources`, and `ontology` of a dataset resource:\n\n```json\n{\n \"timestamp\": \"2020-01-01T22:50:48.123Z\",\n \"datasetId\": \"f6495f62-94f8-0ec2-c252-45626f82fcb2\",\n \"description\": \"Some description or comment for the dataset.\",\n \"datasetSources\": {\n \"conversionIds\": [\n \"15d21452-c9bb-27b6-5e79-743ca5c3205d\"\n ],\n },\n \"ontology\": \"facility-2022-01-01-preview\",\n \"featureCounts\": {\n \"directoryInfo\": 2,\n \"category\": 10,\n \"facility\": 1,\n \"level\": 3,\n \"unit\": 183,\n \"zone\": 3,\n \"verticalPenetration\": 6,\n \"opening\": 48,\n \"areaElement\": 108\n }\n }\n```", - "operationId": "Dataset_Get", - "x-ms-examples": { - "Get details for a previously created dataset": { - "$ref": "./examples/dataset/Dataset_GetDetails.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "responses": { - "200": { - "description": "The get dataset request completed successfully.", - "schema": { - "$ref": "#/definitions/Dataset" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nYou can also use this API to delete old/unused datasets to create space for new Creator content.\n\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `datasetId` of the dataset to delete.", - "operationId": "Dataset_Delete", - "x-ms-examples": { - "Delete previously created dataset": { - "$ref": "./examples/dataset/Dataset_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetId" - } - ], - "responses": { - "204": { - "description": "The dataset delete request completed successfully. The resource referenced by the `datasetId` was deleted from the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/datasets/operations/{operationId}": { - "get": { - "description": "This API allows the caller to view the current progress of a dataset operation and the path is obtained from a call to the Create API.\n\n### Submit Operations Request\n\nTo view the current progress of a dataset operation, you will use a `GET` request where the `operationId` given the path is the ID that represents the operation.\n\n### Operation Response\n\nWhile in progress, a `200-OK` http status code will be returned with no extra headers. If the operation succeeds, a `200-OK` http status code with Resource-Location header will be returned.", - "operationId": "Dataset_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/dataset/Dataset_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully": { - "$ref": "./examples/dataset/Dataset_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetOperationId" - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "DatasetListResult": { - "description": "The response model for the Dataset List API. The response body will contain a list of all the previously created datasets.", - "type": "object", - "properties": { - "datasets": { - "description": "A list of all the previously created datasets.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Dataset" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "Dataset": { - "description": "Detail information for the dataset.", - "type": "object", - "properties": { - "created": { - "description": "The created timestamp for the dataset.", - "type": "string", - "format": "date-time", - "readOnly": true - }, - "datasetId": { - "description": "The id for the dataset.", - "type": "string", - "readOnly": true - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "description": { - "description": "The description for the dataset.", - "type": "string", - "readOnly": true - }, - "datasetSources": { - "$ref": "#/definitions/DatasetSources" - }, - "featureCounts": { - "description": "The feature counts for the dataset.", - "type": "object", - "readOnly": true - } - } - }, - "DatasetSources": { - "description": "Information about the details of the create request for the dataset.", - "type": "object", - "properties": { - "conversionIds": { - "description": "The list of `conversionId` that were used to create the dataset.", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "appendDatasetId": { - "description": "The dataset that was appended to to create the current dataset.", - "type": "string", - "readOnly": true - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json deleted file mode 100644 index c8dedc7933a3..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/dwgconversion.json +++ /dev/null @@ -1,351 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Conversion Service", - "version": "2022-01-01-preview", - "description": "APIs for converting DWG Packages in Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "2022-01-01-preview", - "x-ms-parameter-location": "client" - }, - "UdidQuery": { - "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "ConversionId": { - "name": "conversionId", - "description": "The conversion id for the content. The `conversionId` must have been obtained from a successful [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert) call.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "OutputOntology": { - "name": "outputOntology", - "description": "Output ontology version. \"facility-2022-01-01-preview\" is the only supported value at this time. Please refer to this [article](https://docs.microsoft.com/en-us/azure/azure-maps/creator-facility-ontology) for more information about Azure Maps Creator ontologies.", - "type": "string", - "in": "query", - "required": true, - "enum": [ - "facility-2022-01-01-preview" - ], - "x-ms-enum": { - "name": "OutputOntology", - "modelAsString": true, - "values": [ - { - "value": "facility-2022-01-01-preview", - "description": "Facility ontology defines how Azure Maps Creator internally stores facility data in a Creator dataset." - } - ] - }, - "x-ms-client-default": "facility-2022-01-01-preview", - "x-ms-parameter-location": "method" - }, - "DescriptionDwgConversion": { - "name": "description", - "description": "User provided description of the content being converted.", - "type": "string", - "in": "query", - "x-ms-parameter-location": "method" - }, - "ConversionOperationId": { - "name": "operationId", - "type": "string", - "in": "path", - "description": "The ID to query the status for the Conversion create/import request.", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/conversions": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Conversion API lets the caller import a set of DWG design files as a zipped [Drawing Package](https://aka.ms/am-drawing-package) into Azure Maps. The [Drawing Package](https://aka.ms/am-drawing-package) should first be uploaded using the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data). Once uploaded, use the `udid` returned by the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview) to call this Conversion API.\n\n## Convert DWG package\n\nThe Conversion API performs a [long-running request](https://aka.ms/am-creator-lrt-v2).\n\n## Debug DWG package issues\n\n\nDuring the Conversion process, if there are any issues with the DWG package [errors and warnings](https://aka.ms/am-conversion-errors) are provided in the response along with a *diagnostic package* to visualize and diagnose these issues. In case any issues are encountered with your DWG package, the Conversion operation status process as detailed [here](https://aka.ms/am-creator-lrt-v2) returns the location of the *diagnostic package* that can be downloaded by the caller to help them visualize and diagnose these issues. The *diagnostic package* location can be found in the properties section of the conversion operation status response and looks like the following:\n\n```json\n{\n \"properties\": {\n \"diagnosticPackageLocation\": \"https://us.atlas.microsoft.com/mapdata/{DiagnosticPackageId}?api-version=1.0\" \n } \n}\n```\n\nThe *diagnostic package* can be downloaded by executing a `HTTP GET` request on the `diagnosticPackageLocation`.\nFor more details on how to use the tool to visualize and diagnose all the errors and warnings see [Drawing Error Visualizer](https://aka.ms/am-drawing-errors-visualizer).
\n\nA conversion operation will be marked as *success* if there are zero or more warnings but will be marked as *failed* if any errors are encountered. ", - "operationId": "Conversion_Convert", - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Convert previously uploaded DWG Package": { - "$ref": "./examples/conversion/Conversion_Conversion.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/UdidQuery" - }, - { - "$ref": "#/parameters/OutputOntology" - }, - { - "$ref": "#/parameters/DescriptionDwgConversion" - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "202": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/202AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a list of all successful data conversions submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). \n\n### Submit List Request\n\nTo list all successful conversions you will issue a `GET` request with no additional parameters.\n\n### List Data Response\n\nThe Conversion List API returns the complete list of all conversion details in `json` format.
\n\nHere is a sample response returning the details of two successful conversion requests: \n\n
\n\n```json\n{\n \"conversions\": \n [\n {\n \"conversionId\": \"54398242-ea6c-1f31-4fa6-79b1ae0fc24d\",\n \"udid\": \"31838736-8b84-11ea-bc55-0242ac130003\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n },\n {\n \"conversionId\": \"2acf7d32-8b84-11ea-bc55-0242ac130003\",\n \"udid\": \"1214bc58-8b84-11ea-bc55-0242ac1300039\",\n \"created\": \"5/19/2020 9:00:00 AM +00:00\",\n \"description\": \"User provided description.\",\n \"featureCounts\": {\n \"DIR\": 1,\n \"LVL\": 3,\n \"FCL\": 1,\n \"UNIT\": 150,\n \"CTG\": 8,\n \"AEL\": 0,\n \"OPN\": 10\n }\n }\n ]\n}\n```\n\n
", - "operationId": "Conversion_List", - "x-ms-examples": { - "Returns a list of all the data processed by the Conversion Service for the account": { - "$ref": "./examples/conversion/Conversion_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "conversions", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "List request completed successfully.", - "schema": { - "$ref": "#/definitions/ConversionListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/conversions/{conversionId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to fetch a successful data conversion submitted previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert). ", - "operationId": "Conversion_Get", - "x-ms-examples": { - "Get the details for one conversion operation": { - "$ref": "./examples/conversion/Conversion_Get.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionId" - } - ], - "responses": { - "200": { - "description": "Returns details of the specified conversion.", - "schema": { - "$ref": "#/definitions/Conversion" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to delete any data conversions created previously using the [Conversion API](https://docs.microsoft.com/en-us/rest/api/maps/v2/conversion/convert).\n\n### Submit Delete Request\n\nTo delete your conversion data you will issue a `DELETE` request where the path will contain the `conversionId` of the data to delete.\n\n### Conversion Delete Response\n\nThe Conversion Delete API returns a HTTP `204 No Content` response with an empty body, if the converted data resources were deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if no resource associated with the passed-in `conversionId` is found. ", - "operationId": "Conversion_Delete", - "x-ms-examples": { - "Delete previously converted content": { - "$ref": "./examples/conversion/Conversion_Delete.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionId" - } - ], - "responses": { - "204": { - "description": "Conversion delete request completed successfully. The content for `conversionId` was deleted on the server." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/conversions/operations/{operationId}": { - "get": { - "description": "This path will be obtained from a call to POST /conversions. While in progress, an http200 will be returned with no extra headers - followed by an http200 with Resource-Location header once successfully completed.", - "operationId": "Conversion_GetOperation", - "x-ms-examples": { - "Get the status of an operation which is still running": { - "$ref": "./examples/conversion/Conversion_GetOperationStillRunning.json" - }, - "Get the status of an operation which has finished successfully, with non-fatal warnings": { - "$ref": "./examples/conversion/Conversion_GetOperation.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/ConversionOperationId" - } - ], - "responses": { - "200": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/200AsyncV2" - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "ConversionListResult": { - "description": "The response model for the Conversion List API.", - "type": "object", - "properties": { - "conversions": { - "description": "A list of all the previously submitted conversion requests.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Conversion" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "Conversion": { - "description": "Detail information for the conversion requests.", - "type": "object", - "properties": { - "conversionId": { - "description": "A unique id that represents the artifact of a _successfully_ completed conversion process.", - "type": "string", - "readOnly": true - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "udid": { - "description": "The unique id of the content provided to create this conversion.", - "type": "string", - "readOnly": true - }, - "created": { - "description": "The date and time of this conversion.", - "type": "string", - "readOnly": true - }, - "description": { - "description": "User provided description of the content being converted.", - "type": "string", - "readOnly": true - }, - "featureCounts": { - "description": "A summary of feature counts in this conversion.", - "additionalProperties": { - "type": "integer", - "format": "int64" - }, - "type": "object", - "readOnly": true - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json deleted file mode 100644 index 4a5de37f6ab3..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Assign.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "aliasId": "[aliasId]", - "creatorDataItemId": "[creatorDataItemId]" - }, - "responses": { - "200": { - "body": { - "createdTimestamp": "2021-05-01T01:02:03.456Z", - "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012", - "creatorDataItemId": "633a009a-dfa2-4d51-a419-420122e11c94", - "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json deleted file mode 100644 index ce991eb9ef45..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Create.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview" - }, - "responses": { - "201": { - "headers": {}, - "body": { - "createdTimestamp": "2021-05-01T01:02:03.456Z", - "aliasId": "25084fb7-307a-4720-8f91-7952a0b91012", - "creatorDataItemId": null, - "lastUpdatedTimestamp": "2021-05-01T01:02:03.456Z" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json deleted file mode 100644 index 9421cf14a2ed..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "aliasId": "[aliasId]" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json deleted file mode 100644 index 6058f7a23d53..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_Get.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "aliasId": "[aliasId]" - }, - "responses": { - "200": { - "body": { - "createdTimestamp": "2020-02-13T21:19:11+00:00", - "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", - "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", - "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json deleted file mode 100644 index b47f6d0aab52..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/alias/Alias_List.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview" - }, - "responses": { - "200": { - "body": { - "aliases": [ - { - "createdTimestamp": "2020-02-13T21:19:11+00:00", - "aliasId": "a8a4b8bb-ecf4-fb27-a618-f41721552766", - "creatorDataItemId": "e89aebb9-70a3-8fe1-32bb-1fbd0c725f14", - "lastUpdatedTimestamp": "2020-02-13T21:19:22+00:00" - }, - { - "createdTimestamp": "2020-02-13T21:19:11+00:00", - "aliasId": "1856dbfc-7a66-ee5a-bf8d-51dbfe1906f6", - "creatorDataItemId": null, - "lastUpdatedTimestamp": "2020-02-13T21:19:11+00:00" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json deleted file mode 100644 index be2ac477847e..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Conversion.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "udid": "25084fb7-307a-4720-8f91-7952a0b91012", - "outputOntology": "facility-2022-01-01-preview" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded" - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - }, - "202": { - "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/conversions/operations/{operationId}?api-version=2022-01-01-preview", - "Access-Control-Expose-Headers": "Operation-Location" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json deleted file mode 100644 index ba939b309cdc..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "conversionId": "99884fb7-87a9-0920-7f93-7952a0b91012" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json deleted file mode 100644 index b8b395859c7d..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_Get.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d" - }, - "responses": { - "200": { - "body": { - "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", - "udid": "31838736-8b84-11ea-bc55-0242ac130003", - "created": "5/19/2020 9:00:00 AM +00:00", - "description": "User provided description.", - "featureCounts": { - "directoryInfo": 1, - "level": 3, - "facility": 1, - "unit": 150, - "category": 8, - "areaElement": 0, - "opening": 10 - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json deleted file mode 100644 index 017a2c1c8e8f..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperation.json +++ /dev/null @@ -1,33 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded", - "warning": { - "code": "dwgConversionProblem", - "details": [ - { - "code": "warning", - "details": [ - { - "code": "manifestWarning", - "message": "Ignoring unexpected JSON property: unitProperties[0].nonWheelchairAccessible with value False" - } - ] - } - ] - } - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/conversions/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json deleted file mode 100644 index 245506ef8536..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_GetOperationStillRunning.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-23T19:14:03.2452596+00:00", - "status": "Running" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json deleted file mode 100644 index 628648a80d23..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/conversion/Conversion_List.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview" - }, - "responses": { - "200": { - "body": { - "conversions": [ - { - "conversionId": "54398242-ea6c-1f31-4fa6-79b1ae0fc24d", - "udid": "31838736-8b84-11ea-bc55-0242ac130003", - "created": "5/19/2020 9:00:00 AM +00:00", - "description": "User provided description.", - "featureCounts": { - "directoryInfo": 1, - "level": 3, - "facility": 1, - "unit": 150, - "category": 8, - "areaElement": 0, - "opening": 10 - } - }, - { - "conversionId": "2acf7d32-8b84-11ea-bc55-0242ac130003", - "udid": "1214bc58-8b84-11ea-bc55-0242ac1300039", - "created": "5/19/2020 9:00:00 AM +00:00", - "description": "User provided description.", - "featureCounts": { - "directoryInfo": 1, - "level": 3, - "facility": 1, - "unit": 150, - "category": 8, - "areaElement": 0, - "opening": 10 - } - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json deleted file mode 100644 index 0dc5569ca805..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "udid": "25084fb7-307a-4720-8f91-7952a0b91012" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json deleted file mode 100644 index 834587cd4130..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Download.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "udid": "25084fb7-307a-4720-8f91-7952a0b91012" - }, - "responses": { - "200": { - "body": "{file}" - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json deleted file mode 100644 index f65e31a4b034..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperation.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded" - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json deleted file mode 100644 index 245506ef8536..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_GetOperationStillRunning.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-23T19:14:03.2452596+00:00", - "status": "Running" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json deleted file mode 100644 index 626f163f94af..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_List.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview" - }, - "responses": { - "200": { - "body": { - "mapDataList": [ - { - "udid": "f6495f62-94f8-0ec2-c252-45626f82fcb2", - "location": "https://us.atlas.microsoft.com/mapData/f6495f62-94f8-0ec2-c252-45626f82fcb2?api-version=1.0", - "sizeInBytes": 29920, - "uploadStatus": "Completed" - }, - { - "udid": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "location": "https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0", - "sizeInBytes": 1339, - "uploadStatus": "Completed" - }, - { - "udid": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", - "location": "https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0", - "sizeInBytes": 1650, - "uploadStatus": "Pending" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json deleted file mode 100644 index a13d8458d634..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Update.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "udid": "25084fb7-307a-4720-8f91-7952a0b91012", - "UpdateContent": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "geometry": { - "type": "Point", - "coordinates": [ - -122.126986, - 47.639754 - ] - }, - "properties": { - "geometryId": "001", - "radius": 500 - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded" - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - }, - "202": { - "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{operationId}?api-version=1.0", - "Access-Control-Expose-Headers": "Operation-Location" - } - }, - "409": { - "headers": {}, - "body": { - "error": { - "code": "409 Conflict", - "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads." - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json deleted file mode 100644 index e9e43fa86368..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/data/Data_Upload.json +++ /dev/null @@ -1,53 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "dataFormat": "geojson", - "UploadContent": { - "type": "FeatureCollection", - "features": [ - { - "type": "Feature", - "geometry": { - "type": "Point", - "coordinates": [ - -122.126986, - 47.639754 - ] - }, - "properties": { - "geometryId": "001", - "radius": 500 - } - } - ] - } - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded" - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/mapData/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - }, - "202": { - "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/mapData/operations/{udid}?api-version=2022-01-01-preview", - "Access-Control-Expose-Headers": "Operation-Location" - } - }, - "409": { - "headers": {}, - "body": { - "error": { - "code": "409 Conflict", - "message": "The data storage limit is reached on the Azure Maps account. You can always use the Data Delete API to delete old/unused content and create space for new uploads." - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json deleted file mode 100644 index d7013015d494..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Create.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "conversionId": "[conversionId]" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded" - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - }, - "202": { - "headers": { - "Operation-Location": "https://us.atlas.microsoft.com/datasets/operations/{operationId}?api-version=2022-01-01-preview", - "Access-Control-Expose-Headers": "Operation-Location" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json deleted file mode 100644 index bcdc4f9ee667..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_Delete.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "[datasetId]" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json deleted file mode 100644 index cbc36c7d0ef5..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetDetails.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "[datasetId]" - }, - "responses": { - "200": { - "headers": { - "Location": "https://us.atlas.microsoft.com/dataset/{datasetId}?api-version=1.0", - "Access-Control-Expose-Headers": "Resource-Location" - }, - "body": { - "created": "2021-05-21T01:02:03.456Z", - "datasetId": "[datasetId]", - "description": "Some description or comment about the dataset", - "datasetSources": { - "conversionIds": [ - "15d21452-c9bb-27b6-5e79-743ca5c3205d", - "c39de51c-b4f5-4733-aeeb-d8cb6f8b2f1d" - ], - "appendDatasetId": "6a49a490-1d9c-4f05-bf1e-51998fbc4733" - }, - "featureCounts": { - "directoryInfo": 2, - "category": 10, - "facility": 1, - "level": 3, - "unit": 183, - "zone": 3, - "verticalPenetration": 6, - "opening": 48, - "areaElement": 108 - }, - "ontology": "facility-2022-01-01-preview" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json deleted file mode 100644 index d890ffbfcfe2..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperation.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-20T22:43:14.9401559+00:00", - "status": "Succeeded" - }, - "headers": { - "Resource-Location": "https://us.atlas.microsoft.com/datasets/3e36b996-f6d1-b068-0fcb-dd6b014c3447?api-version=2022-01-01-preview" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json deleted file mode 100644 index 245506ef8536..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_GetOperationStillRunning.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "responses": { - "200": { - "body": { - "operationId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c", - "created": "2021-04-23T19:14:03.2452596+00:00", - "status": "Running" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json deleted file mode 100644 index 149352cc7594..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/dataset/Dataset_List.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview" - }, - "responses": { - "200": { - "body": { - "datasets": [ - { - "created": "2021-05-21T03:04:05.678Z", - "datasetId": "f6495f62-94f8-0ec2-c252-45626f82fcb2", - "description": "Some description or comment for the dataset.", - "datasetSources": { - "conversionIds": [ - "db63843c-3c70-4b4e-94ff-dfcf4013c4a9" - ] - }, - "featureCounts": { - "directoryInfo": 1, - "category": 18, - "facility": 1, - "level": 6, - "unit": 775, - "opening": 471, - "areaElement": 496 - }, - "ontology": "facility-2022-01-01-preview" - }, - { - "created": "2021-05-21T03:04:05.678Z", - "datasetId": "7c1288fa-2058-4a1b-b68f-13a6h5af7d7c", - "description": "Some other description or comment for the dataset.", - "datasetSources": { - "conversionIds": [ - "15d21452-c9bb-27b6-5e79-743ca5c3205d" - ], - "appendDatasetId": "8b1288fa-1958-4a2b-b68e-13a7i5af7d7c" - }, - "featureCounts": { - "directoryInfo": 2, - "category": 10, - "facility": 1, - "level": 3, - "unit": 183, - "zone": 3, - "verticalPenetration": 6, - "opening": 48, - "areaElement": 108 - }, - "ontology": "facility-2022-01-01-preview" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json deleted file mode 100644 index ef512cfe39f4..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_CreateStateset.json +++ /dev/null @@ -1,72 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "description": "Stateset for Azure Maps POC.", - "datasetId": "5d34fbe8-87b7-f7c0-3144-c50e003a3c75", - "styleRules": { - "styles": [ - { - "keyName": "s1", - "type": "boolean", - "rules": [ - { - "true": "#FF0000", - "false": "#00FF00" - } - ] - }, - { - "keyName": "s2", - "type": "number", - "rules": [ - { - "range": { - "exclusiveMaximum": "50" - }, - "color": "#343deb" - }, - { - "range": { - "minimum": "50", - "exclusiveMaximum": "70" - }, - "color": "#34ebb1" - }, - { - "range": { - "minimum": "70", - "exclusiveMaximum": "90" - }, - "color": "#eba834" - }, - { - "range": { - "minimum": "90" - }, - "color": "#eb3434" - } - ] - }, - { - "keyName": "s3", - "type": "string", - "rules": [ - { - "stateValue1": "#FF0000", - "stateValue2": "#FF00AA", - "stateValueN": "#00FF00" - } - ] - } - ] - } - }, - "responses": { - "200": { - "body": { - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json deleted file mode 100644 index e34410c90334..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteFeatureState.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", - "featureId": "SPC4709", - "stateKeyName": "keyName1" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json deleted file mode 100644 index 3811cd5051b5..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_DeleteStateset.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64f" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json deleted file mode 100644 index 17296ac5a5fd..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_GetStateset.json +++ /dev/null @@ -1,73 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64" - }, - "responses": { - "200": { - "body": { - "description": "Stateset for Azure Maps POC.", - "datasetIds": [ - "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" - ], - "statesetStyle": { - "styles": [ - { - "keyName": "s1", - "type": "boolean", - "rules": [ - { - "true": "#FFFF00", - "false": "#FFFFFF" - } - ] - }, - { - "keyName": "s2", - "type": "number", - "rules": [ - { - "range": { - "minimum": null, - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": "50" - }, - "color": "#343deb" - }, - { - "range": { - "minimum": "50", - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": "69" - }, - "color": "#34ebb1" - }, - { - "range": { - "minimum": "69", - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": "90" - }, - "color": "#eba834" - }, - { - "range": { - "minimum": "90", - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": null - }, - "color": "#eb3434" - } - ] - } - ] - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json deleted file mode 100644 index 0d129cd85bbf..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_List.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview" - }, - "responses": { - "200": { - "body": { - "statesets": [ - { - "statesetId": "09abcdf8-cad0-b3dd-a38f-d5ee3cff5eea", - "description": "Stateset for Main campus.", - "datasetIds": [ - "8d700cc7-fd2c-4e21-b402-ad3f5e524f36" - ], - "statesetStyle": { - "styles": [ - { - "keyName": "s1", - "type": "boolean", - "rules": [ - { - "true": "#0FFF00", - "false": "#00FFF0" - } - ] - }, - { - "keyName": "s2", - "type": "number", - "rules": [ - { - "range": { - "minimum": null, - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": "50" - }, - "color": "#343deb" - }, - { - "range": { - "minimum": "50", - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": "69" - }, - "color": "#34ebb1" - }, - { - "range": { - "minimum": "69", - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": "90" - }, - "color": "#eba834" - }, - { - "range": { - "minimum": "90", - "maximum": null, - "exclusiveMinimum": null, - "exclusiveMaximum": null - }, - "color": "#eb3434" - } - ] - } - ] - } - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json deleted file mode 100644 index 36abc3fdb1e1..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_ListStates.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", - "featureId": "SPC4709" - }, - "responses": { - "200": { - "body": { - "states": [ - { - "keyName": "s1", - "value": "true", - "eventTimestamp": "2019-08-16 13:01" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json deleted file mode 100644 index bfedcc72426f..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStates.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", - "featureId": "SPC4709", - "featureStates": { - "states": [ - { - "keyName": "s1", - "value": "true", - "eventTimestamp": "2019-08-16 13:01" - } - ] - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json deleted file mode 100644 index 99ae6595a578..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/featurestate/Featurestate_UpdateStateset.json +++ /dev/null @@ -1,56 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "statesetId": "b24bdb73-1305-3212-1909-a428d937b64", - "styleRules": { - "styles": [ - { - "keyName": "s1", - "type": "boolean", - "rules": [ - { - "true": "#FFFF00", - "false": "#FFFFFF" - } - ] - }, - { - "keyName": "s2", - "type": "number", - "rules": [ - { - "range": { - "exclusiveMaximum": "50" - }, - "color": "#343deb" - }, - { - "range": { - "minimum": "50", - "exclusiveMaximum": "69" - }, - "color": "#34ebb1" - }, - { - "range": { - "minimum": "69", - "exclusiveMaximum": "90" - }, - "color": "#eba834" - }, - { - "range": { - "minimum": "90" - }, - "color": "#eb3434" - } - ] - } - ] - } - }, - "responses": { - "200": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json deleted file mode 100644 index 1754991bc271..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_DeleteFeature.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", - "collectionId": "facility", - "featureId": "FCL39" - }, - "responses": { - "204": {} - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json deleted file mode 100644 index 8ad44a3b60c9..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollection.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", - "collectionId": "unit" - }, - "responses": { - "200": { - "body": { - "name": "unit", - "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", - "ontology": "Facility-2022-01-01-preview", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for unit" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "unit" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for unit" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json deleted file mode 100644 index cce385955930..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollectionDefinition.json +++ /dev/null @@ -1,152 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", - "collectionId": "unit" - }, - "responses": { - "200": { - "body": { - "idPrefix": "UNIT", - "name": "unit", - "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", - "ontology": "Facility-2022-01-01-preview", - "geometryType": "Polygon", - "featureTypes": [], - "properties": [ - { - "name": "externalId", - "required": false, - "type": "text" - }, - { - "name": "originalId", - "required": false, - "type": "text" - }, - { - "name": "categoryId", - "required": true, - "type": { - "featureId": "category" - } - }, - { - "name": "isOpenArea", - "required": false, - "type": "boolean" - }, - { - "name": "navigableBy", - "required": false, - "type": { - "array": { - "enum": [ - "pedestrian", - "wheelchair", - "machine", - "bicycle", - "automobile", - "hiredAuto", - "bus", - "railcar", - "emergency", - "ferry", - "boat" - ] - } - } - }, - { - "name": "isRoutable", - "required": false, - "type": "boolean" - }, - { - "name": "routeThroughBehavior", - "required": false, - "type": { - "enum": [ - "disallowed", - "allowed", - "preferred" - ] - } - }, - { - "name": "nonPublic", - "required": false, - "type": "boolean" - }, - { - "name": "levelId", - "required": true, - "type": { - "featureId": "level" - } - }, - { - "name": "occupants", - "required": false, - "type": { - "array": { - "featureId": "directoryInfo" - } - } - }, - { - "name": "addressId", - "required": false, - "type": { - "featureId": "directoryInfo" - } - }, - { - "name": "addressRoomNumber", - "required": false, - "type": "text" - }, - { - "name": "name", - "required": false, - "type": "text" - }, - { - "name": "nameSubtitle", - "required": false, - "type": "text" - }, - { - "name": "nameAlt", - "required": false, - "type": "text" - }, - { - "name": "anchorPoint", - "required": false, - "type": { - "geometry": [ - "Point" - ], - "isFragmented": false, - "srid": 4326 - } - } - ], - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for unit" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "unit" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json deleted file mode 100644 index fc6352e37d46..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetCollections.json +++ /dev/null @@ -1,253 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" - }, - "responses": { - "200": { - "body": { - "ontology": "Facility-2022-01-01-preview", - "collections": [ - { - "name": "unit", - "description": "A physical and non-overlapping area which might be occupied and traversed by a navigating agent. Can be a hallway, a room, a courtyard, etc. It is surrounded by physical obstruction (wall), unless the isOpenArea attribute is equal to true, and one must add openings where the obstruction shouldn't be there. If isOpenArea attribute is equal to true, all the sides are assumed open to the surroundings and walls are to be added where needed. Walls for open areas are represented as a lineElement or areaElement with isObstruction equal to true.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for unit" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "unit" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for unit" - } - ] - }, - { - "name": "zone", - "description": "A virtual area. ex, wifi zone, emergency assembly area. Zones can be used as destinations but not meant for through traffic.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for zone" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "zone" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/zone?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for zone" - } - ] - }, - { - "name": "level", - "description": "An indication of the extent and vertical position of a set of features.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for level" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "level" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/level?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for level" - } - ] - }, - { - "name": "facility", - "description": "Area of the site, building footprint etc.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for facility" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "facility" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/facility?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for facility" - } - ] - }, - { - "name": "verticalPenetration", - "description": "An area that, when used in a set, represents a method of navigating vertically between levels. It can be used to model stairs, elevators etc. Geometry can overlap units and other vertical penetration features.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for verticalPenetration" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "verticalPenetration" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/verticalPenetration?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for verticalPenetration" - } - ] - }, - { - "name": "opening", - "description": "A usually-traversable boundary between two units, or a unit and verticalPenetration.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for opening" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "opening" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/opening?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for opening" - } - ] - }, - { - "name": "directoryInfo", - "description": "Name, address, phone number, website, and hours of operation for a unit, facility, or an occupant of a unit or facility.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for directoryInfo" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "directoryInfo" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/directoryInfo?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for directoryInfo" - } - ] - }, - { - "name": "pointElement", - "description": "A point feature in a unit, such as a first aid kit or a sprinkler head.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for pointElement" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "pointElement" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/pointElement?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for pointElement" - } - ] - }, - { - "name": "lineElement", - "description": "A line feature in a unit, such as a dividing wall, window.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for lineElement" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "lineElement" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/lineElement?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for lineElement" - } - ] - }, - { - "name": "areaElement", - "description": "A polygon feature in a unit, such as an area open to below, an obstruction like an island in a unit.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for areaElement" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "areaElement" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/areaElement?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for areaElement" - } - ] - }, - { - "name": "category", - "description": "Category names. e.g. \"room.conference\". The isRoutable attribute puts a feature with that category on the routing graph. The routeThroughBehavior attribute determines whether a feature can be used for through traffic or not.", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/definition?api-version=2022-01-01-preview", - "rel": "describedBy", - "title": "Metadata catalogue for category" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category/items?api-version=2022-01-01-preview", - "rel": "data", - "title": "category" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/category?api-version=2022-01-01-preview", - "rel": "self", - "title": "Metadata catalogue for category" - } - ] - } - ], - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections?api-version=2022-01-01-preview", - "rel": "self" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json deleted file mode 100644 index 225286fa1436..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeature.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4", - "collectionId": "unit", - "featureId": "UNIT39" - }, - "responses": { - "200": { - "body": { - "ontology": "Facility-2022-01-01-preview", - "feature": { - "type": "Feature", - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - 139.63304057829211, - 35.457686686108559 - ], - [ - 139.63296283234274, - 35.457783904258683 - ], - [ - 139.63308672404617, - 35.457850229062018 - ], - [ - 139.63314516916711, - 35.457777145699858 - ], - [ - 139.63312747036289, - 35.457767670747167 - ], - [ - 139.63314677109963, - 35.457743535881377 - ], - [ - 139.63304057829211, - 35.457686686108559 - ] - ] - ] - }, - "properties": { - "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", - "categoryId": "CTG10", - "isOpenArea": false, - "navigableBy": [ - "pedestrian" - ], - "isRoutable": false, - "routeThroughBehavior": "allowed", - "nonPublic": false, - "levelId": "LVL18", - "occupants": [], - "addressId": "DIR16", - "addressRoomNumber": "", - "name": "21N13", - "nameSubtitle": "", - "nameAlt": "" - }, - "id": "UNIT39", - "featureType": "" - }, - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items/UNIT39?api-version=2022-01-01-preview", - "rel": "self" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", - "rel": "data" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json deleted file mode 100644 index ca67a8127fc3..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetFeatures.json +++ /dev/null @@ -1,93 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "018fda98-e638-0edf-5ef7-28491ff3bed4", - "collectionId": "unit", - "limit": 1, - "bbox": "-122, 47, -120, 46" - }, - "responses": { - "200": { - "body": { - "type": "FeatureCollection", - "ontology": "Facility-2022-01-01-preview", - "features": [ - { - "type": "Feature", - "geometry": { - "type": "Polygon", - "coordinates": [ - [ - [ - 139.63304057829211, - 35.457686686108559 - ], - [ - 139.63296283234274, - 35.457783904258683 - ], - [ - 139.63308672404617, - 35.457850229062018 - ], - [ - 139.63314516916711, - 35.457777145699858 - ], - [ - 139.63312747036289, - 35.457767670747167 - ], - [ - 139.63314677109963, - 35.457743535881377 - ], - [ - 139.63304057829211, - 35.457686686108559 - ] - ] - ] - }, - "properties": { - "originalId": "ddbbb583-4621-4e11-8859-299d1057e843", - "categoryId": "CTG10", - "isOpenArea": false, - "navigableBy": [ - "pedestrian" - ], - "isRoutable": false, - "routeThroughBehavior": "allowed", - "nonPublic": false, - "levelId": "LVL18", - "occupants": [], - "addressId": "DIR16", - "addressRoomNumber": "", - "name": "21N13", - "nameSubtitle": "", - "nameAlt": "" - }, - "id": "UNIT39", - "featureType": "" - } - ], - "numberReturned": 1, - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?api-version=2022-01-01-preview&limit=1", - "rel": "self" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit?api-version=2022-01-01-preview", - "rel": "data" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/dataset/218fda98-e638-0edf-5ef7-28491ff3bed4/collections/unit/items?n=PMRG4ZLYOQRDUMJMEJYHEZLWEI5C2ML5&api-version=2022-01-01-preview&limit=1", - "rel": "next" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json deleted file mode 100644 index e84ea1accc61..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_GetLandingPage.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" - }, - "responses": { - "200": { - "body": { - "ontology": "Facility-2022-01-01-preview", - "links": [ - { - "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4", - "rel": "self", - "title": "Azure Maps WFS" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/api", - "rel": "service", - "title": "The API definition" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/conformance", - "rel": "conformance", - "title": "WFS 3.0 conformance classes implemented by this server" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/version", - "rel": "data", - "title": "The version information" - }, - { - "href": "https://us.atlas.microsoft.com/wfs/datasets/218fda98-e638-0edf-5ef7-28491ff3bed4/collections", - "rel": "data", - "title": "Metadata about the feature collections" - } - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json deleted file mode 100644 index b41afc38fee7..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/wfs/WFS_ListConformance.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "geography": "us", - "api-version": "2022-01-01-preview", - "datasetId": "218fda98-e638-0edf-5ef7-28491ff3bed4" - }, - "responses": { - "200": { - "body": { - "conformsTo": [ - "http://www.opengis.net/spec/wfs-1/3.0/req/core", - "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", - "http://www.opengis.net/spec/wfs-1/3.0/req/geojson", - "http://tempuri.org/wfs/3.0/edit" - ] - } - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json deleted file mode 100644 index a547dd8f7b22..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/featurestate.json +++ /dev/null @@ -1,694 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Feature State Service", - "version": "2022-01-01-preview", - "description": "APIs for managing the dynamic feature states in Azure Maps." - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "2022-01-01-preview", - "x-ms-parameter-location": "client" - }, - "FeatureStateSetDescription": { - "name": "description", - "description": "Description for the stateset. Max length allowed is 1000.", - "type": "string", - "in": "query", - "required": false, - "x-ms-parameter-location": "method" - }, - "DatasetIdForCreate": { - "name": "datasetId", - "description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create) call.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - }, - "StatesetIdInPath": { - "name": "statesetId", - "description": "The stateset id that was created.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureIdSet": { - "name": "featureId", - "description": "The id of a feature in the given dataset. If the featureId is not present in the dataset, Bad Request response will be returned.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureIdGet": { - "name": "featureId", - "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "FeatureIdDelete": { - "name": "featureId", - "description": "The id of a feature in the given stateset. If no state was set for the featureId in the stateset earlier, Bad Request response will be returned.", - "type": "string", - "in": "path", - "required": true, - "x-ms-parameter-location": "method" - }, - "StateKeyName": { - "name": "stateKeyName", - "x-ms-client-name": "keyName", - "description": "The Name of the state to be deleted.", - "type": "string", - "in": "query", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/featureStateSets": { - "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis POST API allows the user to create a new Stateset and define stateset style using request body.\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. The Feature State API is part of Creator. \n\nThe Feature State service allows the user to update the states of a feature and query them to be used in other services. The dynamic properties of a feature that don't belong to the dataset are referred to as *states* here.\n\nThis Feature State service pivot on the Stateset. Like Tileset, Stateset encapsulates the storage mechanism for feature states for a dataset.\n\nOnce the stateset is created, users can use that statesetId to post feature state updates and retrieve the current feature states. A feature can have only one state at a given point in time. \n\nFeature state is defined by the key name, value and the timestamp. When a feature state update is posted to Azure Maps, the state value gets updated only if the provided state’s timestamp is later than the stored timestamp. \n\nAzure Maps MapControl provides a way to use these feature states to style the features. Please refer to the [State Tile documentation](https://docs.microsoft.com/en-us/rest/api/maps/render/get-map-state-tile-preview) for more information.", - "operationId": "FeatureState_CreateStateset", - "x-ms-examples": { - "Create a new stateset with a datasetId": { - "$ref": "./examples/featurestate/Featurestate_CreateStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/DatasetIdForCreate" - }, - { - "$ref": "#/parameters/FeatureStateSetDescription" - }, - { - "name": "styleRules", - "in": "body", - "description": "The stateset style JSON data.", - "required": true, - "schema": { - "$ref": "#/definitions/StyleRules" - } - } - ], - "responses": { - "200": { - "description": "Stateset created.", - "schema": { - "$ref": "#/definitions/StatesetCreatedResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API allows the caller to fetch a list of all previously successfully created statesets.", - "operationId": "FeatureState_ListStatesets", - "x-ms-examples": { - "List all the previously created statesets": { - "$ref": "./examples/featurestate/Featurestate_List.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - } - ], - "x-ms-pageable": { - "itemName": "statesets", - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "The list stateset request completed successfully. The response body contains a list of all the previously created statesets.", - "schema": { - "$ref": "#/definitions/StatesetListResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/featureStateSets/{statesetId}": { - "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the stateset style rules.", - "operationId": "FeatureState_UpdateStateset", - "x-ms-examples": { - "Update stateset style rules with a statesetId": { - "$ref": "./examples/featurestate/Featurestate_UpdateStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "name": "styleRules", - "in": "body", - "description": "The stateset style JSON data. Only style rules are allowed to be updated, update on keyname and type is not allowed.", - "required": true, - "schema": { - "$ref": "#/definitions/StyleRules" - } - } - ], - "responses": { - "200": { - "description": "Stateset styles are updated successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This DELETE API allows the user to delete the stateset and the associated data.", - "operationId": "FeatureState_DeleteStateset", - "x-ms-examples": { - "Delete an existing stateset": { - "$ref": "./examples/featurestate/Featurestate_DeleteStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - } - ], - "responses": { - "204": { - "description": "Stateset Deleted." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis GET API allows the user to get the stateset Information.\n\nThe stateset Information includes the datasetId associated to the stateset, and the styles of that stateset.", - "operationId": "FeatureState_GetStateset", - "x-ms-examples": { - "Get stateset information with a statesetId": { - "$ref": "./examples/featurestate/Featurestate_GetStateset.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - } - ], - "responses": { - "200": { - "description": "Get request completed successfully.", - "schema": { - "$ref": "#/definitions/Stateset" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/featureStateSets/{statesetId}/featureStates/{featureId}": { - "put": { - "operationId": "FeatureState_UpdateStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis PUT API allows the user to update the state of the given feature in the given stateset.", - "x-ms-examples": { - "Update the states of a feature": { - "$ref": "./examples/featurestate/Featurestate_UpdateStates.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "$ref": "#/parameters/FeatureIdSet" - }, - { - "name": "featureStates", - "in": "body", - "description": "The feature state JSON data. A feature can have only one state at a given point in time. The specified state keyname must have been defined during the stateset creation.", - "required": true, - "schema": { - "$ref": "#/definitions/FeatureStatesStructure" - } - } - ], - "responses": { - "200": { - "description": "Feature states are updated successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "operationId": "FeatureState_DeleteState", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API deletes the state information identified by the StateKeyName parameter for the feature identified by the FeatureId parameter in the the stateset.", - "x-ms-examples": { - "Delete the given feature state": { - "$ref": "./examples/featurestate/Featurestate_DeleteFeatureState.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "$ref": "#/parameters/FeatureIdDelete" - }, - { - "$ref": "#/parameters/StateKeyName" - } - ], - "responses": { - "204": { - "description": "Feature states deleted successfully." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "get": { - "operationId": "FeatureState_ListStates", - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n This API returns the current state information associated with the given feature in the given stateset.", - "x-ms-examples": { - "Get the current states of a feature": { - "$ref": "./examples/featurestate/Featurestate_ListStates.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "#/parameters/StatesetIdInPath" - }, - { - "$ref": "#/parameters/FeatureIdGet" - } - ], - "responses": { - "200": { - "description": "Get request completed successfully.", - "schema": { - "$ref": "#/definitions/FeatureStatesStructure" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "Stateset": { - "description": "The response model for the successful Stateset Get API.", - "type": "object", - "properties": { - "description": { - "description": "Description associated with the stateset.", - "type": "string", - "readOnly": true - }, - "datasetIds": { - "description": "Dataset ID associated with the stateset.", - "type": "array", - "items": { - "type": "string" - } - }, - "statesetStyle": { - "x-ms-client-name": "styleRules", - "$ref": "#/definitions/StyleRules" - } - } - }, - "StatesetListResult": { - "description": "The response model for the successful Stateset List API.", - "type": "object", - "properties": { - "statesets": { - "description": "A list of statesets information.", - "type": "array", - "items": { - "$ref": "#/definitions/StatesetInfo" - } - }, - "nextLink": { - "description": "If present, the location of the next page of data.", - "type": "string", - "readOnly": true - } - } - }, - "StatesetInfo": { - "description": "The stateset information detail.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Stateset" - } - ], - "properties": { - "statesetId": { - "description": "The stateset ID of this stateset.", - "type": "string", - "readOnly": true - } - } - }, - "StatesetCreatedResult": { - "description": "The response model for the successful Stateset Create API.", - "type": "object", - "properties": { - "statesetId": { - "description": "The ID for the new stateset created.", - "type": "string", - "readOnly": true - } - } - }, - "FeatureStatesStructure": { - "description": "The feature states model for a feature.", - "type": "object", - "properties": { - "states": { - "description": "The feature states array.", - "type": "array", - "items": { - "$ref": "#/definitions/FeatureState" - } - } - } - }, - "FeatureState": { - "description": "Single feature state model.", - "type": "object", - "properties": { - "keyName": { - "description": "Feature state Keyname. Maximum length allowed is 1000.", - "type": "string" - }, - "value": { - "description": "Value for the feature state. Type should comply with the style definition attached to the featurestate. Maximum length allowed for string type is 1024.", - "type": "string" - }, - "eventTimestamp": { - "description": "Valid Timestamp when the feature state was captured.", - "type": "string" - } - } - }, - "StyleRules": { - "description": "The styles model.", - "type": "object", - "properties": { - "styles": { - "x-ms-client-name": "styleRules", - "description": "An array of stateset style rules. The style rule could be a numeric or string or a boolean type style rule. Refer to NumberRule, StringRule and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ", - "type": "array", - "items": { - "$ref": "#/definitions/StyleRule" - } - } - } - }, - "NumberRule": { - "description": "The numeric rule. The color is selected from the first range it falls into.", - "type": "object", - "properties": { - "range": { - "$ref": "#/definitions/Range" - }, - "color": { - "description": "The color when value is within the range. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - } - } - }, - "Range": { - "description": "The numeric value range for this style rule. If the value is in the range, all the conditions must hold true.", - "type": "object", - "properties": { - "minimum": { - "description": "All the number x that x ≥ minimum.", - "type": "string" - }, - "maximum": { - "description": "All the number x that x ≤ maximum.", - "type": "string" - }, - "exclusiveMinimum": { - "description": "All the number x that x > exclusiveMinimum.", - "type": "string" - }, - "exclusiveMaximum": { - "description": "All the number x that x < exclusiveMaximum.", - "type": "string" - } - } - }, - "BooleanRule": { - "description": "The boolean rule. The color is selected based on the logic value of the key.", - "type": "object", - "properties": { - "true": { - "description": "The color when value is true. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - }, - "false": { - "description": "The color when value is false. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - } - } - }, - "StringRuleObject": { - "description": "The string rule. The string value matching is case sensitive. If a feature's state doesn't match any of the values defined here, that feature will not have any dynamic style. If duplicate string values are given, the first one takes precedence.", - "type": "object", - "additionalProperties": { - "description": "The color when the keyName value string is equal to this property name. Color is a JSON string in a variety of permitted formats, HTML-style hex values, RGB (\"#ff0\", \"#ffff00\", \"rgb(255, 255, 0)\"), RGBA (\"rgba(255, 255, 0, 1)\"), HSL(\"hsl(100, 50%, 50%)\"), and HSLA(\"hsla(100, 50%, 50%, 1)\"). Predefined HTML colors names, like yellow and blue, are also permitted.", - "type": "string" - } - }, - "StyleRule": { - "description": "The stateset style model. The style rule could be a numeric type style rule or a boolean type style rule. Refer to NumberRule, StringRuleObject and BooleanRule definitions [here](https://aka.ms/AzureMapsStatesetStyles). ", - "discriminator": "type", - "type": "object", - "required": [ - "keyName", - "type" - ], - "properties": { - "keyName": { - "description": "Stateset style key name. Key names are random strings but they should be unique inside style array.", - "type": "string" - }, - "type": { - "description": "The type of stateset style.", - "type": "string", - "enum": [ - "boolean", - "number", - "string" - ], - "x-ms-enum": { - "name": "StyleRuleType", - "modelAsString": true, - "values": [ - { - "value": "boolean", - "description": "Boolean type of stateset style." - }, - { - "value": "number", - "description": "Number type of stateset style." - }, - { - "value": "string", - "description": "String type of stateset style." - } - ] - } - } - } - }, - "BooleanStyleRule": { - "description": "The boolean type style rule object.", - "x-ms-discriminator-value": "boolean", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StyleRule" - } - ], - "properties": { - "rules": { - "description": "Boolean style rules.", - "type": "array", - "items": { - "$ref": "#/definitions/BooleanRule" - } - } - }, - "required": [ - "rules" - ] - }, - "NumberStyleRule": { - "description": "The numeric type style rule object.", - "x-ms-discriminator-value": "number", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StyleRule" - } - ], - "properties": { - "rules": { - "description": "Numeric style rules.", - "type": "array", - "items": { - "$ref": "#/definitions/NumberRule" - } - } - }, - "required": [ - "rules" - ] - }, - "StringStyleRule": { - "description": "The string type style rule object.", - "x-ms-discriminator-value": "string", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/StyleRule" - } - ], - "properties": { - "rules": { - "description": "String style rules.", - "type": "array", - "items": { - "$ref": "#/definitions/StringRuleObject" - } - } - }, - "required": [ - "rules" - ] - } - } -} diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json index c686cad415ab..d28a1f40930a 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json @@ -103,12 +103,24 @@ "in": "query", "description": "Defines the type of input file for a style to be created from.", "required": false, - "schema": { - "type": "string", - "default": "mapbox", - "enum": [ - "mapbox", - "azureMapsStyleRecipe" + "type": "string", + "default": "JSON", + "enum": [ + "JSON", + "ZIP" + ], + "x-ms-enum": { + "name": "StyleFormatType", + "modelAsString": true, + "values": [ + { + "value": "JSON", + "description": "JSON style format." + }, + { + "value": "ZIP", + "description": "ZIP style format." + } ] } }, @@ -117,12 +129,24 @@ "in": "query", "description": " Defines the type of JSON object that is imported.", "required": false, - "schema": { - "type": "string", - "default": "JSON", - "enum": [ - "JSON", - "ZIP" + "type": "string", + "default": "mapbox", + "enum": [ + "mapbox", + "azureMapsStyleRecipe" + ], + "x-ms-enum": { + "name": "DataFormatType", + "modelAsString": true, + "values": [ + { + "value": "mapbox", + "description": "mapbox style data format." + }, + { + "value": "azureMapsStyleRecipe", + "description": "Azure Maps style recipe data format." + } ] } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json deleted file mode 100644 index fad45ae51ae8..000000000000 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/wfs.json +++ /dev/null @@ -1,772 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure Maps Web Feature Service", - "version": "2022-01-01-preview", - "description": "Azure Maps Web Feature REST APIs" - }, - "x-ms-parameterized-host": { - "hostTemplate": "{geography}.atlas.microsoft.com", - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/GeographicResourceLocation" - } - ] - }, - "schemes": [ - "https" - ], - "consumes": [], - "produces": [ - "application/json" - ], - "securityDefinitions": { - "AADToken": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2022-01-01-preview](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", - "scopes": { - "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" - } - }, - "SharedKey": { - "type": "apiKey", - "description": "This is a shared key that is provisioned when creating an [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for.\n\n For publicly exposed applications, our recommendation is to use server-to-server access of Azure Maps REST APIs where this key can be securely stored.", - "name": "subscription-key", - "in": "query" - }, - "SasToken": { - "type": "apiKey", - "description": "This is a shared access signature token is created from the List SAS operation on the [Azure Maps resource](https://aka.ms/amauth) through the Azure management plane via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n\n With this token, any application is authorized to access with Azure role-based access controls and fine-grain control to the expiration, rate, and region(s) of use for the particular token. In other words, the SAS Token can be used to allow applications to control access in a more secured way than the shared key.\n\n For publicly exposed applications, our recommendation is to configure a specific list of allowed origins on the [Map account resource](https://aka.ms/amauth) to limit rendering abuse and regularly renew the SAS Token.", - "name": "SAS Token", - "in": "header" - } - }, - "security": [ - { - "AADToken": [ - "https://atlas.microsoft.com/.default" - ] - }, - { - "SharedKey": [] - }, - { - "SasToken": [] - } - ], - "responses": {}, - "parameters": { - "ApiVersion": { - "name": "api-version", - "description": "Version number of Azure Maps API.", - "type": "string", - "in": "query", - "required": true, - "default": "2022-01-01-preview", - "x-ms-parameter-location": "client" - }, - "LimitWfs": { - "name": "limit", - "in": "query", - "type": "integer", - "minimum": 1, - "maximum": 500, - "description": "The optional limit parameter limits the number of features that are presented in the response document.\nOnly features that are on the first level of the collection in the response document are counted. Nested objects contained within the explicitly requested features shall not be counted.\n* Minimum = 1 * Maximum = 500 * Default = 10", - "x-ms-parameter-location": "method" - }, - "Filter": { - "name": "filter", - "in": "query", - "type": "string", - "description": "Filter expression to search for features with specific property values in a given collection. Only feature properties of scalar type and equals operator are supported.\nThis is a special parameter where the parameter name is a case sensitive property name. The scheme for this parameter is {property name}={property value}. Unless \"filter\" is one of the property names in the collection, \"filter\" should not be used as a parameter name. To search for features with \"name\" property value \"21N13\", use \"name=21N13\".\nMultiple filters are supported and should be represented as multiple query parameters. E.g., =&= String values are case sensitive.", - "x-ms-parameter-location": "method" - }, - "Bbox": { - "name": "bbox", - "x-ms-client-name": "boundingBox", - "in": "query", - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "number", - "format": "double" - }, - "description": "Only features that have a geometry that intersects the supplied bounding box are selected.\n* Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2\nThe coordinate reference system of the values is WGS84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter `bbox-crs`.\nFor WGS84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge).", - "x-ms-parameter-location": "method" - }, - "CollectionId": { - "name": "collectionId", - "in": "path", - "type": "string", - "required": true, - "description": "Identifier (name) of a specific collection", - "x-ms-parameter-location": "method" - }, - "FeatureId": { - "name": "featureId", - "in": "path", - "type": "string", - "description": "Local identifier of a specific feature", - "required": true, - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/wfs/datasets/{datasetId}/": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Landing Page API provides links to the API definition, the Conformance statements and the metadata about the feature data in this dataset.", - "operationId": "WFS_GetLandingPage", - "x-ms-examples": { - "GetLandingPage": { - "$ref": "./examples/wfs/WFS_GetLandingPage.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/LandingPageResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/wfs/datasets/{datasetId}/conformance": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Requirements Classes lists all requirements classes specified in the standard that the server conforms to.", - "operationId": "WFS_ListConformance", - "x-ms-examples": { - "GetConformance": { - "$ref": "./examples/wfs/WFS_ListConformance.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/ConformanceResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/wfs/datasets/{datasetId}/collections": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Collections Description API provides descriptions of all the collections in a given dataset.", - "operationId": "WFS_GetCollections", - "x-ms-examples": { - "GetCollections": { - "$ref": "./examples/wfs/WFS_GetCollections.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/CollectionsResponse" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/wfs/datasets/{datasetId}/collections/{collectionId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Description API provides the description of a given collection. It includes the links to the operations that can be performed on the collection.", - "operationId": "WFS_GetCollection", - "x-ms-examples": { - "GetCollection": { - "$ref": "./examples/wfs/WFS_GetCollection.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/Collection" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/wfs/datasets/{datasetId}/collections/{collectionId}/definition": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\n \nThe Collection Definition API provides the detailed data model of a given collection.", - "operationId": "WFS_GetCollectionDefinition", - "x-ms-examples": { - "GetCollectionDefinition": { - "$ref": "./examples/wfs/WFS_GetCollectionDefinition.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/CollectionDefinition" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/wfs/datasets/{datasetId}/collections/{collectionId}/items": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Features API returns the list of features in the given collection.", - "operationId": "WFS_GetFeatures", - "x-ms-examples": { - "GetFeatures": { - "$ref": "./examples/wfs/WFS_GetFeatures.json" - } - }, - "parameters": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/parameters/ClientId" - }, - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/LimitWfs" - }, - { - "$ref": "#/parameters/Bbox" - }, - { - "$ref": "#/parameters/Filter" - } - ], - "responses": { - "200": { - "description": "Ok", - "schema": { - "$ref": "#/definitions/ExtendedGeoJsonFeatureCollection" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - }, - "/wfs/datasets/{datasetId}/collections/{collectionId}/items/{featureId}": { - "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Get Feature API returns the feature identified by the provided id in the given collection.", - "operationId": "WFS_GetFeature", - "x-ms-examples": { - "GetFeature": { - "$ref": "./examples/wfs/WFS_GetFeature.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureId" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/FeatureResult" - } - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - }, - "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n The Web Feature Service (WFS) API is part of Creator. WFS API follows the [Open Geospatial Consortium API standard for Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) to query [Datasets](https://docs.microsoft.com/en-us/rest/api/maps/v2/dataset/create). \nA dataset consists of multiple feature collections. A feature collection is a collection of features of a similar type, based on a common schema.\nThe Delete Feature API deletes the feature identified by the provided id in the given collection. At this point this API supports only facility features. Deleting a facility feature deletes all the child features of that facility recursively.", - "operationId": "WFS_DeleteFeature", - "x-ms-examples": { - "DeleteFeature": { - "$ref": "./examples/wfs/WFS_DeleteFeature.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/ApiVersion" - }, - { - "$ref": "dataset.json#/parameters/DatasetId" - }, - { - "$ref": "#/parameters/CollectionId" - }, - { - "$ref": "#/parameters/FeatureId" - } - ], - "responses": { - "204": { - "description": "Feature Deleted." - }, - "default": { - "$ref": "../../../Common/preview/1.0/common.json#/responses/default" - } - } - } - } - }, - "definitions": { - "LandingPageResult": { - "type": "object", - "required": [ - "links" - ], - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "links": { - "description": "Links to other WFS endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/WFSEndpointLink" - } - } - } - }, - "ConformanceResult": { - "type": "object", - "required": [ - "conformsTo" - ], - "properties": { - "conformsTo": { - "description": "List of requirements classes that the server conforms to.", - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "http://www.opengis.net/spec/wfs-1/3.0/req/core", - "http://www.opengis.net/spec/wfs-1/3.0/req/oas30", - "http://www.opengis.net/spec/wfs-1/3.0/req/html", - "http://www.opengis.net/spec/wfs-1/3.0/req/geojson" - ] - } - } - }, - "WFSEndpointLink": { - "description": "Links to other WFS endpoints", - "type": "object", - "required": [ - "href" - ], - "properties": { - "href": { - "description": "The link target.", - "type": "string" - }, - "rel": { - "description": "The relation type.", - "type": "string", - "example": "prev" - }, - "type": { - "description": "A hint indicating what the media type of the result of dereferencing the link should be.", - "type": "string", - "example": "application/geo+json" - }, - "hreflang": { - "x-ms-client-name": "hrefLang", - "description": "A hint indicating what the language of the result of dereferencing the link should be.", - "type": "string", - "example": "en" - }, - "title": { - "description": "Used to label the destination of a link such that it can be used as a human-readable identifier (e.g., a menu entry) in the language indicated by the Content-Language header field (if present).", - "type": "string" - } - } - }, - "CollectionsResponse": { - "type": "object", - "required": [ - "links", - "collections" - ], - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "links": { - "description": "Links to other WFS endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/WFSEndpointLink" - }, - "example": [ - { - "href": "http://data.example.org/collections.json", - "rel": "self", - "type": "application/json", - "title": "this document" - }, - { - "href": "http://data.example.org/collections.html", - "rel": "alternate", - "type": "text/html", - "title": "this document as HTML" - }, - { - "href": "http://schemas.example.org/1.0/foobar.xsd", - "rel": "describedBy", - "type": "application/xml", - "title": "XML schema for Acme Corporation data" - } - ] - }, - "collections": { - "description": "All the collections in a given dataset.", - "type": "array", - "items": { - "$ref": "#/definitions/Collection" - } - } - } - }, - "Collection": { - "type": "object", - "required": [ - "name", - "links" - ], - "properties": { - "name": { - "description": "identifier of the collection used, for example, in URIs", - "type": "string", - "example": "buildings" - }, - "title": { - "description": "human readable title of the collection", - "type": "string", - "example": "Buildings" - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "description": { - "description": "a description of the features in the collection", - "type": "string", - "example": "Buildings in the city of Bonn." - }, - "links": { - "description": "Links to other WFS endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/WFSEndpointLink" - }, - "example": [ - { - "href": "http://data.example.org/collections/buildings/items", - "rel": "item", - "type": "application/geo+json", - "title": "Buildings" - }, - { - "href": "http://example.org/concepts/building.html", - "rel": "describedBy", - "type": "text/html", - "title": "Feature catalogue for buildings" - } - ] - } - } - }, - "CollectionDefinition": { - "description": "collection of GeoJSON features", - "type": "object", - "required": [ - "idPrefix", - "name", - "geometryType", - "featureTypes" - ], - "properties": { - "description": { - "description": "describes the collection", - "type": "string" - }, - "idPrefix": { - "description": "prefix of the collection used", - "type": "string", - "example": "BLD" - }, - "name": { - "description": "identifier of the collection used, for example, in URIs", - "type": "string", - "example": "buildings" - }, - "title": { - "description": "title of collection", - "type": "string", - "example": "Feature Class buildings" - }, - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "geometryType": { - "description": "type of geometry returned", - "type": "string", - "enum": [ - "Point", - "MultiPoint", - "LineString", - "MultiLineString", - "Polygon", - "MultiPolygon", - "GeometryCollection" - ], - "x-ms-enum": { - "name": "GeoJsonGeometryType", - "modelAsString": true, - "values": [ - { - "value": "Point", - "description": "`GeoJSON Point` geometry.", - "name": "GeoJsonPoint" - }, - { - "value": "MultiPoint", - "description": "`GeoJSON MultiPoint` geometry.", - "name": "GeoJsonMultiPoint" - }, - { - "value": "LineString", - "description": "`GeoJSON LineString` geometry.", - "name": "GeoJsonLineString" - }, - { - "value": "MultiLineString", - "description": "`GeoJSON MultiLineString` geometry.", - "name": "GeoJsonMultiLineString" - }, - { - "value": "Polygon", - "description": "`GeoJSON Polygon` geometry.", - "name": "GeoJsonPolygon" - }, - { - "value": "MultiPolygon", - "description": "`GeoJSON MultiPolygon` geometry.", - "name": "GeoJsonMultiPolygon" - }, - { - "value": "GeometryCollection", - "description": "`GeoJSON GeometryCollection` geometry.", - "name": "GeoJsonGeometryCollection" - } - ] - } - }, - "featureTypes": { - "description": "type of features returned", - "type": "array", - "items": { - "type": "string" - } - }, - "properties": { - "description": "attributes of the collection used", - "type": "array", - "items": { - "$ref": "#/definitions/DefinitionProperty" - } - }, - "links": { - "description": "Links to other WFS endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/WFSEndpointLink" - } - } - } - }, - "DefinitionProperty": { - "type": "object", - "required": [ - "name", - "required", - "type" - ], - "properties": { - "name": { - "description": "name of attribute", - "type": "string", - "example": "external_id" - }, - "required": { - "description": "is attribute required", - "type": "boolean" - }, - "type": { - "description": "type of attribute", - "type": "object" - } - } - }, - "ExtendedGeoJsonFeatureCollection": { - "description": "A valid `GeoJSON FeatureCollection` object type extended with numberReturned and links array. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946#section-3.3) for details.", - "type": "object", - "allOf": [ - { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeatureCollectionData" - }, - { - "$ref": "#/definitions/ExtendedGeoJsonFeatureCollectionData" - } - ], - "properties": { - "type": { - "description": "Specifies the `GeoJSON` type: FeatureCollection.", - "type": "string", - "enum": [ - "FeatureCollection" - ], - "x-ms-enum": { - "name": "GeoJsonObjectType", - "modelAsString": false, - "values": [ - { - "value": "FeatureCollection", - "description": "`GeoJSON FeatureCollection` object." - } - ] - } - } - } - }, - "ExtendedGeoJsonFeatureCollectionData": { - "type": "object", - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "numberReturned": { - "description": "Number of returned features.", - "type": "integer" - }, - "links": { - "description": "Links to other WFS endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/WFSEndpointLink" - } - } - } - }, - "FeatureResult": { - "type": "object", - "required": [ - "feature" - ], - "properties": { - "ontology": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/Ontology" - }, - "feature": { - "$ref": "../../../Common/preview/1.0/common.json#/definitions/GeoJsonFeature" - }, - "links": { - "description": "Links to other WFS endpoints.", - "type": "array", - "items": { - "$ref": "#/definitions/WFSEndpointLink" - } - } - } - } - } -} diff --git a/specification/maps/data-plane/Creator/readme.md b/specification/maps/data-plane/Creator/readme.md index 7aa95e6a1689..9860c22bb3a3 100644 --- a/specification/maps/data-plane/Creator/readme.md +++ b/specification/maps/data-plane/Creator/readme.md @@ -40,13 +40,7 @@ These settings apply only when `--tag=package-preview-2022-01` is specified on t ```yaml $(tag) == 'package-preview-2022-01' input-file: - - preview/2022-01-01-preview/alias.json - - preview/2022-01-01-preview/data.json - - preview/2022-01-01-preview/dataset.json - - preview/2022-01-01-preview/dwgconversion.json - - preview/2022-01-01-preview/featurestate.json - preview/2022-01-01-preview/tileset.json - - preview/2022-01-01-preview/wfs.json - preview/2022-01-01-preview/stylerecipe.json - preview/2022-01-01-preview/styleset.json ``` From 5d55cd7cc90dfba5011e4ad51325be85a2ae4309 Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 6 Jan 2022 00:29:22 -0800 Subject: [PATCH 18/23] fix validation errors --- .../2022-01-01-preview/stylerecipe.json | 39 +++++++++++- .../preview/2022-01-01-preview/styleset.json | 59 +++++++++++++++---- 2 files changed, 83 insertions(+), 15 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json index d28a1f40930a..97c967d0229b 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json @@ -110,7 +110,7 @@ "ZIP" ], "x-ms-enum": { - "name": "StyleFormatType", + "name": "DataFormatType", "modelAsString": true, "values": [ { @@ -136,7 +136,7 @@ "azureMapsStyleRecipe" ], "x-ms-enum": { - "name": "DataFormatType", + "name": "StyleFormatType", "modelAsString": true, "values": [ { @@ -372,6 +372,37 @@ } } }, + "LayerObject": { + "description": "A layer object.", + "type": "object", + "properties": { + "id": { + "description": "The unique id for the layer.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the layer.", + "type": "string", + "readOnly": true + }, + "source-layer": { + "description": "The source layer.", + "type": "string", + "readOnly": true + }, + "layout": { + "description": "The layout of the layer.", + "type": "object", + "readOnly": true + }, + "paint": { + "description": "The paint configuration of the layer.", + "type": "object", + "readOnly": true + } + } + }, "StyleRecipe": { "description": "Detail information for the data.", "type": "object", @@ -410,7 +441,9 @@ "description": "A style's layers property lists all the layers available in that style", "type": "array", "readOnly": true, - "items": "object" + "items": { + "$ref": "#/definitions/LayerObject" + } } } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index ee4ed81c5da4..dc2b82c2ed4d 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -106,30 +106,65 @@ "required": true, "x-ms-parameter-location": "method" }, - "DataFormat": { - "name": "dataFormat", + + "StyleFormat": { + "name": "styleFormat", "in": "query", - "description": "Defines the type of input file for a style set to be created from", + "description": "Defines the type of JSON object that is exported", "required": false, "schema": { "type": "string", - "default": "JSON", + "default": "mapbox", "enum": [ - "JSON", - "ZIP" + "mapbox" + ] + } + }, + "DataFormat": { + "name": "dataFormat", + "in": "query", + "description": "Defines the type of input file for a style set to be created from.", + "required": false, + "type": "string", + "default": "JSON", + "enum": [ + "JSON", + "ZIP" + ], + "x-ms-enum": { + "name": "DataFormatType", + "modelAsString": true, + "values": [ + { + "value": "JSON", + "description": "JSON style format." + }, + { + "value": "ZIP", + "description": "ZIP style format." + } ] } }, "StyleFormat": { "name": "styleFormat", "in": "query", - "description": "Defines the type of JSON object that is exported", + "description": " Defines the type of JSON object that is exported.", "required": false, - "schema": { - "type": "string", - "default": "mapbox", - "enum": [ - "mapbox" + "type": "string", + "default": "mapbox", + "enum": [ + "mapbox", + "azureMapsStyleRecipe" + ], + "x-ms-enum": { + "name": "StyleFormatType", + "modelAsString": true, + "values": [ + { + "value": "mapbox", + "description": "mapbox style data format." + } ] } } From 87d9a3a97904fb07c1e926451be6b4617b32947a Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 6 Jan 2022 00:34:05 -0800 Subject: [PATCH 19/23] fix errors --- .../preview/2022-01-01-preview/styleset.json | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index dc2b82c2ed4d..2b5e81333053 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -106,20 +106,6 @@ "required": true, "x-ms-parameter-location": "method" }, - - "StyleFormat": { - "name": "styleFormat", - "in": "query", - "description": "Defines the type of JSON object that is exported", - "required": false, - "schema": { - "type": "string", - "default": "mapbox", - "enum": [ - "mapbox" - ] - } - }, "DataFormat": { "name": "dataFormat", "in": "query", From 673e27b1739b5aad63c1abe20dc8e5f1bcf4e728 Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 6 Jan 2022 00:49:52 -0800 Subject: [PATCH 20/23] more fixed --- .../stylerecipe/StyleRecipe_Export.json | 5 +-- .../stylerecipe/StyleRecipe_Import.json | 3 +- .../stylerecipe/StyleRecipe_List.json | 18 +------- .../preview/2022-01-01-preview/styleset.json | 45 ++++++++++++++----- 4 files changed, 40 insertions(+), 31 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json index d52de7497eca..ab99c369ec91 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json @@ -9,7 +9,7 @@ "200": { "body": { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "version": 1, + "version": "1", "created": "2021-05-21T03:04:05.678Z", "description": "Some optional description", "sources": "azuremaps://tilesets/d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", @@ -23,8 +23,7 @@ "paint": { "background-color": [] } - }, - {} + } ] } } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json index 7f4a572fff71..80cb34b4d509 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json @@ -19,8 +19,7 @@ "paint": { "background-color": [] } - }, - {} + } ] } }, diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json index 727803947aa5..aef67ef1bb5a 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json @@ -8,23 +8,9 @@ "body": { "styleRecipes": [ { - "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "version": 1, + "styleId": "9c451b0a-6527-49a7-9154-1b3d9486487f", "created": "2021-05-21T03:04:05.678Z", - "description": "Some optional description", - "sprite": "azuremaps://sprite/e33700db-127e-4ed0-bfec-7a1830eca06d", - "layers": [ - { - "id": "background", - "type": "background", - "source-layer": "bg-source", - "layout": {}, - "paint": { - "background-color": [] - } - }, - {} - ] + "description": "Some optional description" } ] } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index 2b5e81333053..3eeca31b25b2 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -83,14 +83,6 @@ "required": true, "x-ms-parameter-location": "method" }, - "TilesetId": { - "name": "tilesetId", - "description": "The Tileset Id", - "type": "string", - "in": "path", - "required": false, - "x-ms-parameter-location": "method" - }, "DescriptionStyleSet": { "name": "description", "description": "User provided description of the styleSet.", @@ -376,6 +368,37 @@ } } }, + "LayerObject": { + "description": "A layer object.", + "type": "object", + "properties": { + "id": { + "description": "The unique id for the layer.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the layer.", + "type": "string", + "readOnly": true + }, + "source-layer": { + "description": "The source layer.", + "type": "string", + "readOnly": true + }, + "layout": { + "description": "The layout of the layer.", + "type": "object", + "readOnly": true + }, + "paint": { + "description": "The paint configuration of the layer.", + "type": "object", + "readOnly": true + } + } + }, "StyleSetListItem": { "description": "Detail information for the data.", "type": "object", @@ -406,10 +429,12 @@ "readOnly": true }, "styles": { - "description": "The creation date and time of this styleSet.", + "description": "The available styles for the styleset.", "type": "array", "readOnly": true, - "items": "object" + "items": { + "$ref": "#/definitions/LayerObject" + } } } }, From 5d463713a322b2f169b5c40a42384b577ade6e39 Mon Sep 17 00:00:00 2001 From: Xubin Date: Thu, 6 Jan 2022 01:03:08 -0800 Subject: [PATCH 21/23] fix examples --- .../examples/styleset/StyleSet_List.json | 2 +- .../preview/2022-01-01-preview/styleset.json | 31 ++++++++++--------- 2 files changed, 18 insertions(+), 15 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json index c8cf9b540f49..f0d44175f515 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json @@ -9,7 +9,7 @@ "styleSets": [ { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "version": 1, + "version": "1", "created": "2021-05-21T03:04:05.678Z", "description": "My greatest style set", "defaultStyle": "indoor-light", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index 3eeca31b25b2..8e94ded2d6dd 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -309,7 +309,10 @@ ], "responses": { "200": { - "description": "Get composed styleSet style request completed successfully. The response body contains a single style." + "description": "Get composed styleSet style request completed successfully. The response body contains a single style.", + "schema": { + "type": "object" + } }, "default": { "$ref": "../../../Common/preview/1.0/common.json#/responses/default" @@ -368,32 +371,32 @@ } } }, - "LayerObject": { - "description": "A layer object.", + "StyleObject": { + "description": "A style object.", "type": "object", "properties": { - "id": { - "description": "The unique id for the layer.", + "name": { + "description": "The name for the style.", "type": "string", "readOnly": true }, - "type": { - "description": "The type of the layer.", + "displayName": { + "description": "The display name for the style.", "type": "string", "readOnly": true }, - "source-layer": { - "description": "The source layer.", + "theme": { + "description": "The theme for the style.", "type": "string", "readOnly": true }, - "layout": { - "description": "The layout of the layer.", + "thumbnail": { + "description": "The thumbnail for the style.", "type": "object", "readOnly": true }, - "paint": { - "description": "The paint configuration of the layer.", + "path": { + "description": "The path for the style.", "type": "object", "readOnly": true } @@ -433,7 +436,7 @@ "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/LayerObject" + "$ref": "#/definitions/StyleObject" } } } From f3b561c996cedb1bbad1db9f7895eed93a858c14 Mon Sep 17 00:00:00 2001 From: Xubin Date: Tue, 25 Jan 2022 12:19:01 -0800 Subject: [PATCH 22/23] Update examples and couple fixes Update examples and couple fixes --- .../stylerecipe/StyleRecipe_Export.json | 31 ++++++++++++++----- .../stylerecipe/StyleRecipe_Import.json | 27 ++++++++++++++-- .../stylerecipe/StyleRecipe_List.json | 7 +++-- .../examples/styleset/StyleSet_Create.json | 3 +- .../examples/styleset/StyleSet_Get.json | 8 ++--- .../examples/styleset/StyleSet_GetStyle.json | 7 +++-- .../examples/styleset/StyleSet_List.json | 2 +- .../2022-01-01-preview/stylerecipe.json | 27 ++++++++++++++-- .../preview/2022-01-01-preview/styleset.json | 20 +++++++++--- 9 files changed, 103 insertions(+), 29 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json index ab99c369ec91..049fdbce963b 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Export.json @@ -9,20 +9,35 @@ "200": { "body": { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "version": "1", + "version": 8, "created": "2021-05-21T03:04:05.678Z", "description": "Some optional description", - "sources": "azuremaps://tilesets/d8fa86de-bb0f-4a02-a6ff-62ae7545dd84", + "sources": { + "dcda5d1b-c835-80cd-feee-3d6351e79eda": { + "type": "vector", + "tiles": [ + "https://{{azMapsDomain}}/map/tile?api-version=2.0&tilesetId=dcda5d1b-c835-80cd-feee-3d6351e79eda&zoom={z}&x={x}&y={y}" + ], + "maxzoom": 20.0, + "minzoom": 0.0 + } + }, "sprite": "azuremaps://sprite/e33700db-127e-4ed0-bfec-7a1830eca06d", "layers": [ { - "id": "background", - "type": "background", - "source-layer": "bg-source", - "layout": {}, + "id": "indoor_unit_store", + "type": "fill", + "layout": { + "visibility": "none" + }, "paint": { - "background-color": [] - } + "fill-antialias": true, + "fill-color": "rgba(230, 230, 230, 1)", + "fill-opacity": 1, + "fill-outline-color": "rgba(120, 120, 120, 1)" + }, + "source": "dcda5d1b-c835-80cd-feee-3d6351e79eda", + "source-layer": "Indoor unit" } ] } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json index 80cb34b4d509..b1f10c2b8d33 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_Import.json @@ -4,6 +4,7 @@ "api-version": "2022-01-01-preview", "styleFormat": "mapbox", "dataFormat": "JSON", + "alias": "test-alias", "ImportContent": { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", "version": 1, @@ -15,9 +16,31 @@ "id": "background", "type": "background", "source-layer": "bg-source", - "layout": {}, + "minzoom": 18, + "maxzoom": 20, + "layout": { + "visibility": "none", + "symbol-placement": "point", + "symbol-avoid-edges": true, + "text-field": "{name}", + "text-keep-upright": true, + "text-font": ["SegoeUi-SemiBold"], + "text-letter-spacing": 0.1, + "text-size": { + "stops": [ + [18.5, 6.5], + [19, 8], + [19.5, 9.5], + [20, 11] + ] + }, + "text-anchor": "center" + }, "paint": { - "background-color": [] + "text-color": "rgb(0, 0, 0)", + "text-halo-color": "rgb(255, 255, 255)", + "text-halo-width": 1, + "text-halo-blur": 0.5 } } ] diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json index aef67ef1bb5a..26a97f8ae0a8 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/stylerecipe/StyleRecipe_List.json @@ -8,9 +8,10 @@ "body": { "styleRecipes": [ { - "styleId": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "created": "2021-05-21T03:04:05.678Z", - "description": "Some optional description" + "styleRecipeId": "9c451b0a-6527-49a7-9154-1b3d9486487f", + "description": "Some optional description", + "alias": "indoor_style_recipe", + "created": "2022-01-21T03:04:05.678Z" } ] } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json index 48bede23286f..d9882c12b04a 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json @@ -2,7 +2,8 @@ "parameters": { "geography": "us", "api-version": "2022-01-01-preview", - "styleSetId": "25084fb7-307a-4720-8f91-7952a0b91012", + "dataFormat": "zip", + "alias": "styleset-alias", "description": "This is my first styleset." }, "responses": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json index c6fd2b3048e1..d8a633722045 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Get.json @@ -8,9 +8,9 @@ "200": { "body": { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "version": 1, + "version": 1.0, "created": "2021-05-21T03:04:05.678Z", - "description": "My greatest style set", + "description": "My first style set", "defaultStyle": "indoor-light", "styles": [ { @@ -18,14 +18,14 @@ "displayName": "My cool map styling", "theme": "light", "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-light.png", - "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-light" + "url": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-light" }, { "name": "indoor-dark", "displayName": "Awesome map styling", "theme": "dark", "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-dark.png", - "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-dark" + "url": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-dark" } ] } diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json index 2107c93dcec3..f57a33e9a4bf 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_GetStyle.json @@ -3,7 +3,8 @@ "geography": "us", "api-version": "2022-01-01-preview", "styleSetId": "[styleSetId]", - "styleName": "composedStyle" + "styleName": "composedStyle", + "styleFormat": "azureMapsStyleRecipe" }, "responses": { "200": { @@ -20,8 +21,8 @@ "type": "vector" } }, - "sprite": "https://us.atlas.microsoft.com/styling/sprite/019db5fd-1792-4a84-9e39-7a82ceaea311", - "glyphs": "https://us.atlas.microsoft.com/styling/glyphs/{fontstack}/{range}.pbf", + "sprite": "https://us.atlas.microsoft.com/styles/sprites/019db5fd-1792-4a84-9e39-7a82ceaea311", + "glyphs": "https://us.atlas.microsoft.com/styles/glyphs/{fontstack}/{range}.pbf", "layers": [ { "id": "microsoft.maps.base.base.background:grayscale_light:microsoft.base", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json index f0d44175f515..5c999f7f1edc 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json @@ -9,7 +9,7 @@ "styleSets": [ { "id": "9c451b0a-6527-49a7-9154-1b3d9486487f", - "version": "1", + "version": 1.0, "created": "2021-05-21T03:04:05.678Z", "description": "My greatest style set", "defaultStyle": "indoor-light", diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json index 97c967d0229b..78e96ea99f86 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/stylerecipe.json @@ -149,6 +149,13 @@ } ] } + }, + "Alias": { + "name": "alias", + "description": "The alias of the style recipe.", + "type": "string", + "in": "query", + "required": false } }, "paths": { @@ -181,6 +188,9 @@ { "$ref": "#/parameters/DescriptionStyle" }, + { + "$ref": "#/parameters/Alias" + }, { "name": "ImportContent", "in": "body", @@ -255,6 +265,9 @@ { "$ref": "#/parameters/StyleRecipeId" }, + { + "$ref": "#/parameters/StyleFormat" + }, { "$ref": "#/parameters/TilesetId" } @@ -355,7 +368,7 @@ "description": "Detail information for the data.", "type": "object", "properties": { - "styleId": { + "styleRecipeId": { "description": "The unique styleRecipe id for the style.", "type": "string", "readOnly": true @@ -365,6 +378,11 @@ "type": "string", "readOnly": true }, + "alias": { + "description": "The alias of the style recipe.", + "type": "string", + "readOnly": true + }, "created": { "description": "The creation date and time of this styleSet.", "type": "string", @@ -391,6 +409,11 @@ "type": "string", "readOnly": true }, + "source": { + "description": "The source.", + "type": "string", + "readOnly": true + }, "layout": { "description": "The layout of the layer.", "type": "object", @@ -414,7 +437,7 @@ }, "version": { "description": "The version of the style recipe.", - "type": "string", + "type": "number", "readOnly": true }, "created": { diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json index 8e94ded2d6dd..9952a09f6295 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/styleset.json @@ -145,12 +145,19 @@ } ] } + }, + "Alias": { + "name": "alias", + "description": "The alias of the style set.", + "type": "string", + "in": "query", + "required": false } }, "paths": { "/styles/stylesets": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\n [This](https://docs.microsoft.com/en-us/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe StyleSet Create API allows the caller to create a styleSet from their styleSet configuration file.\n\n## Submit Create Request\n\nTo create your styleset you will make a `POST` request with a styleSet configration file. \n\nThe Create StyleSet API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThe StyleSet Create API allows the caller to create a styleSet from their styleSet configuration file.\n\n## Submit Create Request\n\nTo create your styleset you will make a `POST` request with a styleSet configration file. \n\nThe Create StyleSet API is a \n[long-running request](https://aka.ms/am-creator-lrt-v2).", "operationId": "StyleSet_Create", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -171,6 +178,9 @@ { "$ref": "#/parameters/DataFormat" }, + { + "$ref": "#/parameters/Alias" + }, { "$ref": "#/parameters/DescriptionStyleSet" } @@ -286,7 +296,7 @@ "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nCreator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.\n\nThis API allows the caller to export a composed style defined in the styleSet.", "operationId": "StyleSet_GetStyle", "x-ms-examples": { - "Gets the details for a single styleSet": { + "Gets the details for a single style in a styleSet": { "$ref": "./examples/styleset/StyleSet_GetStyle.json" } }, @@ -395,8 +405,8 @@ "type": "object", "readOnly": true }, - "path": { - "description": "The path for the style.", + "url": { + "description": "The url for the style.", "type": "object", "readOnly": true } @@ -418,7 +428,7 @@ }, "version": { "description": "The version of the style set.", - "type": "string", + "type": "number", "readOnly": true }, "description": { From 6d9f20fe2e699c57bafe23b2e5ad4efa383d5e45 Mon Sep 17 00:00:00 2001 From: Xubin Date: Tue, 25 Jan 2022 12:28:50 -0800 Subject: [PATCH 23/23] Fix examples Fix examples --- .../2022-01-01-preview/examples/styleset/StyleSet_Create.json | 2 +- .../2022-01-01-preview/examples/styleset/StyleSet_List.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json index d9882c12b04a..2461477b767d 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_Create.json @@ -2,7 +2,7 @@ "parameters": { "geography": "us", "api-version": "2022-01-01-preview", - "dataFormat": "zip", + "dataFormat": "ZIP", "alias": "styleset-alias", "description": "This is my first styleset." }, diff --git a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json index 5c999f7f1edc..5eaead13e6c6 100644 --- a/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json +++ b/specification/maps/data-plane/Creator/preview/2022-01-01-preview/examples/styleset/StyleSet_List.json @@ -19,14 +19,14 @@ "displayName": "My cool map styling", "theme": "light", "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-light.png", - "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-light" + "url": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-light" }, { "name": "indoor-dark", "displayName": "Awesome map styling", "theme": "dark", "thumbnail": "https://us.atlas.microsoft.com/styles/thumbnail/019db5fd-1792-4a84-9e39-7a82ceaea311/indoor-dark.png", - "path": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-dark" + "url": "https://us.atlas.microsoft.com/styles/styleSet/9c451b0a-6527-49a7-9154-1b3d9486487f/indoor-dark" } ] }