{"id":50722306,"url":"https://github.com/pushpad/pushpad-openapi","last_synced_at":"2026-06-10T01:02:59.748Z","repository":{"id":314811235,"uuid":"1056303951","full_name":"pushpad/pushpad-openapi","owner":"pushpad","description":"Pushpad OpenAPI Specification","archived":false,"fork":false,"pushed_at":"2025-10-01T14:45:36.000Z","size":41,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-10-01T16:34:18.619Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Makefile","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/pushpad.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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":"2025-09-13T20:01:07.000Z","updated_at":"2025-10-01T14:45:40.000Z","dependencies_parsed_at":"2025-09-15T00:22:55.508Z","dependency_job_id":"e92350fe-947d-46fa-881a-ed70937c0957","html_url":"https://github.com/pushpad/pushpad-openapi","commit_stats":null,"previous_names":["pushpad/pushpad-openapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pushpad/pushpad-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pushpad%2Fpushpad-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pushpad%2Fpushpad-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pushpad%2Fpushpad-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pushpad%2Fpushpad-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pushpad","download_url":"https://codeload.github.com/pushpad/pushpad-openapi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pushpad%2Fpushpad-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34132031,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":[],"created_at":"2026-06-10T01:02:58.804Z","updated_at":"2026-06-10T01:02:59.737Z","avatar_url":"https://github.com/pushpad.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pushpad OpenAPI Specification\n\n![Build Status](https://github.com/pushpad/pushpad-openapi/workflows/CI/badge.svg)\n[![Download OpenAPI Spec](https://img.shields.io/badge/Download-OpenAPI%20Spec-blue)](https://pushpad.xyz/openapi.yaml)\n\nThe OpenAPI specification for Web Push Notifications using [Pushpad](https://pushpad.xyz).\n\n## What is OpenAPI?\n\nFrom the [OpenAPI Specification](https://swagger.io/specification/):\n\n\u003e The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.\n\n\u003e An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.\n\n## Project Status\n\nThe Pushpad OpenAPI Specification is currently in **Early Availability**. The specification is complete but may evolve based on feedback and real-world use. If you encounter any inaccuracies or have feedback on how it can better suite your use case, please [contact us](https://pushpad.xyz/contact).\n\nWhile this specification should be considered experimental, the Pushpad API is stable and production-ready: please see [the official documentation](https://pushpad.xyz/docs/rest_api) or use [the libraries](https://pushpad.xyz/docs/libraries_and_plugins).\n\n## Specification\n\nThis repository contains the source files used to compile the specification.\n\nA bundled version containing the entire specification is published here:\n\nhttps://pushpad.xyz/openapi.yaml\n\n## Setup\n\nDownload this repository:\n\n```sh\ngit clone https://github.com/pushpad/pushpad-openapi.git\n```\n\nThen install the dependencies ([Redocly](https://redocly.com)):\n\n```sh\nmake setup\n```\n\n## Development\n\nTo preview the documentation locally, run:\n\n```sh\nmake preview\n```\n\nThe documentation will be available at: `http://127.0.0.1:4000`.\n\nTo generate a bundled version of the specification, run:\n\n```sh\nmake bundle\n```\n\nThis will create a file `Pushpad.v1.bundle.yaml` with the full OpenAPI specification.\n\n## Testing\n\nIf you make changes, you can validate the specification with:\n\n```sh\nmake lint\n```\n\n## License\n\nThis specification is licensed under the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpushpad%2Fpushpad-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpushpad%2Fpushpad-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpushpad%2Fpushpad-openapi/lists"}