diff options
| author |   liamfallon <liam.fallon@est.tech> | 2021-07-15 14:59:06 +0100 |
|---|---|---|
| committer | Liam Fallon <liam.fallon@est.tech> | 2021-07-19 13:13:59 +0000 |
| commit | 123321473628cbacd35963f4f30bf2ab621fd3b7 (patch) | |
| tree | 1c78e59e063afc9f8cffc96d6b71bc550c55975f /docs/apex | |
| parent | 5762c5765d4921b4f26de3da3eba0500095d731f (diff) | |
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>
Diffstat (limited to 'docs/apex')
0 files changed, 0 insertions, 0 deletions