Skip to content

Add OpenAPI spec to docs #1038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PartTimeDataScientist wants to merge 2 commits into
base: master
Choose a base branch
from
+555 −0
Open

Add OpenAPI spec to docs #1038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c87241
doc: Create OpenAPI-Doc
PartTimeDataScientist Mar 17, 2026
cb27aab
doc: Update Documentation with reference to OpenAPI file
PartTimeDataScientist Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api-v1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ photon provides the following endpoints:
see [Usage/updates](usage.md#running-updates-via-the-api)
* (optional) `/metrics` for providing performance metrics for Prometheus

An [OpenAPI file](openapi.json) for the main endpoints is available as well.

## Search

A simple forward search for a place looks like this:
Expand Down
Loading