diff OrthancServer/Sources/main.cpp @ 4425:d6cb9e91a3d6

added openapi description
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 30 Dec 2020 08:20:26 +0100
parents 22a1352a0823
children d9473bd5ed43
line wrap: on
line diff
--- a/OrthancServer/Sources/main.cpp	Tue Dec 29 19:28:53 2020 +0100
+++ b/OrthancServer/Sources/main.cpp	Wed Dec 30 08:20:26 2020 +0100
@@ -1771,6 +1771,13 @@
 
         openapi["info"]["version"] = ORTHANC_VERSION;
         openapi["info"]["title"] = "Orthanc API";
+        openapi["info"]["description"] =
+          "This is the full documentation of the [REST API](https://book.orthanc-server.com/users/rest.html) "
+          "of Orthanc.<p>This reference is automatically generated from the source code of Orthanc. A "
+          "[shorter cheat sheet](https://book.orthanc-server.com/users/rest-cheatsheet.html) is part of "
+          "the Orthanc Book.<p>An earlier, manually crafted version from August 2019, is [still available]"
+          "(2019-08-orthanc-openapi.html), but is not up-to-date anymore ([source]"
+          "(https://groups.google.com/g/orthanc-users/c/NUiJTEICSl8/m/xKeqMrbqAAAJ)).";
 
         Json::Value server = Json::objectValue;
         server["url"] = "https://demo.orthanc-server.com/";