Skip to content

Updated the description for the boundingBox property of the address object #38554

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FarazGIS merged 1 commit into from
Nov 6, 2025
Merged

Updated the description for the boundingBox property of the address object #38554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion specification/maps/data-plane/Search/stable/1.0/search.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{

Check notice on line 1 in specification/maps/data-plane/Search/stable/1.0/search.json

View workflow job for this annotation

GitHub Actions / TypeSpec Requirement 

Your service description will soon be required to convert from OpenAPI to TypeSpec. See https://aka.ms/azsdk/typespec.
"swagger": "2.0",
"info": {
"title": "Azure Maps Search Service",
Expand Down Expand Up @@ -2490,7 +2490,8 @@
"readOnly": true
},
"boundingBox": {
"$ref": "#/definitions/BoundingBoxCompassNotation"
"$ref": "#/definitions/BoundingBoxCompassNotation",
"description": "Defines the bounding box for the location. This property is only returned by the Search Address Reverse APIs. All other Search APIs return the `viewport` property of the `SearchAddressResultItem` object."

@FarazGIS FarazGIS Nov 3, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stevemunk Don't we need to update the following line for bbox description?

"BoundingBoxCompassNotation": {
"description": "The bounding box of the location.",

azure-rest-api-specs/specification/maps/data-plane/Search/stable/1.0/search.json

Line 2527 in 43095bb

"description": "The bounding box of the location.",

@stevemunk stevemunk Nov 5, 2025

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No. By doing that, you will also update the description for the BoundingBoxCompassNotation object:

image

The approach I used will not change that description, but will change the description that appears in the address objects boundingBox property:

image

}
}
},
Expand Down