Skip to content

Commit 3b2430b

Browse files
stevemunkstevemunk
authored
Update address object properties (#38675)
* Updated address object property descriptions. * Updated address object property descriptions. * Updated address object property descriptions.
1 parent d4678f5 commit 3b2430b

File tree

1 file changed

+33
-33
lines changed
  • specification/maps/data-plane/Search/stable/1.0

1 file changed

+33
-33
lines changed

‎specification/maps/data-plane/Search/stable/1.0/search.json‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1025,7 +1025,7 @@
10251025
"name": "number",
10261026
"x-ms-client-name": "streetNumber",
10271027
"in": "query",
1028-
"description": "Street number as a string. If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number",
1028+
"description": "Street number as a string. If a number is sent in along with the request, the response may include the side of the street (Left/Right) and also an offset position for that number.",
10291029
"type": "string"
10301030
},
10311031
{
@@ -1199,7 +1199,7 @@
11991199
{
12001200
"name": "crossStreet",
12011201
"in": "query",
1202-
"description": "The cross street name for the structured address",
1202+
"description": "The cross street name for the structured address.",
12031203
"type": "string"
12041204
},
12051205
{
@@ -2371,32 +2371,32 @@
23712371
}
23722372
},
23732373
"Address": {
2374-
"description": "The address of the result",
2374+
"description": "The address of the result.",
23752375
"type": "object",
23762376
"readOnly": true,
23772377
"properties": {
23782378
"buildingNumber": {
2379-
"description": "The building number on the street.\n**Important**: This property is *deprecated*. Use `streetNumber` instead.",
2379+
"description": "The building number on the street.\n\n**Important**: This property is *deprecated*. Use `streetNumber` instead.",
23802380
"type": "string",
23812381
"readOnly": true
23822382
},
23832383
"street": {
2384-
"description": "The street name.\n**Important**: This property is *deprecated*. Use `streetName` instead.",
2384+
"description": "The street name.\n\n**Important**: This property is *deprecated*. Use `streetName` instead.",
23852385
"type": "string",
23862386
"readOnly": true
23872387
},
23882388
"crossStreet": {
2389-
"description": "The name of the street being crossed.",
2389+
"description": "The name of the street being crossed.\n\nThis property is only available in the `Get Search Address Reverse Cross Street` API.",
23902390
"type": "string",
23912391
"readOnly": true
23922392
},
23932393
"streetNumber": {
2394-
"description": "The building number on the street.",
2394+
"description": "The building number on the street.\n\nNot available in the `Get Search Address Reverse Cross Street` API.",
23952395
"type": "string",
23962396
"readOnly": true
23972397
},
23982398
"routeNumbers": {
2399-
"description": "The codes used to unambiguously identify the street",
2399+
"description": "The codes used to unambiguously identify the street.\n\nOnly available for the Search Address Reverse APIs.",
24002400
"type": "array",
24012401
"items": {
24022402
"type": "string",
@@ -2410,7 +2410,7 @@
24102410
"readOnly": true
24112411
},
24122412
"streetNameAndNumber": {
2413-
"description": "The street name and number.\nOnly available for the Search Address Reverse APIs.",
2413+
"description": "The street name and number.\n\nOnly available for the Search Address Reverse APIs.",
24142414
"type": "string",
24152415
"readOnly": true
24162416
},
@@ -2420,67 +2420,67 @@
24202420
"readOnly": true
24212421
},
24222422
"municipality": {
2423-
"description": "City / Town <BR>Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it’s suggested that the `localName` value be used instead of the `municipality` value.",
2423+
"description": "City / Town <BR>Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it's suggested that the `localName` value be used instead of the `municipality` value.",
24242424
"type": "string",
24252425
"readOnly": true
24262426
},
2427-
"municipalitySubdivision": {
2428-
"description": "Sub / Super City",
2427+
"countrySubdivision": {
2428+
"description": "The primary administrative division within a country, such as a state, province. It is used to represent the first-level subdivision below the national level.",
24292429
"type": "string",
24302430
"readOnly": true
24312431
},
2432-
"countrySubdivision": {
2433-
"description": "State or Province",
2432+
"countrySecondarySubdivision": {
2433+
"description": "The second-level administrative division within a country/region. It identifies a subdivision that is below the primary subdivision, such as state or province, but above smaller units like municipalities or neighborhoods. Examples include *County* in the United States and *District* in the United Kingdom.",
24342434
"type": "string",
24352435
"readOnly": true
24362436
},
2437-
"countrySubdivisionCode": {
2438-
"description": "`countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario.",
2437+
"countryTertiarySubdivision": {
2438+
"description": "The third-level administrative division within a country/region. It provides even finer granularity than the secondary subdivision (such as county or district). Examples include municipalities such as a city, town, village, borough, or township and neighborhoods a smaller, informal geographic area within a municipality such as Capitol Hill, Green Lake, and Wallingford in Seattle.",
24392439
"type": "string",
24402440
"readOnly": true
24412441
},
2442-
"countryTertiarySubdivision": {
2443-
"description": "Named Area",
2442+
"municipalitySubdivision": {
2443+
"description": "A subdivision within a municipality. It represents a smaller administrative or geographic unit inside a city, town, or other municipal entity.",
24442444
"type": "string",
24452445
"readOnly": true
24462446
},
2447-
"countrySecondarySubdivision": {
2448-
"description": "County",
2447+
"countrySubdivisionName": {
2448+
"description": "Represents the full name of the first-level administrative division (such as state, province, or region) within a country or region. This property is included only when the `countrySubdivision` value is provided in abbreviated form. Currently supported for the United States, Canada, and the United Kingdom.",
24492449
"type": "string",
24502450
"readOnly": true
24512451
},
2452-
"postalCode": {
2453-
"description": "Postal Code / Zip Code",
2452+
"countrySubdivisionCode": {
2453+
"description": "`countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario.\n\nThis property is not available in the `Get Search Nearby` and `Get Search POI` API.",
24542454
"type": "string",
24552455
"readOnly": true
24562456
},
2457-
"extendedPostalCode": {
2458-
"description": "Extended postal code (availability is dependent on the region).",
2457+
"postalCode": {
2458+
"description": "A series of numbers or letters (or both) added to an address to help identify a specific geographic area. A ZIP Code is the U.S. version of a postal code, other countries/regions use other formats such as Postcode, PIN Code and PLZ.",
24592459
"type": "string",
24602460
"readOnly": true
24612461
},
2462-
"countryCode": {
2463-
"description": "Country (Note: This is a two-letter code, not a country/region name.)",
2462+
"extendedPostalCode": {
2463+
"description": "An extended postal code refers to a postal code format that goes beyond the standard set of digits to provide greater location precision. It is commonly used in systems like the U.S. ZIP+4 code or similar extended formats in other countries/regions. Availability is dependent on the region.\n\nNot available in the `Get Search Address Reverse Cross Street` API.",
24642464
"type": "string",
24652465
"readOnly": true
24662466
},
24672467
"country": {
2468-
"description": "country/region name",
2468+
"description": "The country/region name.",
24692469
"type": "string",
24702470
"readOnly": true
24712471
},
2472-
"countryCodeISO3": {
2473-
"description": "ISO alpha-3 country code",
2472+
"countryCode": {
2473+
"description": "A two-letter alphabetic code defined by the ISO 3166-1 Alpha-2 standard to represent a country/region and dependent territories.",
24742474
"type": "string",
24752475
"readOnly": true
24762476
},
2477-
"freeformAddress": {
2478-
"description": "An address line formatted according to the formatting rules of a Result's country/region of origin, or in the case of a country/region, its full country/region name.",
2477+
"countryCodeISO3": {
2478+
"description": "A three-letter alphabetic code defined by the ISO 3166-1 Alpha-3 standard to represent a country/region and dependent territories.",
24792479
"type": "string",
24802480
"readOnly": true
24812481
},
2482-
"countrySubdivisionName": {
2483-
"description": "The full name of a first level of country/region administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and United Kingdom.",
2482+
"freeformAddress": {
2483+
"description": "An address line formatted according to the formatting rules of a result's country/region of origin, or in the case of a country/region, its full country/region name.",
24842484
"type": "string",
24852485
"readOnly": true
24862486
},

0 commit comments

Comments
 (0)