Skip to content

Commit 2a9e7c8

Browse files
cmillettclaude
andcommitted
Restructure Stores API as its own heading with separate sub-tags
Split the single "Stores API" tag into three separate tags (Store Search, Data Management, Zones) under a new "Stores API" tag group heading, matching the pattern used by "Map" and "Distance". Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 08262f5 commit 2a9e7c8

17 files changed

Lines changed: 33 additions & 25 deletions

redocly/redocly-merged-config.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,16 @@ apis:
116116
tagGroups:
117117
- name: "Search"
118118
tags:
119-
- "Stores API"
120119
- "Geolocation API"
121120
- "Localities API"
122121
- "Address API"
123122
- "Datasets API"
124123
- "Woosmap for what3words API"
124+
- name: "Stores"
125+
tags:
126+
- "Store Search"
127+
- "Data Management"
128+
- "Zones"
125129
- name: "Map"
126130
tags:
127131
- "Static Map API"

redocly/redocly-validate-config.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ rules:
1212
severity: error
1313
requireOperationTags: true
1414
expectedNames:
15-
- "Stores API"
15+
- "Store Search"
16+
- "Data Management"
17+
- "Zones"
1618
- "Geolocation API"
1719
- "Localities API"
1820
- "Address API"

specification/index.yml

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,17 @@ security:
5656
- PrivateApiKeyAuth: []
5757
- PrivateApiKeyHeaderAuth: []
5858
tags:
59-
- name: Stores API
59+
- name: Search
6060
description: >
61-
Stores API lets you query the Assets which are returned as a [GeoJson](https://geojson.org/).
61+
Store Search lets you query the Assets which are returned as a [GeoJson](https://geojson.org/).
6262
Request is done over HTTPS using GET.
6363
You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key.
6464
This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).
6565
If your request returns a high number of assets, the result will be paginated. If so, you can request assets by page using `page` and `stores_by_page` parameters (Default is **100**, max is **300**).
66-
67-
## Data Management
68-
66+
externalDocs:
67+
url: https://developers.woosmap.com/products/stores-api/overview/
68+
- name: Data Management
69+
description: >
6970
Manage the store and asset data within your Woosmap project. It provides full CRUD (Create, Read, Update, Delete) operations
7071
through standard HTTP methods, supporting batch imports up to 15MB, along with an atomic replace operation for swapping
7172
entire datasets without downtime.
@@ -79,9 +80,10 @@ tags:
7980
```
8081
POST|GET|PUT|DELETE https://api.woosmap.com/stores
8182
```
82-
83-
## Zones
84-
83+
externalDocs:
84+
url: https://developers.woosmap.com/products/stores-api/overview/
85+
- name: Zones
86+
description: >
8587
The Zones Endpoint lets you associate geographic polygons (zones) with your stores and then search for stores whose zone
8688
contains a specific point. Unlike distance-based search, which relies on straight-line proximity, zone-based search accounts
8789
for real-world boundaries like delivery areas, service regions, or franchise territories.
@@ -122,7 +124,7 @@ tags:
122124
Request is done over HTTPS using GET. Response is formatted as JSON.
123125
You must specify a key in your request, included as the value of a `key` parameter for your public key or `private_key` for your private key.
124126
This key identifies your application for purposes of quota management. Learn how to [get a key](https://developers.woosmap.com/support/api-keys/).
125-
127+
126128
>**⚠️ This API has been deprecated in favour of Localities API**
127129
externalDocs:
128130
url: https://developers.woosmap.com/products/address-api/get-started/

specification/paths/search/storesAutocomplete.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
servers:
22
- url: https://api.woosmap.com
33
tags:
4-
- Stores API
4+
- Store Search
55
description: >
66
Autocomplete on `localizedNames` with highlighted results on asset name.
77
Use the field `localized` in your query parameter to search for localized names.

specification/paths/search/storesBounds.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
servers:
22
- url: https://api.woosmap.com
33
tags:
4-
- Stores API
4+
- Store Search
55
description: >
66
Used to retrieve Bounds for assets.
77
security:

specification/paths/search/storesSearch.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
servers:
22
- url: https://api.woosmap.com
33
tags:
4-
- Stores API
4+
- Store Search
55
description: >
66
Used to retrieve assets from query.
77
security:

specification/paths/stores/storeGet.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
servers:
22
- url: https://api.woosmap.com
33
tags:
4-
- Stores API
4+
- Data Management
55
description: >
66
Used to retrieve an asset from his `storeId`
77
security:

specification/paths/stores/storesCreate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
servers:
22
- url: https://api.woosmap.com
33
tags:
4-
- Stores API
4+
- Data Management
55
description: >
66
Used to batch create Assets to a specific project identified with the `private_key` parameter.
77
security:

specification/paths/stores/storesDelete.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
servers:
33
- url: https://api.woosmap.com
44
tags:
5-
- Stores API
5+
- Data Management
66
description: >
77
Used to delete one or more assets. The `storeId` specified in `query` parameter is the id of the asset to delete. To delete several assets, use the comma as a separator.
88
To delete all project assets, omit the `query` parameter.

specification/paths/stores/storesReplace.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
servers:
22
- url: https://api.woosmap.com
33
tags:
4-
- Stores API
4+
- Data Management
55
description: To replace all your Assets. This endpoint will delete all previous assets and import assets in request body.
66
During the operation previous assets could always be displayed on map.
77
If the import failed previous assets are not deleted.

0 commit comments

Comments
 (0)