From 33fad926f7e7137577e5cfc7c3df6b0b3bf5460c Mon Sep 17 00:00:00 2001
From: Jannik Hollenbach <Jannik.Hollenbach@iteratec.de>
Date: Wed, 6 Mar 2019 10:28:18 +0100
Subject: [PATCH 1/2] Fixed plugin for generating markdown api docs

---
 scb-engine/pom.xml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/scb-engine/pom.xml b/scb-engine/pom.xml
index ca4e7ac8..625106a3 100644
--- a/scb-engine/pom.xml
+++ b/scb-engine/pom.xml
@@ -236,11 +236,29 @@
             <properties>
                 <activatedProfiles>docs</activatedProfiles>
             </properties>
+
+            <pluginRepositories>
+                <pluginRepository>
+                    <id>jcenter-snapshots</id>
+                    <name>jcenter</name>
+                    <url>http://oss.jfrog.org/artifactory/oss-snapshot-local/</url>
+                </pluginRepository>
+                <pluginRepository>
+                    <id>jcenter-releases</id>
+                    <name>jcenter</name>
+                    <url>http://jcenter.bintray.com</url>
+                    <snapshots>
+                        <enabled>false</enabled>
+                    </snapshots>
+                </pluginRepository>
+            </pluginRepositories>
+
             <build>
                 <plugins>
                     <plugin>
                         <groupId>io.github.swagger2markup</groupId>
                         <artifactId>swagger2markup-maven-plugin</artifactId>
+                        <version>1.3.7</version>
 
                         <configuration>
                             <swaggerInput>${project.build.directory}/swagger.json</swaggerInput>

From 191b108a49028d4881e00290de115ce562f1801f Mon Sep 17 00:00:00 2001
From: Jannik Hollenbach <Jannik.Hollenbach@iteratec.de>
Date: Wed, 6 Mar 2019 10:30:13 +0100
Subject: [PATCH 2/2] Added guide how to generate the mardown api docs

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index bc2a5c00..100f4b70 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,14 @@ To build the docker image run:
 
 `docker build -t IMAGE_NAME .`
 
+## Generating the API Docs
+
+1. Run the Test Suite using the `docs` maven profile. This should generate a `swagger.json` file in the target folder of the `scb-engine` module.
+2. Run the `swagger2markup:convertSwagger2markup` plugin. This should generate a file located `docs/api-doc.md` in the target folder of the `scb-engine module.
+3. Copy the `api-doc.md` file to the user guide of the [secureCodeBox](https://github.com/secureCodeBox/secureCodeBox) repository.
+4. Re Add the first disclaimer paragraph pointing the users to the dynamic swagger docs of their engine. This has to be added by hand as it is not included in the export.
+5. (Optional) Reformat the generated markdown file with prettier to improve the generated markdown output.
+
 # Guidelines & Standards
 Well boring yes - but please read our [guidelines and naming standards][scb-developer-guidelines].