Skip to content

Commit ad23b7f

Browse files
jsedlak-microsoftjnlycklama
jsedlak-microsoft
authored and
jnlycklama
committed
Publish Microsoft Maps Search 2023-06-01 (#25991)
* Adds base for updating Search from version preview/2022-12-01-preview to version 2023-06-01 * Updates readme * Updates API version in new specs and examples * Update countryRegionSet to countryRegion and remove strictMatch strictMatch has no effect in services and creates customer confusion countryRegionSet description documents only one works. Update for clarity in GA version. * Update ForwardGeocodingByAddressLine.json example to use countryRegion parameter * Update description of countryRegion parameter * Update CountryRegion parameter description * Update search.json to document default view * Update search.json to remove supplemental terms warning * Update search.json to remove HTTP 207 * Update ForwardGeocodingBatch.json to 200 response * Update ReverseGeocodingBatch.json to 200 response * Update ForwardGeocodingBatch.json examples * Update ReverseGeocodingBatch.json examples * Stable version of common.json * Use stable version of common types * Update common.json version string * Match coordinates parameter for geocoding. polycon, reverseGeocoding * Fix reference to coordinates * Update countryRegion to be single string * Update example * Update countryRegion to be single string
1 parent d3d21e6 commit ad23b7f

File tree

11 files changed

+3432
-3
lines changed

11 files changed

+3432
-3
lines changed

‎specification/maps/data-plane/Common/stable/2023-06-01/common.json

Lines changed: 885 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/maps/data-plane/Search/readme.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ These are the global settings for Search Client.
2727
``` yaml
2828
title: SearchClient
2929
openapi-type: data-plane
30-
tag: package-preview-2022-12
30+
tag: package-2023-06
3131
add-credentials: true
3232
credential-default-policy-type: BearerTokenCredentialPolicy
3333
credential-scopes: 'https://atlas.microsoft.com/.default'
@@ -40,6 +40,14 @@ modelerfour:
4040
```
4141
4242
43+
### Tag: package-2023-06
44+
45+
These settings apply only when `--tag=package-2023-06` is specified on the command line.
46+
47+
```yaml $(tag) == 'package-2023-06'
48+
input-file:
49+
- stable/2023-06-01/search.json
50+
```
4351
### Tag: 1.0
4452

4553
These settings apply only when `--tag=1.0` is specified on the command line.
@@ -71,7 +79,7 @@ input-file:
7179

7280
These settings apply only when `--tag=package-preview-2022-09` is specified on the command line.
7381

74-
```yaml $(tag) == 'package-preview-2022-09'
82+
``` yaml $(tag) == 'package-preview-2022-09'
7583
input-file:
7684
- preview/2022-09-01-preview/search.json
7785
```
@@ -80,7 +88,7 @@ input-file:
8088

8189
These settings apply only when `--tag=package-preview-2022-12` is specified on the command line.
8290

83-
```yaml $(tag) == 'package-preview-2022-12'
91+
``` yaml $(tag) == 'package-preview-2022-12'
8492
input-file:
8593
- preview/2022-12-01-preview/search.json
8694
```

‎specification/maps/data-plane/Search/stable/2023-06-01/examples/ForwardGeocoding.json

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-06-01",
4+
"addressLine": "15127 NE 24th Street",
5+
"locality": "Redmond",
6+
"adminDistrict": "WA",
7+
"AzureKey": "[subscription-key]"
8+
},
9+
"responses": {
10+
"200": {
11+
"headers": {
12+
"Content-Type": "application/geo+json"
13+
},
14+
"body": {
15+
"type": "FeatureCollection",
16+
"features": [
17+
{
18+
"type": "Feature",
19+
"properties": {
20+
"address": {
21+
"countryRegion": {
22+
"name": "United States"
23+
},
24+
"adminDistricts": [
25+
{
26+
"shortName": "WA"
27+
},
28+
{
29+
"shortName": "King County"
30+
}
31+
],
32+
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
33+
"locality": "Redmond",
34+
"postalCode": "98052",
35+
"addressLine": "15127 NE 24th St"
36+
},
37+
"type": "Address",
38+
"confidence": "High",
39+
"matchCodes": [
40+
"Good"
41+
],
42+
"geocodePoints": [
43+
{
44+
"geometry": {
45+
"type": "Point",
46+
"coordinates": [
47+
-122.138681,
48+
47.630358
49+
]
50+
},
51+
"calculationMethod": "Rooftop",
52+
"usageTypes": [
53+
"Display"
54+
]
55+
},
56+
{
57+
"geometry": {
58+
"type": "Point",
59+
"coordinates": [
60+
-122.1386787,
61+
47.6302179
62+
]
63+
},
64+
"calculationMethod": "Rooftop",
65+
"usageTypes": [
66+
"Route"
67+
]
68+
}
69+
]
70+
},
71+
"geometry": {
72+
"type": "Point",
73+
"coordinates": [
74+
-122.138681,
75+
47.630358
76+
]
77+
},
78+
"bbox": [
79+
-122.14632282407,
80+
47.626495282429325,
81+
-122.13103917593001,
82+
47.63422071757068
83+
]
84+
}
85+
]
86+
}
87+
}
88+
}
89+
}

‎specification/maps/data-plane/Search/stable/2023-06-01/examples/ForwardGeocodingBatch.json

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-06-01",
4+
"AzureKey": "[subscription-key]",
5+
"geocodingBatchRequestBody": {
6+
"batchItems": [
7+
{
8+
"addressLine": "One, Microsoft Way, Redmond, WA 98052",
9+
"top": 2,
10+
"optionalId": "4C3681A6C8AA4AC3441412763A2A25C81444DC8B"
11+
},
12+
{
13+
"addressLine": "Pike Pl",
14+
"adminDistrict": "WA",
15+
"locality": "Seattle",
16+
"top": 3
17+
}
18+
]
19+
}
20+
},
21+
"responses": {
22+
"200": {
23+
"body": {
24+
"summary": {
25+
"successfulRequests": 1,
26+
"totalRequests": 2
27+
},
28+
"batchItems": [
29+
{
30+
"type": "FeatureCollection",
31+
"features": [
32+
{
33+
"type": "Feature",
34+
"properties": {
35+
"type": "Address",
36+
"confidence": "High",
37+
"matchCodes": [
38+
"Good"
39+
],
40+
"address": {
41+
"locality": "Redmond",
42+
"adminDistricts": [
43+
{
44+
"shortName": "WA"
45+
},
46+
{
47+
"shortName": "King"
48+
}
49+
],
50+
"countryRegion": {
51+
"ISO": "US",
52+
"name": "United States"
53+
},
54+
"postalCode": "98052",
55+
"formattedAddress": "1 Microsoft Way, Redmond, WA 98052",
56+
"addressLine": "1 Microsoft Way"
57+
},
58+
"geocodePoints": [
59+
{
60+
"geometry": {
61+
"type": "Point",
62+
"coordinates": [
63+
-122.128275,
64+
47.639429
65+
]
66+
},
67+
"calculationMethod": "Rooftop",
68+
"usageTypes": [
69+
"Display",
70+
"Route"
71+
]
72+
},
73+
{
74+
"geometry": {
75+
"type": "Point",
76+
"coordinates": [
77+
-122.127028,
78+
47.638545
79+
]
80+
},
81+
"calculationMethod": "Rooftop",
82+
"usageTypes": [
83+
"Route"
84+
]
85+
}
86+
]
87+
},
88+
"geometry": {
89+
"type": "Point",
90+
"coordinates": [
91+
-122.128275,
92+
47.639429
93+
]
94+
},
95+
"bbox": [
96+
-122.1359181505759,
97+
47.63556628242932,
98+
-122.1206318494241,
99+
47.643291717570676
100+
]
101+
}
102+
]
103+
},
104+
{
105+
"error": {
106+
"code": "Conflicting Parameters",
107+
"message": "When 'query' is present, only the following parameters are valid: 'bbox, location, view, top'. 'addressLine' was passed"
108+
}
109+
}
110+
]
111+
}
112+
}
113+
}
114+
}

‎specification/maps/data-plane/Search/stable/2023-06-01/examples/ForwardGeocodingByAddressLine.json

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
{
2+
"parameters": {
3+
"api-version": "2023-06-01",
4+
"addressLine": "15127 NE 24th Street Redmond WA",
5+
"countryRegion": "US",
6+
"AzureKey": "[subscription-key]"
7+
},
8+
"responses": {
9+
"200": {
10+
"headers": {
11+
"Content-Type": "application/geo+json"
12+
},
13+
"body": {
14+
"type": "FeatureCollection",
15+
"features": [
16+
{
17+
"type": "Feature",
18+
"properties": {
19+
"address": {
20+
"countryRegion": {
21+
"name": "United States"
22+
},
23+
"adminDistricts": [
24+
{
25+
"shortName": "WA"
26+
},
27+
{
28+
"shortName": "King County"
29+
}
30+
],
31+
"formattedAddress": "15127 NE 24th St, Redmond, WA 98052",
32+
"locality": "Redmond",
33+
"postalCode": "98052",
34+
"addressLine": "15127 NE 24th St"
35+
},
36+
"type": "Address",
37+
"confidence": "Medium",
38+
"matchCodes": [
39+
"Good"
40+
],
41+
"geocodePoints": [
42+
{
43+
"geometry": {
44+
"type": "Point",
45+
"coordinates": [
46+
-122.138681,
47+
47.630358
48+
]
49+
},
50+
"calculationMethod": "Rooftop",
51+
"usageTypes": [
52+
"Display"
53+
]
54+
},
55+
{
56+
"geometry": {
57+
"type": "Point",
58+
"coordinates": [
59+
-122.1386787,
60+
47.6302179
61+
]
62+
},
63+
"calculationMethod": "Rooftop",
64+
"usageTypes": [
65+
"Route"
66+
]
67+
}
68+
]
69+
},
70+
"geometry": {
71+
"type": "Point",
72+
"coordinates": [
73+
-122.138681,
74+
47.630358
75+
]
76+
},
77+
"bbox": [
78+
-122.14632282407,
79+
47.626495282429325,
80+
-122.13103917593001,
81+
47.63422071757068
82+
]
83+
}
84+
]
85+
}
86+
}
87+
}
88+
}

0 commit comments

Comments
 (0)