Merge branch 'documentation/api' into 'develop'

Add api docs for actions config

See merge request jonasblatt/ma-jonasblatt-dmn-verifier!83

dmnverifierapi/docApi.md

@@ -61,3 +61,67 @@ Root path: <code>/api</code>
   </li>
   <li>Produces: application/json</li>
 </ul>
+
+<h3>Actions</h3>
+
+<h4>Get global the action config</h4>
+Get "true" or "false" for the global action creation setting. If "false", no actions will be
+created.
+<ul>
+  <li>GET</li>
+  <li>
+    <code><a href="/api/dmn/verification/actions/global"
+             target="_blank">/api/dmn/verification/actions/global</a></code>
+  </li>
+  <li>Produces: text/plain</li>
+</ul>
+
+<h4>Set global the action config</h4>
+Set "true" or "false" for the global action creation setting. If "false", no actions will be
+created.
+<ul>
+  <li>POST</li>
+  <li>
+    <code>/api/dmn/verification/actions/global/{boolean}</code>
+  </li>
+  <li>Produces: text/plain</li>
+</ul>
+
+<h4>Get configs for allowed actions scopes and action types</h4>
+<ul>
+  <li>GET</li>
+  <li>
+    <code>><a href="/api/dmn/verification/actions/allowedActions"
+              target="_blank">/api/dmn/verification/actions/allowedActions</a></code>
+  </li>
+  <li>Produces: application/json</li>
+</ul>
+
+<h4>Get a list of action types</h4>
+<ul>
+  <li>GET</li>
+  <li>
+    <code>><a href="/api/dmn/verification/actions/actionTypes"
+              target="_blank">/api/dmn/verification/actions/actionTypes</a></code>
+  </li>
+  <li>Produces: application/json</li>
+</ul>
+
+<h4>Get a list of action scopes</h4>
+<ul>
+  <li>GET</li>
+  <li>
+    <code>><a href="/api/dmn/verification/actions/actionScopes"
+              target="_blank">/api/dmn/verification/actions/actionScopes</a></code>
+  </li>
+  <li>Produces: application/json</li>
+</ul>
+
+<h4>Set the boolean for the allowed action type / action scope</h4>
+<ul>
+  <li>POST</li>
+  <li>
+    <code>/api/dmn/verification/actions/allowedActions/{scope}/{type}/{value}</code>
+  </li>
+  <li>Produces: text/plain</li>
+</ul>

dmnverifierapi/src/main/resources/META-INF/resources/index.html

@@ -183,7 +183,72 @@
       </li>
       <li>Produces: application/json</li>
     </ul>
+
+    <h3>Actions</h3>
+
+    <h4>Get global the action config</h4>
+    Get "true" or "false" for the global action creation setting. If "false", no actions will be
+    created.
+    <ul>
+      <li>GET</li>
+      <li>
+        <code><a href="/api/dmn/verification/actions/global"
+                 target="_blank">/api/dmn/verification/actions/global</a></code>
+      </li>
+      <li>Produces: text/plain</li>
+    </ul>
+
+    <h4>Set global the action config</h4>
+    Set "true" or "false" for the global action creation setting. If "false", no actions will be
+    created.
+    <ul>
+      <li>POST</li>
+      <li>
+        <code>/api/dmn/verification/actions/global/{boolean}</code>
+      </li>
+      <li>Produces: text/plain</li>
+    </ul>
+
+    <h4>Get configs for allowed actions scopes and action types</h4>
+    <ul>
+      <li>GET</li>
+      <li>
+        <code>><a href="/api/dmn/verification/actions/allowedActions"
+                  target="_blank">/api/dmn/verification/actions/allowedActions</a></code>
+      </li>
+      <li>Produces: application/json</li>
+    </ul>
+
+    <h4>Get a list of action types</h4>
+    <ul>
+      <li>GET</li>
+      <li>
+        <code>><a href="/api/dmn/verification/actions/actionTypes"
+                  target="_blank">/api/dmn/verification/actions/actionTypes</a></code>
+      </li>
+      <li>Produces: application/json</li>
+    </ul>
+
+    <h4>Get a list of action scopes</h4>
+    <ul>
+      <li>GET</li>
+      <li>
+        <code>><a href="/api/dmn/verification/actions/actionScopes"
+                  target="_blank">/api/dmn/verification/actions/actionScopes</a></code>
+      </li>
+      <li>Produces: application/json</li>
+    </ul>
+
+    <h4>Set the boolean for the allowed action type / action scope</h4>
+    <ul>
+      <li>POST</li>
+      <li>
+        <code>/api/dmn/verification/actions/allowedActions/{scope}/{type}/{value}</code>
+      </li>
+      <li>Produces: text/plain</li>
+    </ul>
   </div>
+
   <div class="right-column">
     <div class="right-section">
       <h3>Application</h3>