From 8dc59eb85af88659bdb23a5ec69c50f1966b9a4f Mon Sep 17 00:00:00 2001 From: ubbo <veentjer@sub.uni-goettingen.de> Date: Tue, 9 Apr 2019 12:48:59 +0200 Subject: [PATCH] mention openAPI --- rdd-technical-reference.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/rdd-technical-reference.md b/rdd-technical-reference.md index c76139b..4d9846b 100644 --- a/rdd-technical-reference.md +++ b/rdd-technical-reference.md @@ -126,6 +126,8 @@ Call diagrams can be useful to follow code and service calls and should be exist - meet and write documentation together regularly (documentation sprint)? +- document REST-APIs using [openAPI](https://github.com/OAI/OpenAPI-Specification) if possible. OpenAPI docs should be located at /doc/api on servers + ### Admin Documentation - how to install the software, how to run and/or restart it, how to test the installation, ... -- GitLab