Project

General

Profile

Actions

Feature #2757

open

Sphinx openapi plugin

Added by Bernhard Koschiček-Krombholz 9 days ago. Updated 9 days ago.

Status:
Acknowledged
Priority:
Normal
Assignee:
-
Category:
Documentation
Target version:
Start date:
2026-02-24
Estimated time:

Description

To again render the API endpoints in OpenAtlas, we can use this plugin: https://github.com/sphinx-contrib/openapi

This reads the OpenAPI file and renders it into Sphinx. So people don't need to access the Swagger, which can be quite confusing for non-developers.

Actions #1

Updated by Bernhard Koschiček-Krombholz 9 days ago

Additionally, I should also include a cookbook for the API. This means that I precreate some endpoint options to gather specific data for historians and archeologists.

Actions

Also available in: Atom PDF