[MODLISTS-129] Use migration DTOs from shared repo (#445)

* [MODLISTS-129] Use migration DTOs from shared repo * Use openapi transformation agreeable to api-lint * fix version testing * idk why this happened * use openapi-generator 7.4
folio-org · Oct 4, 2024 · cb3d49f · cb3d49f
1 parent ada0c6b
commit cb3d49f
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 101 deletions.
diff --git a/pom.xml b/pom.xml
@@ -38,7 +38,7 @@
     <mockwebserver.version>4.11.0</mockwebserver.version>
 
     <!-- plugins -->
-    <openapi-generator.version>6.2.1</openapi-generator.version>
+    <openapi-generator.version>7.4.0</openapi-generator.version>
     <copy-rename-maven-plugin.version>1.0.1</copy-rename-maven-plugin.version>
     <maven-release-plugin.version>3.0.0-M7</maven-release-plugin.version>
     <lombok.version>1.18.30</lombok.version>
@@ -324,6 +324,14 @@
               <supportingFilesToGenerate>ApiUtil.java</supportingFilesToGenerate>
               <generateModelDocumentation>true</generateModelDocumentation>
               <skipIfSpecIsUnchanged>true</skipIfSpecIsUnchanged>
+              <typeMappings>
+                <typeMapping>object+FqmMigrateRequest=FqmMigrateRequest</typeMapping>
+                <typeMapping>object+FqmMigrateResponse=FqmMigrateResponse</typeMapping>
+              </typeMappings>
+              <importMappings>
+                <importMapping>FqmMigrateRequest=org.folio.querytool.domain.dto.FqmMigrateRequest</importMapping>
+                <importMapping>FqmMigrateResponse=org.folio.querytool.domain.dto.FqmMigrateResponse</importMapping>
+              </importMappings>
               <configOptions>
                 <java8>true</java8>
                 <dateLibrary>java</dateLibrary>
@@ -333,16 +341,6 @@
               </configOptions>
             </configuration>
           </execution>
-          <execution>
-            <goals>
-              <goal>generate</goal>
-            </goals>
-            <configuration>
-              <inputSpec>${mod-fqm-manager.yaml.file}</inputSpec>
-              <output>${project.build.directory}/docs/mod-fqm-manager</output>
-              <generatorName>html2</generatorName>
-            </configuration>
-          </execution>
         </executions>
       </plugin>
 

diff --git a/src/main/java/org/folio/fqm/migration/warnings/Warning.java b/src/main/java/org/folio/fqm/migration/warnings/Warning.java
@@ -1,12 +1,16 @@
 package org.folio.fqm.migration.warnings;
 
+import jakarta.validation.constraints.NotNull;
 import javax.annotation.CheckForNull;
 import lombok.RequiredArgsConstructor;
 import org.folio.fqm.service.LocalizationService;
 import org.folio.spring.i18n.service.TranslationService;
 
 public interface Warning {
+  @NotNull
   WarningType getType();
+
+  @NotNull
   String getDescription(TranslationService translationService);
 
   public static String getDescriptionByAlternativeAndFql(

diff --git a/src/main/java/org/folio/fqm/resource/MigrationController.java b/src/main/java/org/folio/fqm/resource/MigrationController.java
@@ -1,17 +1,17 @@
 package org.folio.fqm.resource;
 
 import lombok.RequiredArgsConstructor;
-import org.folio.fqm.domain.dto.FqmMigrateRequest;
-import org.folio.fqm.domain.dto.FqmMigrateResponse;
-import org.folio.fqm.domain.dto.FqmMigrateResponseWarningsInner;
+
 import org.folio.fqm.migration.MigratableQueryInformation;
 import org.folio.fqm.service.MigrationService;
+import org.folio.querytool.domain.dto.FqmMigrateRequest;
+import org.folio.querytool.domain.dto.FqmMigrateResponse;
+import org.folio.querytool.domain.dto.FqmMigrateWarning;
 import org.folio.spring.i18n.service.TranslationService;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.RestController;
 
-
 @RestController
 @RequiredArgsConstructor
 public class MigrationController implements FqmVersionApi {
@@ -39,11 +39,9 @@ public ResponseEntity<FqmMigrateResponse> fqmMigrate(FqmMigrateRequest fqmMigrat
       .fqlQuery(updatedQueryInfo.fqlQuery())
       .fields(updatedQueryInfo.fields())
       .warnings(updatedQueryInfo.warnings().stream()
-        .map(warning -> new FqmMigrateResponseWarningsInner()
-          .type(warning.getType() != null ? warning.getType().toString() : null)
-          .description(warning.getDescription(translationService) != null ?
-            warning.getDescription(translationService) : "No description provided"
-          )
+        .map(warning -> new FqmMigrateWarning()
+          .type(warning.getType().toString())
+          .description(warning.getDescription(translationService))
         )
         .toList()
       );

diff --git a/src/main/resources/swagger.api/mod-fqm-manager.yaml b/src/main/resources/swagger.api/mod-fqm-manager.yaml
@@ -91,14 +91,18 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/fqmMigrateRequest'
+              description: Mapped to schema in folio-query-tool-metadata
+              type: object
+              format: FqmMigrateRequest
       responses:
         '200':
-          description:  'FQM version updated successfully'
+          description: 'FQM version updated successfully'
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/fqmMigrateResponse'
+                description: Mapped to schemas in folio-query-tool-metadata
+                type: object
+                format: FqmMigrateResponse
         '400':
           $ref: '#/components/responses/badRequestResponse'
         '500':
@@ -157,10 +161,6 @@ components:
           type: array
           items:
             type: string
-    fqmMigrateRequest:
-      $ref: schemas/FqmMigrateRequest.json
-    fqmMigrateResponse:
-      $ref: schemas/FqmMigrateResponse.json
 
   responses:
     badRequestResponse:

diff --git a/src/main/resources/swagger.api/schemas/FqmMigrateRequest.json b/src/main/resources/swagger.api/schemas/FqmMigrateRequest.json
diff --git a/src/main/resources/swagger.api/schemas/FqmMigrateResponse.json b/src/main/resources/swagger.api/schemas/FqmMigrateResponse.json
diff --git a/src/test/java/org/folio/fqm/controller/MigrationControllerTest.java b/src/test/java/org/folio/fqm/controller/MigrationControllerTest.java
@@ -1,12 +1,12 @@
 package org.folio.fqm.controller;
 
 import com.fasterxml.jackson.databind.ObjectMapper;
-import org.folio.fqm.domain.dto.FqmMigrateRequest;
 import org.folio.fqm.migration.MigratableQueryInformation;
 import org.folio.fqm.migration.warnings.DeprecatedEntityWarning;
 import org.folio.fqm.migration.warnings.Warning;
 import org.folio.fqm.resource.MigrationController;
 import org.folio.fqm.service.MigrationService;
+import org.folio.querytool.domain.dto.FqmMigrateRequest;
 import org.folio.spring.FolioExecutionContext;
 import org.folio.spring.i18n.service.TranslationService;
 import org.folio.spring.integration.XOkapiHeaders;