Add profile for generating Swagger documents 62/122662/4
authorliamfallon <liam.fallon@est.tech>
Thu, 15 Jul 2021 13:59:06 +0000 (14:59 +0100)
committerLiam Fallon <liam.fallon@est.tech>
Mon, 19 Jul 2021 13:13:59 +0000 (13:13 +0000)
commit123321473628cbacd35963f4f30bf2ab621fd3b7
tree1c78e59e063afc9f8cffc96d6b71bc550c55975f
parent5762c5765d4921b4f26de3da3eba0500095d731f
Add profile for generating Swagger documents

This commit adds a profile for generating Swagger documents and creating
a tarball containing the swagger.json, swagger.html, and swagger.pdf
files.

The profile is triggered in any module when tsts are enabled (In other
words when the skipTests flag is off), and when the following proerty is
set:
        <swagger.generation.phase>post-integration-test</swagger.generation.phase>

This profile assumes that a unit test exists that creates the following
file:
target/swagger/swagger.json

If this file does not exist, the build will fail if the profile is
invoked.

Therefore, to generate the Swagger documentation tarball, a module must
set the swagger.generation.phase propety AND have a unit test that
generates the swagger.json file.

Issue-ID: POLICY-3424
Change-Id: I8ff769e7a28bf0e00969d1bc677fee6908951d8a
Signed-off-by: liamfallon <liam.fallon@est.tech>
.gitignore
docs/conf.py
docs/development/devtools/devtools.rst
docs/xacml/swagger.json
integration/pom.xml
pom.xml
resources/pom.xml [new file with mode: 0644]
resources/src/main/resources/asciidoc/swagger.adoc [new file with mode: 0644]
resources/src/main/resources/assemblies/swagger-docs.xml [new file with mode: 0644]