openapi

OpenAPI definitions for applications that don't publish one themselves, or whose own is incomplete.

Many self-hosted and business applications expose a REST API but ship no machine-readable description of it, or only a partial one. This repository collects hand-written and curated OpenAPI documents for them, so tools that need an API description (API clients, code generators, documentation, mock servers, validators, AI agents) can share one maintained source instead of each keeping its own copy.

Layout

One directory per application, named after it in lower case, with the definition inside:

<application>/
  openapi.json      # or openapi.yaml

For example erpnext/openapi.json. Every definition is a plain, self-contained OpenAPI document (3.x) with no tooling-specific extensions required.

Using a definition

The files are public and need no authentication. Point your tool at the raw file, e.g.:

https://<host>/<owner>/openapi/raw/branch/main/<application>/openapi.json

Pin to a tag or commit instead of main when you need the definition to stay the same over time.

Scope and versions

A definition describes an application's API as far as it is documented and verified here; it is not guaranteed to cover every endpoint of every version. Where a definition targets a specific version of an application, the info.version and info.description say so.

Contributing

Corrections and new applications are welcome. Keep to the layout above, make sure the document validates as OpenAPI 3.x, and describe only what you have checked against the application.

License

See LICENSE.