https://github.com/pushpad/pushpad-openapi
Pushpad OpenAPI Specification
https://github.com/pushpad/pushpad-openapi
Last synced: 16 days ago
JSON representation
Pushpad OpenAPI Specification
- Host: GitHub
- URL: https://github.com/pushpad/pushpad-openapi
- Owner: pushpad
- License: apache-2.0
- Created: 2025-09-13T20:01:07.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2025-10-01T14:45:36.000Z (9 months ago)
- Last Synced: 2025-10-01T16:34:18.619Z (9 months ago)
- Language: Makefile
- Size: 40 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pushpad OpenAPI Specification
[](https://pushpad.xyz/openapi.yaml)
The OpenAPI specification for Web Push Notifications using [Pushpad](https://pushpad.xyz).
## What is OpenAPI?
From the [OpenAPI Specification](https://swagger.io/specification/):
> 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.
> 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.
## Project Status
The 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).
While 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).
## Specification
This repository contains the source files used to compile the specification.
A bundled version containing the entire specification is published here:
https://pushpad.xyz/openapi.yaml
## Setup
Download this repository:
```sh
git clone https://github.com/pushpad/pushpad-openapi.git
```
Then install the dependencies ([Redocly](https://redocly.com)):
```sh
make setup
```
## Development
To preview the documentation locally, run:
```sh
make preview
```
The documentation will be available at: `http://127.0.0.1:4000`.
To generate a bundled version of the specification, run:
```sh
make bundle
```
This will create a file `Pushpad.v1.bundle.yaml` with the full OpenAPI specification.
## Testing
If you make changes, you can validate the specification with:
```sh
make lint
```
## License
This specification is licensed under the [Apache License 2.0](LICENSE).