Merge pull request #73 from secureCodeBox/develop

Release 1.0.1
secureCodeBox · Mar 20, 2019 · 33141c0 · 33141c0
2 parents 45676ee + e2b7d11
commit 33141c0
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 1 deletion.
diff --git 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: `mvn test -P docs`. This should generate a `swagger.json` file in the target folder of the `scb-engine` module.
+2. Run the `swagger2markup:convertSwagger2markup` plugin: `mvn -P docs swagger2markup:convertSwagger2markup`. 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].
 

diff --git a/pom.xml b/pom.xml
@@ -213,6 +213,22 @@
         </pluginManagement>
     </build>
 
+    <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>
+
     <repositories>
         <repository>
             <id>camunda-bpm-nexus</id>

diff --git 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>

diff --git a/scb-persistenceproviders/s3-persistenceprovider/pom.xml b/scb-persistenceproviders/s3-persistenceprovider/pom.xml
@@ -39,7 +39,7 @@
         <dependency>
             <groupId>com.amazonaws</groupId>
             <artifactId>aws-java-sdk-s3</artifactId>
-            <version>1.11.424</version>
+            <version>1.11.453</version>
         </dependency>
         <dependency>
             <groupId>org.powermock</groupId>