Skip to content

Commit d17ba4e

Browse files
danielthankDanny Chin
authored andcommitted
Updating Microsoft.Maps/DataRegistry from version preview/2.0 to preview/2022-12-01 (Azure#19272)
* Add DataRegistry 2022-12-01 * Add hard delete * Use Register instead of Create, Unregister instead of Delete * Fix ModelValidationFail * Add more examples and fix description * Fix prettier * Change POST to PUT for register per azure api guidelines * Return dataRegistry in register, update, and patch * Fix metadata naming * Align with LRO guideline * Add validity check in metadata * Fix error code * Add GUID pattern * Add MapsAccountGeographicResourceLocation * Fix policheck * Fix policheck * PATCH should be sync operation * Provide more information to customer for LRO operation * Another example in GetMetadata * Add example and fix description * Fix GetOperation * Remove update API * Add scope in connection object for extensibility * Fix ModelValidation * Change default of linkedReousrce * Fix issues identified by spectral * Fix GUID * Tweak * Fix review issues * Fix review issues * Add required field in data registry model * Revisit readOnly and required * Change error model to prevent from breaking change * Change version from stable to preview * Fix RequiredReadOnlyProperties error * Fix path * Fix udid description * Fix common error response to align with current Azure Maps * Use relo * Add more error codes * Fix examples * Fix description * Fix example * Fix example * Remove non-2xx error code. Add nextLink * Follow LRO guideline * Add Retry-After integer format * Rename DataRegistryList field to value * Fix review comment * Fix unregister * Change dataRegistry resource structure * Tweak * Tweak * Tweak description of msiClientId * Better naming for get data registry example Co-authored-by: Danny Chin <danielchin@microsoft.com>
1 parent 32111c4 commit d17ba4e

12 files changed

+986
-3
lines changed

specification/maps/data-plane/Common/preview/1.0/common.json

Lines changed: 90 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,67 @@
532532
"type": "string",
533533
"description": "The ontology version of this dataset.",
534534
"readOnly": true
535+
},
536+
"MapsErrorResponse": {
537+
"type": "object",
538+
"description": "Common error response for Azure Maps APIs to return error details for failed operations.",
539+
"readOnly": true,
540+
"properties": {
541+
"error": {
542+
"$ref": "#/definitions/MapsErrorDetail"
543+
}
544+
},
545+
"required": [
546+
"error"
547+
]
548+
},
549+
"MapsErrorDetail": {
550+
"description": "The error detail.",
551+
"type": "object",
552+
"readOnly": true,
553+
"properties": {
554+
"code": {
555+
"description": "One of a server-defined set of error codes.",
556+
"type": "string",
557+
"readOnly": true
558+
},
559+
"message": {
560+
"description": "A human-readable representation of the error.",
561+
"type": "string",
562+
"readOnly": true
563+
},
564+
"target": {
565+
"description": "The target of the error.",
566+
"type": "string",
567+
"readOnly": true
568+
},
569+
"details": {
570+
"description": "An array of details about specific errors that led to this reported error.",
571+
"type": "array",
572+
"items": {
573+
"$ref": "#/definitions/MapsErrorDetail"
574+
},
575+
"readOnly": true
576+
},
577+
"innererror": {
578+
"$ref": "#/definitions/MapsInnerError"
579+
}
580+
}
581+
},
582+
"MapsInnerError": {
583+
"description": "An object containing more specific information than the current object about the error.",
584+
"type": "object",
585+
"readOnly": true,
586+
"properties": {
587+
"code": {
588+
"description": "The error code.",
589+
"type": "string",
590+
"readOnly": true
591+
},
592+
"innererror": {
593+
"$ref": "#/definitions/MapsInnerError"
594+
}
595+
}
535596
}
536597
},
537598
"parameters": {
@@ -599,6 +660,32 @@
599660
"x-ms-client-default": "json",
600661
"x-ms-parameter-location": "method"
601662
},
663+
"MapsAccountGeographicResourceLocation": {
664+
"name": "geography",
665+
"description": "This parameter specifies where the Azure Maps Account is located. Valid values are us (East US, West Central US, West US 2) and eu (North Europe, West Europe).",
666+
"in": "path",
667+
"required": true,
668+
"type": "string",
669+
"enum": [
670+
"us",
671+
"eu"
672+
],
673+
"x-ms-enum": {
674+
"name": "GeographicResourceLocation",
675+
"modelAsString": true,
676+
"values": [
677+
{
678+
"value": "us",
679+
"description": "Used to access an Azure Maps Account in the United States (East US, West Central US, West US 2)."
680+
},
681+
{
682+
"value": "eu",
683+
"description": "Used to access an Azure Maps Account in Europe (North Europe, West Europe)."
684+
}
685+
]
686+
},
687+
"x-ms-parameter-location": "client"
688+
},
602689
"GeographicResourceLocation": {
603690
"name": "geography",
604691
"description": "This parameter specifies where the Azure Maps Creator resource is located. Valid values are us and eu.",
@@ -630,7 +717,7 @@
630717
"name": "view",
631718
"x-ms-client-name": "localizedMapView",
632719
"in": "query",
633-
"description": "The View parameter (also called the \"user region\" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries have different views of such regions, and the View parameter allows your application to comply with the view required by the country your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.",
720+
"description": "The View parameter (also called the \"user region\" parameter) allows you to show the correct maps for a certain country/region for geopolitically disputed regions. Different countries/regions have different views of such regions, and the View parameter allows your application to comply with the view required by the country/region your application will be serving. By default, the View parameter is set to “Unified” even if you haven’t defined it in the request. It is your responsibility to determine the location of your users, and then set the View parameter correctly for that location. Alternatively, you have the option to set ‘View=Auto’, which will return the map data based on the IP address of the request. The View parameter in Azure Maps must be used in compliance with applicable laws, including those regarding mapping, of the country/region where maps, images and other data and third party content that you are authorized to access via Azure Maps is made available. Example: view=IN.\n\nPlease refer to [Supported Views](https://aka.ms/AzureMapsLocalizationViews) for details and to see the available Views.",
634721
"x-ms-parameter-location": "method",
635722
"type": "string",
636723
"enum": [
@@ -797,7 +884,7 @@
797884
"name": "text",
798885
"x-ms-client-name": "includeText",
799886
"in": "query",
800-
"description": "Yes/no value to exclude textual data from response. Only images and country names will be in response.",
887+
"description": "Yes/no value to exclude textual data from response. Only images and country/region names will be in response.",
801888
"type": "string",
802889
"enum": [
803890
"yes",
@@ -813,7 +900,7 @@
813900
},
814901
{
815902
"value": "no",
816-
"description": "Exclude textual data from response. Only images and country names will be in response."
903+
"description": "Exclude textual data from response. Only images and country/region names will be in response."
817904
}
818905
]
819906
},

0 commit comments

Comments
 (0)