Skip to content
This repository was archived by the owner on Feb 26, 2021. It is now read-only.

Release 1.0.1 #73

Merged
rfelber merged 7 commits into from
Mar 20, 2019
Merged

Release 1.0.1 #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
33fad92
Fixed plugin for generating markdown api docs
J12934 Mar 6, 2019
191b108
Added guide how to generate the mardown api docs
J12934 Mar 6, 2019
7597534
Merge pull request #71 from secureCodeBox/fix/markdown-api-docs
J12934 Mar 6, 2019
54643a5
fix: scb-persistenceproviders/s3-persistenceprovider/pom.xml to reduc…
snyk-bot Mar 6, 2019
cf80770
Merge pull request #72 from secureCodeBox/snyk-fix-1a1qgd
J12934 Mar 6, 2019
3b0c3a1
Added cli examples on how to generate the docs
J12934 Mar 6, 2019
e2b7d11
Fixed markdown api docs generated dependency in parent pom
J12934 Mar 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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].

Expand Down
16 changes: 16 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
18 changes: 18 additions & 0 deletions scb-engine/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
2 changes: 1 addition & 1 deletion scb-persistenceproviders/s3-persistenceprovider/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down