https://github.com/woosmap/openapi-specification
OpenAPI specification for Woosmap Platform
https://github.com/woosmap/openapi-specification
openapi
Last synced: 2 months ago
JSON representation
OpenAPI specification for Woosmap Platform
- Host: GitHub
- URL: https://github.com/woosmap/openapi-specification
- Owner: Woosmap
- License: mit
- Created: 2021-12-01T16:17:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2026-04-16T09:54:14.000Z (3 months ago)
- Last Synced: 2026-04-16T11:38:39.527Z (3 months ago)
- Topics: openapi
- Language: TypeScript
- Homepage: https://developers.woosmap.com/api-reference/
- Size: 9.19 MB
- Stars: 0
- Watchers: 10
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Woosmap OpenAPI3 Specification
View the documentation here:
## Description
An OpenAPI specification for Woosmap Platform.
| API | Status |
|----------------------------------------------------------------------------------|----------|
| [Geolocation](https://developers.woosmap.com/products/geolocation-api/location/) | Complete |
| [Stores](https://developers.woosmap.com/products/stores-api/overview/) | Complete |
| [Localities](https://developers.woosmap.com/products/localities/get-started/) | Complete |
| [Distance](https://developers.woosmap.com/products/distance-api/get-started/) | Complete |
| [Transit](https://developers.woosmap.com/products/transit-api/route-endpoint/) | Complete |
| [Indoor](https://developers.woosmap.com/products/indoor-api/get-started/) | Complete |
[](https://god.gw.postman.com/run-collection/18437534-dad12f37-6d84-42d1-9889-2f529aee0ab9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D18437534-dad12f37-6d84-42d1-9889-2f529aee0ab9%26entityType%3Dcollection%26workspaceId%3Dff0698d5-c4db-403e-b7c6-b622b68032d3)
## Development
The repository makes use of [Bazel](https://bazel.build/) to generate outputs from the specification and sample
requests.
### Build and test
To be able to build the spec locally, you'll need a github personal access token (mandatory for merging with auto
generated spec such as Woosmap x What3Words).
Generate one with repository access here: .
To be able to generate responses, you'll need a woosmap public key and woosmap private key.
Once generated, it's convenient to add these environment variables in the file `.bazelrc.user` at the root of the
repository like this:
```bash
build --action_env GH_TOKEN=ghp_xxxxxxxxx
run --action_env WOOSMAP_PUBLIC_API_KEY=woos-xxxxxxxx
run --action_env WOOSMAP_PRIVATE_API_KEY=da4e8e73-xxxxx-xxxx
```
Then you'll be able to execute following command.
1. `npm i`
2. `npm run build`
This generates the following outputs in the dist folder:
- YAML file containing OpenAPI3 specification
- JSON file containing OpenAPI3 specification
- Structure Markdown documents for specification objects
- Code snippets in multiple languages for sample requests
> **Note**: The `dist/` folder is included in this repo and should be updated with all changes.
> **Note**: If a documentation item is not generated, be sure it is included
in the appropriate index.yml file.
3. `npm run responses` (optional)
> **Note**: This is an optional step requiring an API key. Set the `WOOSMAP_PUBLIC_API_KEY`
and `WOOSMAP_PRIVATE_API_KEY` environmental variable before running.
> **Warning**: Data attached to the `WOOSMAP_PRIVATE_API_KEY` will be deleted. Use an empty test project for this.
> **Note**: This step only needs to run when the generation code or sample requests have been updated.
> **Note**: A single response can be updated similar to `npm run responses -- --only woosmap_http_address_details`.
4. `npm run samples` (optional)
> **Note**: Generates snippets from requests to be integrated as xCodeSamples in path schemas.
5. `npm run test`
Validate the OpenAPI Schema