{"id":34791558,"url":"https://github.com/woosmap/openapi-specification","last_synced_at":"2026-04-21T08:03:45.798Z","repository":{"id":38340906,"uuid":"433898778","full_name":"Woosmap/openapi-specification","owner":"Woosmap","description":"OpenAPI specification for Woosmap Platform","archived":false,"fork":false,"pushed_at":"2026-04-16T09:54:14.000Z","size":9638,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":10,"default_branch":"master","last_synced_at":"2026-04-16T11:38:39.527Z","etag":null,"topics":["openapi"],"latest_commit_sha":null,"homepage":"https://developers.woosmap.com/api-reference/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Woosmap.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-12-01T16:17:21.000Z","updated_at":"2026-04-16T09:54:16.000Z","dependencies_parsed_at":"2023-10-13T00:14:21.170Z","dependency_job_id":"d3b8df06-586f-45d8-912c-dd4c03ec41fc","html_url":"https://github.com/Woosmap/openapi-specification","commit_stats":null,"previous_names":[],"tags_count":91,"template":false,"template_full_name":null,"purl":"pkg:github/Woosmap/openapi-specification","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Woosmap%2Fopenapi-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Woosmap%2Fopenapi-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Woosmap%2Fopenapi-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Woosmap%2Fopenapi-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Woosmap","download_url":"https://codeload.github.com/Woosmap/openapi-specification/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Woosmap%2Fopenapi-specification/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32082782,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-21T06:27:27.065Z","status":"ssl_error","status_checked_at":"2026-04-21T06:27:21.250Z","response_time":128,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["openapi"],"created_at":"2025-12-25T10:00:15.208Z","updated_at":"2026-04-21T08:03:45.794Z","avatar_url":"https://github.com/Woosmap.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Woosmap OpenAPI3 Specification\n\nView the documentation here:\n\u003chttps://developers.woosmap.com/api-reference/\u003e\n\n## Description\n\nAn OpenAPI specification for Woosmap Platform.\n\n| API                                                                              | Status   |\n|----------------------------------------------------------------------------------|----------|\n| [Geolocation](https://developers.woosmap.com/products/geolocation-api/location/) | Complete |\n| [Stores](https://developers.woosmap.com/products/stores-api/overview/)           | Complete |\n| [Localities](https://developers.woosmap.com/products/localities/get-started/)    | Complete |\n| [Distance](https://developers.woosmap.com/products/distance-api/get-started/)    | Complete |\n| [Transit](https://developers.woosmap.com/products/transit-api/route-endpoint/)   | Complete |\n| [Indoor](https://developers.woosmap.com/products/indoor-api/get-started/)        | Complete |\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/18437534-dad12f37-6d84-42d1-9889-2f529aee0ab9?action=collection%2Ffork\u0026source=rip_markdown\u0026collection-url=entityId%3D18437534-dad12f37-6d84-42d1-9889-2f529aee0ab9%26entityType%3Dcollection%26workspaceId%3Dff0698d5-c4db-403e-b7c6-b622b68032d3)\n\n## Development\n\nThe repository makes use of [Bazel](https://bazel.build/) to generate outputs from the specification and sample\nrequests.\n\n### Build and test\n\nTo be able to build the spec locally, you'll need a github personal access token (mandatory for merging with auto\ngenerated spec such as Woosmap x What3Words).\nGenerate one with repository access here: \u003chttps://github.com/settings/tokens\u003e.\nTo be able to generate responses, you'll need a woosmap public key and woosmap private key.\nOnce generated, it's convenient to add these environment variables in the file `.bazelrc.user` at the root of the\nrepository like this:\n\n```bash\nbuild --action_env GH_TOKEN=ghp_xxxxxxxxx\nrun --action_env WOOSMAP_PUBLIC_API_KEY=woos-xxxxxxxx\nrun --action_env WOOSMAP_PRIVATE_API_KEY=da4e8e73-xxxxx-xxxx\n```\n\nThen you'll be able to execute following command.\n\n1. `npm i`\n2. `npm run build`\n\n   This generates the following outputs in the dist folder:\n\n    - YAML file containing OpenAPI3 specification\n    - JSON file containing OpenAPI3 specification\n    - Structure Markdown documents for specification objects\n    - Code snippets in multiple languages for sample requests\n\n   \u003e **Note**: The `dist/` folder is included in this repo and should be updated with all changes.\n\n   \u003e **Note**: If a documentation item is not generated, be sure it is included\n   in the appropriate index.yml file.\n\n3. `npm run responses` (optional)\n   \u003e **Note**: This is an optional step requiring an API key. Set the `WOOSMAP_PUBLIC_API_KEY`\n   and `WOOSMAP_PRIVATE_API_KEY` environmental variable before running.\n\n   \u003e **Warning**: Data attached to the `WOOSMAP_PRIVATE_API_KEY` will be deleted. Use an empty test project for this.\n\n   \u003e **Note**: This step only needs to run when the generation code or sample requests have been updated.\n\n   \u003e **Note**: A single response can be updated similar to `npm run responses -- --only woosmap_http_address_details`.\n\n4. `npm run samples` (optional)\n\n   \u003e **Note**: Generates snippets from requests to be integrated as xCodeSamples in path schemas.\n\n5. `npm run test`\n\n   Validate the OpenAPI Schema\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwoosmap%2Fopenapi-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwoosmap%2Fopenapi-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwoosmap%2Fopenapi-specification/lists"}