From: liamfallon Date: Wed, 16 Nov 2022 16:15:21 +0000 (-0800) Subject: Remove policy parent swagger generation profile X-Git-Tag: 3.7.0~11 X-Git-Url: https://gerrit.onap.org/r/gitweb?p=policy%2Fparent.git;a=commitdiff_plain;h=0659d1742f78a72aeb8bad7849e0a922ef81815e Remove policy parent swagger generation profile This maven profile used the Swagger endpoint to generate the Swagger and then generated a HTML and PDF version using Asciidoc. We now have Swagger as a source artifact so this profile is no longer needed. This commit als fixes the issue with the example for using this profile in the documentation, which references a non-existant link. Issue-ID: POLICY-4431 Change-Id: I970eb392f156662c3bbfb38e978bc46335538925 Signed-off-by: liamfallon --- diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst index cfd0ab61..1ecd2bc4 100644 --- a/docs/development/devtools/devtools.rst +++ b/docs/development/devtools/devtools.rst @@ -13,7 +13,6 @@ Policy Platform Development Tools This article explains how to build the ONAP Policy Framework for development purposes and how to run stability/performance tests for a variety of components. To start, the developer should consult the latest ONAP Wiki to familiarize themselves with developer best practices and how-tos to setup their environment, see `https://wiki.onap.org/display/DW/Developer+Best+Practices`. - This article assumes that: * You are using a *\*nix* operating system such as linux or macOS. @@ -409,54 +408,7 @@ To test these images, CSITs will be run. Generating Swagger Documentation ******************************** -1. Using Swagger2Markup maven plugin from Policy Parent Integration POM -+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ - -The `Policy Parent Integration POM `_ contains a *generateSwaggerDocs* profile. This -profile can be activated on any module that has a Swagger endpoint. When active, this profile creates a tarball in Nexus with the name -*-swagger-docs.tar.gz*. The tarball contains the following files: - -.. code-block:: bash - - swagger/swagger.html - swagger/swagger.json - swagger/swagger.pdf - -The profile is activated when: - -1. The following property is defined at the top of the *pom.xml* file for a module - - .. code-block:: bash - - - post-integration-test - - See the `CLAMP runtime POM `_ for an example of the usage of this property. - -2. Unit tests are being executed in the build, in other words when the *skipTests* flag is *false*. - -You **must** create a unit test in your module that generates the following file: - -.. code-block:: bash - - src/test/resources/swagger/swagger.json - -Typically, you do this by starting your REST endpoint in a unit test, issuing a REST call to get the Swagger API documentation. The test case below is an example -of such a test case. - -.. code-block:: java - - @Test - public void testSwaggerJson() throws Exception { - ResponseEntity httpsEntity = getRestTemplate() - .getForEntity("https://localhost:" + this.httpsPort + "/restservices/clds/api-doc", String.class); - assertThat(httpsEntity.getStatusCode()).isEqualTo(HttpStatus.OK); - assertThat(httpsEntity.getBody()).contains("swagger"); - FileUtils.writeStringToFile(new File("target/swagger/swagger.json"), httpsEntity.getBody(), - Charset.defaultCharset()); - } - -2. Accessing Swagger documentation for springboot based policy applications +1. Accessing Swagger documentation for springboot based policy applications +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ Springfox Swagger2 maven dependency aids with auto-generation of Swagger documentation. diff --git a/integration/pom.xml b/integration/pom.xml index c0d81761..2b651ae5 100644 --- a/integration/pom.xml +++ b/integration/pom.xml @@ -1118,162 +1118,6 @@ - - generateSwaggerDocs - - - !skipTests - - - - - - - io.github.swagger2markup - swagger2markup-maven-plugin - 1.3.3 - - - io.github.swagger2markup - swagger2markup-import-files-ext - 1.3.3 - - - io.github.swagger2markup - swagger2markup-spring-restdocs-ext - 1.3.3 - - - - ${project.build.directory}/swagger/swagger.json - ${project.build.directory}/asciidoc/generated - - ASCIIDOC - - - - - ${swagger.generation.phase} - - convertSwagger2markup - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-swagger-asciidoc - ${swagger.generation.phase} - - unpack - - - - - org.onap.policy.parent - policy-parent-resources - jar - true - ${project.build.directory} - - - asciidoc/** - ${project.build.directory} - - - - - - - - org.asciidoctor - asciidoctor-maven-plugin - 1.5.7.1 - - - org.asciidoctor - asciidoctorj-pdf - 1.5.0-alpha.10.1 - - - - ${project.build.directory}/asciidoc - swagger.adoc - - book - left - 3 - - - - - ${project.build.directory}/asciidoc/generated - - - - - - output-html - ${swagger.generation.phase} - - process-asciidoc - - - html5 - ${project.build.directory}/swagger - - - - output-pdf - ${swagger.generation.phase} - - process-asciidoc - - - pdf - ${project.build.directory}/swagger - - - - - - - - org.apache.maven.plugins - maven-assembly-plugin - - - org.onap.policy.parent - policy-parent-resources - ${version.parent.resources} - - - - - generate-swagger-tar - ${swagger.generation.phase} - - single - - - - swagger-docs - - ${project.artifactId} - - - - - - - -