{"id":13880854,"url":"https://github.com/googlemaps/openapi-specification","last_synced_at":"2025-06-22T03:42:44.691Z","repository":{"id":38818315,"uuid":"338380906","full_name":"googlemaps/openapi-specification","owner":"googlemaps","description":"OpenAPI specification for Google Maps Platform API","archived":false,"fork":false,"pushed_at":"2025-04-14T08:54:24.000Z","size":19885,"stargazers_count":108,"open_issues_count":34,"forks_count":89,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-21T08:14:06.425Z","etag":null,"topics":["google","google-maps","openapi"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/googlemaps.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":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-12T17:04:44.000Z","updated_at":"2025-04-04T04:10:32.000Z","dependencies_parsed_at":"2023-02-18T11:17:41.204Z","dependency_job_id":"930cdb3d-8864-4f6f-ba3d-e311fb2177f7","html_url":"https://github.com/googlemaps/openapi-specification","commit_stats":null,"previous_names":[],"tags_count":126,"template":false,"template_full_name":null,"purl":"pkg:github/googlemaps/openapi-specification","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googlemaps%2Fopenapi-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googlemaps%2Fopenapi-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googlemaps%2Fopenapi-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googlemaps%2Fopenapi-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/googlemaps","download_url":"https://codeload.github.com/googlemaps/openapi-specification/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/googlemaps%2Fopenapi-specification/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261232849,"owners_count":23128169,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["google","google-maps","openapi"],"created_at":"2024-08-06T08:03:32.960Z","updated_at":"2025-06-22T03:42:39.678Z","avatar_url":"https://github.com/googlemaps.png","language":"TypeScript","readme":"# Google Maps Platform OpenAPI3 Specification\n\n![Build](https://github.com/googlemaps/openapi-specification/workflows/Test/badge.svg)\n![Release](https://github.com/googlemaps/openapi-specification/workflows/Release/badge.svg)\n![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/openapi-specification?color=green)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity)\n\n## Description\n\nAn OpenAPI specification for Google Maps Platform APIs.\n\n| API                | Status       |\n| ------------------ | ------------ |\n| Elevation          | **Complete** |\n| GeoCoding          | **Complete** |\n| GeoLocation        | **Complete** |\n| Distance           | **Complete** |\n| Roads              | **Complete** |\n| Time Zone          | **Complete** |\n| Directions         | **Complete** |\n| Places             | **Complete** |\n| Street View        | **Complete** |\n| Maps Static        | Not Started  |\n\n\u003e **Note**: New APIs will be documented using Google Discovery documents and Protobuf files.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/13440387-fc4788d5-77f9-4639-a4c5-74a2878d7eb5?action=collection%2Ffork\u0026collection-url=entityId%3D13440387-fc4788d5-77f9-4639-a4c5-74a2878d7eb5%26entityType%3Dcollection%26workspaceId%3D047c6f75-6b23-42df-b77a-70d716895d9f)\n\n## Development\n\nThe repository makes use of [Bazel](https://bazel.build/) to generate outputs from the specification and sample requests.\n\n### Build and test\n1. `npm i`\n\n1. `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**: There is a bot that can be triggered in a pull request with a comment containing `/update-dist`. See the workflow at https://github.com/googlemaps/openapi-specification/blob/main/.github/workflows/command.yml.\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\n1. `npm run responses` (optional)\n\n    \u003e **Note**: This is an optional step requiring an API key. Set the `GOOGLE_MAPS_API_KEY` environmental variable before running.\n\n    \u003e **Note**: This step only needs to run when the generation code or sample requests have been updated.\n\n    \u003e **Note**: The geolocation request that only provides an IP is not deterministic and skipped in the binary executed.\n\n    \u003e **Note**: A single response can be updated similar to `npm run responses -- --only maps_http_places_nearbysearch`.\n\n1. `npm run test`\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgooglemaps%2Fopenapi-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgooglemaps%2Fopenapi-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgooglemaps%2Fopenapi-specification/lists"}