https://github.com/ghostrider-05/patreon-api-spec
OpenAPI specification for Patreon API
https://github.com/ghostrider-05/patreon-api-spec
openapi-spec openapi31 patreon-api
Last synced: 6 months ago
JSON representation
OpenAPI specification for Patreon API
- Host: GitHub
- URL: https://github.com/ghostrider-05/patreon-api-spec
- Owner: ghostrider-05
- Created: 2024-10-28T15:24:59.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-09T14:29:47.000Z (10 months ago)
- Last Synced: 2025-02-05T03:27:17.105Z (8 months ago)
- Topics: openapi-spec, openapi31, patreon-api
- Homepage: https://patreon.apidocumentation.com/v2-stable/reference
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Patreon OpenAPI
This repository contains a preview of the [OpenAPI 3.1 specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) for [Patreons's API](https://docs.patreon.com/). Currently, the spec is only available for the API version [v2](https://docs.patreon.com/#apiv2-oauth).
> [!WARNING]
> This repository is not created, maintained or associated in any way with Patreon. Both specifications are made from the public documented API and are subject to breaking changes without notice if Patreon updates the public API.
## Usage
### Spec Files
Two versions of the spec are included—the standard spec and the preview spec:
- [`openapi.json`](specs/openapi.json) is the standard spec that contains the documented, public API.
- [`openapi_preview.json`](specs/openapi_preview.json) is the preview spec which contains unstable and/or undocumented API features. **This should not be considered stable** or used in production environments.
### Documentation
To view both the stable and experimental specifications, see the [API reference](https://patreon.apidocumentation.com/v2-stable/reference).
To use the Patreon API with a library, go to the [documentation of `patreon-api.ts`](https://patreon-api.pages.dev/).
## Contributing
OpenAPI spec contents are automatically generated by the [`patreon-api.ts`](https://github.com/ghostrider-05/patreon-api.ts) library.
For bug fixes or improvements for the OpenAPI spec, you can [open an issue](https://github.com/ghostrider-05/patreon-api-spec/issues).
## Known issues
TODO: add known issues
## License
[MIT](https://github.com/ghostrider-05/patreon-api.ts/blob/main/LICENSE)