diff --git a/dmnverifierapi/src/main/java/de/unikoblenz/fgbks/api/Verification.java b/dmnverifierapi/src/main/java/de/unikoblenz/fgbks/api/Verification.java index 688a555ddf6a3e8309cb39a409ceae6c507eafe4..5229c0b0b375e16791e5524dd5c07d41ae721724 100644 --- a/dmnverifierapi/src/main/java/de/unikoblenz/fgbks/api/Verification.java +++ b/dmnverifierapi/src/main/java/de/unikoblenz/fgbks/api/Verification.java @@ -18,7 +18,7 @@ import javax.ws.rs.core.Response; * API for the dmn verification service. Provides methods for generating verifications for dmn * tables. */ -@Path("/dmn/verification") +@Path("/api/dmn/verification") public class Verification { @Inject protected DmnVerificationService dmnVerificationService; diff --git a/dmnverifierapi/src/main/resources/META-INF/resources/index.html b/dmnverifierapi/src/main/resources/META-INF/resources/index.html index fd526d00a99098241e61da592f9d4668cf5875b2..bdc315c509a98b791395485213e899afbb0e97d0 100644 --- a/dmnverifierapi/src/main/resources/META-INF/resources/index.html +++ b/dmnverifierapi/src/main/resources/META-INF/resources/index.html @@ -1,152 +1,192 @@ <!DOCTYPE html> <html lang="en"> <head> - <meta charset="UTF-8"> - <title>getting-started - 1.0-SNAPSHOT</title> - <style> - h1, h2, h3, h4, h5, h6 { - margin-bottom: 0.5rem; - font-weight: 400; - line-height: 1.5; - } - - h1 { - font-size: 2.5rem; - } - - h2 { - font-size: 2rem - } - - h3 { - font-size: 1.75rem - } - - h4 { - font-size: 1.5rem - } - - h5 { - font-size: 1.25rem - } - - h6 { - font-size: 1rem - } - - .lead { - font-weight: 300; - font-size: 2rem; - } - - .banner { - font-size: 2.7rem; - margin: 0; - padding: 2rem 1rem; - background-color: #00A1E2; - color: white; - } - - body { - margin: 0; - font-family: -apple-system, system-ui, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; - } - - code { - font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; - font-size: 87.5%; - color: #e83e8c; - word-break: break-word; - } - - .left-column { - padding: .75rem; - max-width: 75%; - min-width: 55%; - } - - .right-column { - padding: .75rem; - max-width: 25%; - } - - .container { - display: flex; - width: 100%; - } - - li { - margin: 0.75rem; - } - - .right-section { - margin-left: 1rem; - padding-left: 0.5rem; - } - - .right-section h3 { - padding-top: 0; - font-weight: 200; - } - - .right-section ul { - border-left: 0.3rem solid #00A1E2; - list-style-type: none; - padding-left: 0; - } - - </style> + <meta charset="UTF-8"> + <title>VDMN - Verification for decision model and notation</title> + <style> + h1, h2, h3, h4, h5, h6 { + margin-bottom: 0.5rem; + font-weight: 400; + line-height: 1.5; + } + + h1 { + font-size: 2.5rem; + } + + h2 { + font-size: 2rem + } + + h3 { + font-size: 1.75rem + } + + h4 { + font-size: 1.2rem + } + + h5 { + font-size: 1.1rem + } + + h6 { + font-size: 1rem + } + + a { + text-decoration: none; + color: darkgrey; + } + + .lead { + font-weight: 300; + font-size: 2rem; + } + + .banner { + font-size: 2.7rem; + margin: 0; + padding: 2rem 1rem; + background-color: #095a16; + color: white; + } + + body { + margin: 0; + font-family: -apple-system, system-ui, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol", "Noto Color Emoji"; + } + + code { + font-family: SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace; + font-size: 87.5%; + color: #05dfe8; + word-break: break-word; + } + + code a { + color: #05dfe8; + } + + .left-column { + padding: .75rem; + max-width: 75%; + min-width: 55%; + } + + .right-column { + padding: .75rem; + max-width: 25%; + } + + .container { + display: flex; + width: 100%; + } + + li { + margin: 0.75rem; + } + + .right-section { + margin-left: 1rem; + padding-left: 0.5rem; + } + + .right-section h3 { + padding-top: 0; + font-weight: 200; + } + + .right-section ul { + border-left: 0.3rem solid #e2da13; + list-style-type: none; + padding-left: 0; + } + + </style> </head> <body> <div class="banner lead"> - Your new Cloud-Native application is ready! + VDMN - Verification for decision model and notation - API </div> <div class="container"> - <div class="left-column"> - <p class="lead"> Congratulations, you have created a new Quarkus application.</p> - - <h2>Why do you see this?</h2> - - <p>This page is served by Quarkus. The source is in - <code>src/main/resources/META-INF/resources/index.html</code>.</p> - - <h2>What can I do from here?</h2> - - <p>If not already done, run the application in <em>dev mode</em> using: <code>mvn compile quarkus:dev</code>. - </p> - <ul> - <li>Add REST resources, Servlets, functions and other services in <code>src/main/java</code>.</li> - <li>Your static assets are located in <code>src/main/resources/META-INF/resources</code>.</li> - <li>Configure your application in <code>src/main/resources/application.properties</code>. - </li> - </ul> - - <h2>How do I get rid of this page?</h2> - <p>Just delete the <code>src/main/resources/META-INF/resources/index.html</code> file.</p> + <div class="left-column"> + <p class="lead"> This application provides an api for verifications on dmn tables.</p> + + <h2>How can i use this api?</h2> + + 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">/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">/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> + + </div> + <div class="right-column"> + <div class="right-section"> + <h3>Application</h3> + <ul> + <li>GroupId: ${artifactId}</li> + <li>ArtifactId: ${groupId}</li> + <li>Version: ${version}</li> + <li><a href="https://quarkus.io/" target="_blank">Quarkus</a>: ${quarkus.version} + </li> + <li><a href="https://camunda.com/de/dmn/" target="_blank">Camunda DMN</a>: + ${version.camunda} + </li> + </ul> </div> - <div class="right-column"> - <div class="right-section"> - <h3>Application</h3> - <ul> - <li>GroupId: org.acme</li> - <li>ArtifactId: getting-started</li> - <li>Version: 1.0-SNAPSHOT</li> - <li>Quarkus Version: 0.21.1</li> - </ul> - </div> - <div class="right-section"> - <h3>Next steps</h3> - <ul> - <li><a href="https://quarkus.io/guides/maven-tooling.html">Setup your IDE</a></li> - <li><a href="https://quarkus.io/guides/getting-started-guide.html">Getting started</a></li> - <li><a href="https://quarkus.io">Quarkus Web Site</a></li> - </ul> - </div> + <div class="right-section"> + <h3>Contribute</h3> + <ul> + <li><a href="https://gitlab.uni-koblenz.de/jonasblatt/ma-jonasblatt-thesis" target="_blank"> + GitLab Project </a></li> + </ul> </div> + </div> </div> </body> -</html> \ No newline at end of file +</html> diff --git a/dmnverifierparent/pom.xml b/dmnverifierparent/pom.xml index aacc8ef183d84208143e41231ca9ecc909ace4c8..a12b390d9e0fb7b5ee344aff57f142f8a47d8724 100644 --- a/dmnverifierparent/pom.xml +++ b/dmnverifierparent/pom.xml @@ -50,5 +50,11 @@ <build> <finalName>${build.name}_${project.version}</finalName> + <resources> + <resource> + <directory>src/main/resources</directory> + <filtering>true</filtering> + </resource> + </resources> </build> </project>