Fix #18039 - Fix incorrect @Schema implementations in Swagger annotations (#18040)

2025-12-27 15:38:43 +00:00 · 2024-09-29 10:23:30 +05:30 · 2024-09-29 10:23:30 +05:30 · 9c74964f85
commit 9c74964f85
parent 891b09887d
10 changed files with 33 additions and 39 deletions
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/apis/APIEndpointResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/apis/APIEndpointResource.java
@ -47,7 +47,6 @@ import org.openmetadata.schema.api.VoteRequest;
 import org.openmetadata.schema.api.data.CreateAPIEndpoint;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.entity.data.APIEndpoint;
-import org.openmetadata.schema.entity.data.Topic;
 import org.openmetadata.schema.type.ChangeEvent;
 import org.openmetadata.schema.type.EntityHistory;
 import org.openmetadata.schema.type.Include;
@ -370,17 +369,17 @@ public class APIEndpointResource extends EntityResource<APIEndpoint, APIEndpoint
  @PUT
  @Operation(
      operationId = "createOrUpdateAPIEndpoint",
-      summary = "Update topic",
+      summary = "Update API Endpoint",
      description =
          "Create a API Endpoint, it it does not exist or update an existing API Endpoint.",
      responses = {
        @ApiResponse(
            responseCode = "200",
-            description = "The updated topic ",
+            description = "The updated api endpoint ",
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Topic.class)))
+                    schema = @Schema(implementation = APIEndpoint.class)))
      })
  public Response createOrUpdate(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/databases/DatabaseResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/databases/DatabaseResource.java
@ -51,7 +51,6 @@ import org.openmetadata.schema.api.VoteRequest;
 import org.openmetadata.schema.api.data.CreateDatabase;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.entity.data.Database;
-import org.openmetadata.schema.entity.data.Table;
 import org.openmetadata.schema.type.ChangeEvent;
 import org.openmetadata.schema.type.DatabaseProfilerConfig;
 import org.openmetadata.schema.type.EntityHistory;
@ -566,7 +565,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
  @Operation(
      operationId = "addDataProfilerConfig",
      summary = "Add database profile config",
-      description = "Add database profile config to the table.",
+      description = "Add database profile config to the database.",
      responses = {
        @ApiResponse(
            responseCode = "200",
@ -574,7 +573,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Table.class)))
+                    schema = @Schema(implementation = Database.class)))
      })
  public Database addDataProfilerConfig(
      @Context UriInfo uriInfo,
@ -595,7 +594,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
  @Operation(
      operationId = "getDataProfilerConfig",
      summary = "Get database profile config",
-      description = "Get database profile config to the table.",
+      description = "Get database profile config to the database.",
      responses = {
        @ApiResponse(
            responseCode = "200",
@ -603,7 +602,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Table.class)))
+                    schema = @Schema(implementation = Database.class)))
      })
  public Database getDataProfilerConfig(
      @Context UriInfo uriInfo,
@ -633,7 +632,7 @@ public class DatabaseResource extends EntityResource<Database, DatabaseRepositor
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Table.class)))
+                    schema = @Schema(implementation = Database.class)))
      })
  public Database deleteDataProfilerConfig(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/databases/StoredProcedureResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/databases/StoredProcedureResource.java
@ -19,7 +19,6 @@ import javax.ws.rs.core.*;
 import org.openmetadata.schema.api.VoteRequest;
 import org.openmetadata.schema.api.data.CreateStoredProcedure;
 import org.openmetadata.schema.api.data.RestoreEntity;
-import org.openmetadata.schema.entity.data.DatabaseSchema;
 import org.openmetadata.schema.entity.data.StoredProcedure;
 import org.openmetadata.schema.type.ChangeEvent;
 import org.openmetadata.schema.type.EntityHistory;
@ -511,18 +510,18 @@ public class StoredProcedureResource
  @Path("/restore")
  @Operation(
      operationId = "restore",
-      summary = "Restore a soft deleted database schema.",
-      description = "Restore a soft deleted database schema.",
+      summary = "Restore a soft deleted stored procedure.",
+      description = "Restore a soft deleted stored procedure.",
      responses = {
        @ApiResponse(
            responseCode = "200",
-            description = "Successfully restored the DatabaseSchema ",
+            description = "Successfully restored the StoredProcedure ",
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = DatabaseSchema.class)))
+                    schema = @Schema(implementation = StoredProcedure.class)))
      })
-  public Response restoreDatabaseSchema(
+  public Response restoreStoredProcedure(
      @Context UriInfo uriInfo,
      @Context SecurityContext securityContext,
      @Valid RestoreEntity restore) {
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/glossary/GlossaryTermResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/glossary/GlossaryTermResource.java
@ -271,8 +271,10 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Glossary.class))),
-        @ApiResponse(responseCode = "404", description = "Glossary for instance {id} is not found")
+                    schema = @Schema(implementation = GlossaryTerm.class))),
+        @ApiResponse(
+            responseCode = "404",
+            description = "Glossary term for instance {id} is not found")
      })
  public GlossaryTerm get(
      @Context UriInfo uriInfo,
@ -307,8 +309,10 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Glossary.class))),
-        @ApiResponse(responseCode = "404", description = "Glossary for instance {fqn} is not found")
+                    schema = @Schema(implementation = GlossaryTerm.class))),
+        @ApiResponse(
+            responseCode = "404",
+            description = "Glossary term for instance {fqn} is not found")
      })
  public GlossaryTerm getByName(
      @Context UriInfo uriInfo,
@ -365,14 +369,14 @@ public class GlossaryTermResource extends EntityResource<GlossaryTerm, GlossaryT
      responses = {
        @ApiResponse(
            responseCode = "200",
-            description = "glossaries",
+            description = "The glossary term",
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Glossary.class))),
+                    schema = @Schema(implementation = GlossaryTerm.class))),
        @ApiResponse(
            responseCode = "404",
-            description = "Glossary for instance {id} and version {version} is not found")
+            description = "Glossary term for instance {id} and version {version} is not found")
      })
  public GlossaryTerm getVersion(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/pipelines/PipelineResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/pipelines/PipelineResource.java
@ -62,7 +62,6 @@ import org.openmetadata.service.jdbi3.PipelineRepository;
 import org.openmetadata.service.limits.Limits;
 import org.openmetadata.service.resources.Collection;
 import org.openmetadata.service.resources.EntityResource;
-import org.openmetadata.service.resources.dqtests.TestCaseResource;
 import org.openmetadata.service.security.Authorizer;
 import org.openmetadata.service.security.policyevaluator.OperationContext;
 import org.openmetadata.service.util.ResultList;
@ -444,7 +443,7 @@ public class PipelineResource extends EntityResource<Pipeline, PipelineRepositor
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = TestCaseResource.TestCaseList.class)))
+                    schema = @Schema(implementation = PipelineResource.PipelineStatusList.class)))
      })
  public ResultList<PipelineStatus> list(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/dashboard/DashboardServiceResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/dashboard/DashboardServiceResource.java
@ -48,7 +48,6 @@ import javax.ws.rs.core.UriInfo;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.api.services.CreateDashboardService;
 import org.openmetadata.schema.entity.services.DashboardService;
-import org.openmetadata.schema.entity.services.DatabaseService;
 import org.openmetadata.schema.entity.services.ServiceType;
 import org.openmetadata.schema.entity.services.connections.TestConnectionResult;
 import org.openmetadata.schema.type.DashboardConnection;
@ -226,7 +225,7 @@ public class DashboardServiceResource
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = DatabaseService.class)))
+                    schema = @Schema(implementation = DashboardService.class)))
      })
  public DashboardService addTestConnectionResult(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/messaging/MessagingServiceResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/messaging/MessagingServiceResource.java
@ -47,7 +47,6 @@ import javax.ws.rs.core.SecurityContext;
 import javax.ws.rs.core.UriInfo;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.api.services.CreateMessagingService;
-import org.openmetadata.schema.entity.services.DatabaseService;
 import org.openmetadata.schema.entity.services.MessagingService;
 import org.openmetadata.schema.entity.services.ServiceType;
 import org.openmetadata.schema.entity.services.connections.TestConnectionResult;
@ -232,7 +231,7 @@ public class MessagingServiceResource
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = DatabaseService.class)))
+                    schema = @Schema(implementation = MessagingService.class)))
      })
  public MessagingService addTestConnectionResult(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/metadata/MetadataServiceResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/metadata/MetadataServiceResource.java
@ -40,8 +40,6 @@ import javax.ws.rs.core.UriInfo;
 import lombok.extern.slf4j.Slf4j;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.api.services.CreateMetadataService;
-import org.openmetadata.schema.entity.data.Table;
-import org.openmetadata.schema.entity.services.DatabaseService;
 import org.openmetadata.schema.entity.services.MetadataConnection;
 import org.openmetadata.schema.entity.services.MetadataService;
 import org.openmetadata.schema.entity.services.ServiceType;
@ -272,7 +270,7 @@ public class MetadataServiceResource
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = DatabaseService.class)))
+                    schema = @Schema(implementation = MetadataService.class)))
      })
  public MetadataService addTestConnectionResult(
      @Context UriInfo uriInfo,
@ -541,13 +539,13 @@ public class MetadataServiceResource
      responses = {
        @ApiResponse(
            responseCode = "200",
-            description = "Successfully restored the Table ",
+            description = "Successfully restored the MetadataService ",
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = Table.class)))
+                    schema = @Schema(implementation = MetadataService.class)))
      })
-  public Response restoreTable(
+  public Response restoreMetadataService(
      @Context UriInfo uriInfo,
      @Context SecurityContext securityContext,
      @Valid RestoreEntity restore) {
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/mlmodel/MlModelServiceResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/mlmodel/MlModelServiceResource.java
@ -49,7 +49,6 @@ import javax.ws.rs.core.SecurityContext;
 import javax.ws.rs.core.UriInfo;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.api.services.CreateMlModelService;
-import org.openmetadata.schema.entity.services.DatabaseService;
 import org.openmetadata.schema.entity.services.MlModelService;
 import org.openmetadata.schema.entity.services.ServiceType;
 import org.openmetadata.schema.entity.services.connections.TestConnectionResult;
@ -245,7 +244,7 @@ public class MlModelServiceResource
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = DatabaseService.class)))
+                    schema = @Schema(implementation = MlModelService.class)))
      })
  public MlModelService addTestConnectionResult(
      @Context UriInfo uriInfo,
--- a/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/pipeline/PipelineServiceResource.java
+++ b/openmetadata-service/src/main/java/org/openmetadata/service/resources/services/pipeline/PipelineServiceResource.java
@ -47,7 +47,6 @@ import javax.ws.rs.core.SecurityContext;
 import javax.ws.rs.core.UriInfo;
 import org.openmetadata.schema.api.data.RestoreEntity;
 import org.openmetadata.schema.api.services.CreatePipelineService;
-import org.openmetadata.schema.entity.services.DatabaseService;
 import org.openmetadata.schema.entity.services.PipelineService;
 import org.openmetadata.schema.entity.services.ServiceType;
 import org.openmetadata.schema.entity.services.connections.TestConnectionResult;
@ -246,7 +245,7 @@ public class PipelineServiceResource
            content =
                @Content(
                    mediaType = "application/json",
-                    schema = @Schema(implementation = DatabaseService.class)))
+                    schema = @Schema(implementation = PipelineService.class)))
      })
  public PipelineService addTestConnectionResult(
      @Context UriInfo uriInfo,