fix: swagger-ui (#530)

* fix: swagger-ui fix: ARA-194 * chore: update version
Decathlon · Oct 29, 2021 · cbd225b · cbd225b
1 parent 35fe960
commit cbd225b
Show file tree

Hide file tree

Showing 11 changed files with 25 additions and 11 deletions.
diff --git a/charts/candidate/Chart.yaml b/charts/candidate/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: ara
-version: 10.0.0-rc.1
+version: 10.0.0-rc.2
 home: https://github.com/Decathlon/ara
 description: |
     ARA helps you to fight against regressions by letting it preanalyze your non-regression tests runs,

diff --git a/charts/candidate/values.yaml b/charts/candidate/values.yaml
@@ -8,7 +8,7 @@ api:
     image:
         registry: docker.io
         repository: decathlon/ara-api
-        tag: 11.0.0
+        tag: 11.0.1
         imagePullPolicy: IfNotPresent
     loggingMode:
         - logging-console

diff --git a/code/api/api/README.adoc b/code/api/api/README.adoc
@@ -43,7 +43,7 @@ Here are main layers in the server module, with the main technologies used by th
             v
     +---------------+
     |    Swagger{io}| Exposes a live documentation of
-    +---------------+ REST APIs at /swagger{dash}ui.html
+    +---------------+ REST APIs at /actuator/swagger{dash}ui/index.html?url=/actuator/openapi
 ....
 
 === Class Diagram
@@ -378,7 +378,13 @@ Once your ARA instance is live, you can update the current state of a feature fl
 
 Swagger is a documentation and test tool for APIs. +
 All REST resources must have JavaDoc so that it can be used for public API documentation. +
-You can access to it at http://localhost:8080/swagger-ui.html
+You can access to it at http://localhost:8080/actuator/swagger-ui/index.html?url=/actuator/openapi
+
+Most operations on the swagger need authentication.
+So if you want to test methods, we recommand running the front as well, so you can authenticate and run any method depending on your rights:app-name :
+
+* Connect to the application: http://localhost:7000
+* Go the the actuator through the same domain: http://localhost:7000/actuator/swagger-ui/index.html?url=/actuator/openapi
 
 == Tests & Quality
 

diff --git a/code/api/api/pom.xml b/code/api/api/pom.xml
@@ -28,7 +28,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-api</artifactId>
-    <version>11.0.0</version>
+    <version>11.0.1</version>
 
     <name>ARA API</name>
     <description>

diff --git a/code/api/api/src/main/java/com/decathlon/ara/configuration/SwaggerConfiguration.java b/code/api/api/src/main/java/com/decathlon/ara/configuration/SwaggerConfiguration.java
@@ -21,18 +21,24 @@
 import io.swagger.v3.oas.models.info.Contact;
 import io.swagger.v3.oas.models.info.Info;
 import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.servers.Server;
 import lombok.RequiredArgsConstructor;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 @Configuration
 @RequiredArgsConstructor(onConstructor = @__(@Autowired))
 public class SwaggerConfiguration {
 
+    @Value("${ara.clientBaseUrl}")
+    private String baseUrl;
+
     @Bean
     public OpenAPI araOpenAPI() {
         return new OpenAPI()
+                .addServersItem(new Server().url(baseUrl))
                 .info(
                         new Info()
                                 .title("ARA API")

diff --git a/code/api/api/src/main/resources/application.yaml b/code/api/api/src/main/resources/application.yaml
@@ -42,6 +42,8 @@ spring:
     #host: please-configure-spring.mail.host
 
 springdoc:
+  swagger-ui:
+    disable-swagger-default-url: true
   packagesToScan: com.decathlon.ara
   pathsToMatch: /api/**
   use-management-port: true

diff --git a/code/api/database/pom.xml b/code/api/database/pom.xml
@@ -28,7 +28,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-database</artifactId>
-    <version>11.0.0</version>
+    <version>11.0.1</version>
 
     <name>ARA Database</name>
     <description>

diff --git a/code/api/generated-cucumber-report/pom.xml b/code/api/generated-cucumber-report/pom.xml
@@ -27,7 +27,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-generated-cucumber-report</artifactId>
-    <version>11.0.0</version>
+    <version>11.0.1</version>
 
     <name>ARA Cucumber</name>
     <description>

diff --git a/code/api/jacoco-aggregation/pom.xml b/code/api/jacoco-aggregation/pom.xml
@@ -3,14 +3,14 @@
     <parent>
         <artifactId>ara-parent</artifactId>
         <groupId>com.decathlon.ara</groupId>
-        <version>11.0.0</version>
+        <version>11.0.1</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>jacoco-aggregation</artifactId>
     <packaging>pom</packaging>
-    <version>11.0.0</version>
+    <version>11.0.1</version>
 
     <name>Jacoco Report Aggregation</name>
 

diff --git a/code/api/lib/pom.xml b/code/api/lib/pom.xml
@@ -27,7 +27,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-lib</artifactId>
-    <version>11.0.0</version>
+    <version>11.0.1</version>
 
     <properties>
         <java.version>16</java.version>

diff --git a/code/api/pom.xml b/code/api/pom.xml
@@ -28,7 +28,7 @@
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-parent</artifactId>
     <packaging>pom</packaging>
-    <version>11.0.0</version>
+    <version>11.0.1</version>
 
     <name>ARA Parent</name>
     <description>