Skip to content

Commit

Permalink
Fix broken links for Azure Maps API resulting from TOC changes. (#27443)
Browse files Browse the repository at this point in the history
* Update readme.md: Common/stable/2023-06-01

current: Common/stable/2023-07-01
Updated: Common/stable/2023-06-01

* updated URLs to Azure Maps and Azure Maps Creator REST API.

* updated URLs from 'search-v2' to 'search'.

* updated URLs to Azure Maps Creator REST API.

* updated URL to Azure Maps Creator REST API.

* Added 'geocodingresponse' to cspell.json. Also added the 'INVALID_TYPE' Suppression to the Creator Readme (also added in PR27357).
  • Loading branch information
stevemunk authored Jan 19, 2024
1 parent 8df53db commit e8c4e08
Show file tree
Hide file tree
Showing 14 changed files with 81 additions and 72 deletions.
6 changes: 6 additions & 0 deletions cSpell.json
Original file line number Diff line number Diff line change
Expand Up @@ -803,6 +803,12 @@
"getclosestpoint"
]
},
{
"filename": "**/specification/maps/data-plane/Search/stable/2023-06-01/search.json",
"words": [
"geocodingresponse"
]
},
{
"filename": "**/specification/communication/data-plane/Chat/preview/2020-09-21-preview2/communicationserviceschat.json",
"words": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
},
"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/rest/api/maps/v2/conversion/convert) and may be provided with multiple query parameters with same name (if more than one is provided).",
"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](/rest/api/maps-creator/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,
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@
},
"DatasetIdForCreate": {
"name": "datasetId",
"description": "The datasetId must have been obtained from a successful [Dataset Create API](https://docs.microsoft.com/rest/api/maps/v2/dataset/create) call.",
"description": "The datasetId must have been obtained from a successful [Dataset Create API](/rest/api/maps-creator/dataset/create) call.",
"type": "string",
"in": "query",
"required": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
},
"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/rest/api/maps/v2/dataset/create) call.",
"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](/rest/api/maps-creator/dataset/create) call.",
"type": "string",
"in": "query",
"required": true,
Expand Down
16 changes: 8 additions & 8 deletions specification/maps/data-plane/Creator/preview/2.0/wfs.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@
"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](/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](/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](/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 you [Create an Azure Maps account](https://docs.microsoft.com/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](https://docs.microsoft.com/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"description": "This is a shared key that is provisioned when you [Create an Azure Maps account](/azure/azure-maps/quick-demo-map-app#create-an-azure-maps-account) in the Azure portal or using PowerShell, CLI, Azure SDKs, or REST API.\n\n With this key, any application can access all REST API. In other words, this key can be used as a master key in the account that they are issued in.\n\n For publicly exposed applications, our recommendation is to use the [confidential client applications](/azure/azure-maps/authentication-best-practices#confidential-client-applications) approach to access Azure Maps REST APIs so your key can be securely stored.",
"name": "subscription-key",
"in": "query"
},
Expand Down Expand Up @@ -68,15 +68,15 @@
},
"ConversionIdQuery": {
"name": "conversionId",
"description": "ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service [Convert API](https://docs.microsoft.com/rest/api/maps/v2/conversion/convert). Only one conversionId can be provided per API call. **conversionId and udid are mutually exclusive parameters.**",
"description": "ID to create the dataset. The `conversionId` must be obtained from a successful call to the Conversion Service [Convert API](/rest/api/maps-creator/conversion/convert). Only one conversionId can be provided per API call. **conversionId and udid are mutually exclusive parameters.**",
"type": "string",
"in": "query",
"required": false,
"x-ms-parameter-location": "method"
},
"Udid": {
"name": "udid",
"description": "ID to create the dataset. The `udid` can be obtained from uploading data using [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data-v2). Only one udid can be provided per API call. **outputOntology parameter must be provided with the udid. conversionId and udid are mutually exclusive parameters.**",
"description": "ID to create the dataset. The `udid` can be obtained from uploading data using [Azure Maps Data Service](/rest/api/maps/data). Only one udid can be provided per API call. **outputOntology parameter must be provided with the udid. conversionId and udid are mutually exclusive parameters.**",
"type": "string",
"in": "query",
"required": false,
Expand Down Expand Up @@ -131,7 +131,7 @@
"paths": {
"/datasets": {
"post": {
"description": "This API allows the caller to create a dataset from data that was uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data-v2) and converted using the [Azure Maps Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion). You can also create a dataset directly using data uploaded to the [Azure Maps Data Service](https://docs.microsoft.com/rest/api/maps/data-v2), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](https://docs.microsoft.com/azure/azure-maps/creator-facility-ontology) format.\n\nFor more information on how to create a dataset from a zip of GeoJSON files, please visit this [article](https://aka.ms/howtofacilitygeojson)\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).",
"description": "This API allows the caller to create a dataset from data that was uploaded to the [Azure Maps Data Service](/rest/api/maps/data) and converted using the [Azure Maps Conversion Service](/rest/api/maps-creator/conversion). You can also create a dataset directly using data uploaded to the [Azure Maps Data Service](/rest/api/maps/data), provided that the uploaded data is a zip of GeoJSON files conforming to the [facility ontology](/azure/azure-maps/creator-facility-ontology) format.\n\nFor more information on how to create a dataset from a zip of GeoJSON files, please visit this [article](https://aka.ms/howtofacilitygeojson)\n\n### Submit Create Request\n\nTo create your dataset, issue a `POST` request with the required parameters. The Create API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).",
"operationId": "Dataset_Create",
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
Expand Down
Loading

0 comments on commit e8c4e08

Please sign in to comment.