feat(open-api): add rest api version endpoint

Related to CAM-11538, PR camunda#716
chetanrahate · Mar 13, 2020 · 0a05cb6 · 0a05cb6
1 parent 1a6fd6a
commit 0a05cb6
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 2 deletions.
diff --git a/engine-rest/engine-rest-openapi/src/main/templates/main.ftl b/engine-rest/engine-rest-openapi/src/main/templates/main.ftl
@@ -31,9 +31,10 @@
 
   ],
   "tags": [
-    {"name": "Process instance"},
     {"name": "Deployment"},
-    {"name": "Engine"}
+    {"name": "Engine"},
+    {"name": "Process instance"},
+    {"name": "Version"}
   ],
   "paths": {
 

diff --git a/...ine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/VersionDto.ftl b/...ine-rest-openapi/src/main/templates/models/org/camunda/bpm/engine/rest/dto/VersionDto.ftl
@@ -0,0 +1,12 @@
+{
+  "type" : "object",
+  "properties" : {
+
+    <@lib.property
+        name = "version"
+        type = "string"
+        last = true
+        desc = "The version of the Rest API." />
+
+  }
+}
diff --git a/engine-rest/engine-rest-openapi/src/main/templates/paths/version/get.ftl b/engine-rest/engine-rest-openapi/src/main/templates/paths/version/get.ftl
@@ -0,0 +1,21 @@
+{
+  <@lib.endpointInfo
+      id = "getRestAPIVersion"
+      tag = "Version"
+      desc = "Retrieves the version of the Rest API." />
+
+  "responses" : {
+    <@lib.response
+        code = "200"
+        dto = "VersionDto"
+        last = true
+        desc = "Request successful."
+        examples = ['"example-1": {
+                       "summary": "Status 200 Response",
+                       "description": "The Response content of a status 200",
+                       "value": {
+                           "version": "7.13.0"
+                         }
+                     }'] />
+  }
+}