From 5dc921a0c0e935ae2cf8aade35f9f9ccd03791c3 Mon Sep 17 00:00:00 2001
From: Jonas Blatt <jonasblatt@uni-koblenz.de>
Date: Sat, 12 Oct 2019 12:32:35 +0200
Subject: [PATCH] Add documentation for the rest api
---
dmnverifierapi/README.md | 2 ++
dmnverifierapi/docApi.md | 56 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 58 insertions(+)
create mode 100644 dmnverifierapi/docApi.md
diff --git a/dmnverifierapi/README.md b/dmnverifierapi/README.md
index 4b9b4621..0f91a6df 100644
--- a/dmnverifierapi/README.md
+++ b/dmnverifierapi/README.md
@@ -7,6 +7,8 @@ This project contains all source files of the implementation, created for the ma
- [Frontend Project](../dmnverifierfrontend)
## Backend
+[Api Documentation](docApi.md)
+
Based on
- [Quarkus](https://quarkus.io/)
- [Camunda DMN](https://github.com/camunda/camunda-dmn-model/)
diff --git a/dmnverifierapi/docApi.md b/dmnverifierapi/docApi.md
new file mode 100644
index 00000000..9abf8718
--- /dev/null
+++ b/dmnverifierapi/docApi.md
@@ -0,0 +1,56 @@
+# Documentation API
+
+Root path: <code>/api</code>
+
+<h3>Verifications</h3>
+<h4>Get all verifications from all verifiers with the given dmn table</h4>
+<ul>
+ <li>POST</li>
+ <li><code>/api/dmn/verification/</code></li>
+ <li>Consumes: text/xml - the dmn table as xml string</li>
+ <li>Produces: application/json</li>
+</ul>
+
+<h3>Verification classifications</h3>
+<h4>Get a list of all verification classifications</h4>
+<ul>
+ <li>GET</li>
+ <li><code><a href="/api/dmn/verification/classification" target="_blank">/api/dmn/verification/classification</a></code>
+ </li>
+ <li>Produces: application/json</li>
+</ul>
+<h4>Get all verifications for the given verification classification</h4>
+<ul>
+ <li>POST</li>
+ <li><code>/api/dmn/verification/classification/{classificationName}</code></li>
+ <li>Consumes: text/xml - the dmn table as xml string</li>
+ <li>Produces: application/json</li>
+</ul>
+
+<h3>Verification types</h3>
+<h4>Get a list of all verification types</h4>
+<ul>
+ <li>GET</li>
+ <li>
+ <code><a href="/api/dmn/verification/type"
+ target="_blank">/api/dmn/verification/type</a></code>
+ </li>
+ <li>Produces: application/json</li>
+</ul>
+<h4>Get all verifications for the given verification type</h4>
+<ul>
+ <li>POST</li>
+ <li><code>/api/dmn/verification/classification/{classificationName}</code></li>
+ <li>Consumes: text/xml - the dmn table as xml string</li>
+ <li>Produces: application/json</li>
+</ul>
+<h3>Metrics</h3>
+<h4>Get some statistics about execution times</h4>
+<ul>
+ <li>GET</li>
+ <li>
+ <code><a href="/api/dmn/verification/metrics"
+ target="_blank">/api/dmn/verification/metrics</a></code>
+ </li>
+ <li>Produces: application/json</li>
+</ul>
--
GitLab