summaryrefslogtreecommitdiffstats
path: root/resources
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2021-07-15 14:59:06 +0100
committerLiam Fallon <liam.fallon@est.tech>2021-07-19 13:13:59 +0000
commit123321473628cbacd35963f4f30bf2ab621fd3b7 (patch)
tree1c78e59e063afc9f8cffc96d6b71bc550c55975f /resources
parent5762c5765d4921b4f26de3da3eba0500095d731f (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 'resources')
-rw-r--r--resources/pom.xml32
-rw-r--r--resources/src/main/resources/asciidoc/swagger.adoc4
-rw-r--r--resources/src/main/resources/assemblies/swagger-docs.xml40
3 files changed, 76 insertions, 0 deletions
diff --git a/resources/pom.xml b/resources/pom.xml
new file mode 100644
index 00000000..802e93fd
--- /dev/null
+++ b/resources/pom.xml
@@ -0,0 +1,32 @@
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2021 Nordix Foundation.
+ ================================================================================
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ============LICENSE_END=========================================================
+ -->
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.onap.policy.parent</groupId>
+ <artifactId>policy-parent</artifactId>
+ <version>3.4.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>policy-parent-resources</artifactId>
+ <description>Resources used in builds</description>
+ <packaging>jar</packaging>
+</project>
diff --git a/resources/src/main/resources/asciidoc/swagger.adoc b/resources/src/main/resources/asciidoc/swagger.adoc
new file mode 100644
index 00000000..e2543364
--- /dev/null
+++ b/resources/src/main/resources/asciidoc/swagger.adoc
@@ -0,0 +1,4 @@
+include::{generated}/overview.adoc[]
+include::{generated}/paths.adoc[]
+include::{generated}/security.adoc[]
+include::{generated}/definitions.adoc[]
diff --git a/resources/src/main/resources/assemblies/swagger-docs.xml b/resources/src/main/resources/assemblies/swagger-docs.xml
new file mode 100644
index 00000000..1a1934f3
--- /dev/null
+++ b/resources/src/main/resources/assemblies/swagger-docs.xml
@@ -0,0 +1,40 @@
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2021 Nordix Foundation.
+ ================================================================================
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ SPDX-License-Identifier: Apache-2.0
+ ============LICENSE_END=========================================================
+-->
+
+<assembly>
+ <id>swagger-docs</id>
+ <formats>
+ <format>tar.gz</format>
+ </formats>
+ <includeBaseDirectory>false</includeBaseDirectory>
+ <fileSets>
+ <fileSet>
+ <directory>${project.build.directory}/swagger
+ </directory>
+ <includes>
+ <include>*.json</include>
+ <include>*.html</include>
+ <include>*.pdf</include>
+ </includes>
+ <outputDirectory>${file.separator}swagger</outputDirectory>
+ <lineEnding>unix</lineEnding>
+ </fileSet>
+ </fileSets>
+</assembly>