From d27f518f262ded1124cdfe838a219725dc57f7cf Mon Sep 17 00:00:00 2001
From: Sriharsha Chintalapani <harshach@users.noreply.github.com>
Date: Sat, 13 Jul 2024 06:38:20 -0700
Subject: [PATCH] Minor: Fix API docs (#17011)

* Fix API docs

* Fix Linting issues

---------

Co-authored-by: Ayush Shah <ayush@getcollate.io>
---
 .../service/resources/apis/APIEndpointResource.java   | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git 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
index 1f90f6ee951..5290dee4784 100644
--- 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
@@ -13,7 +13,6 @@
 
 package org.openmetadata.service.resources.apis;
 
-import com.google.api.Endpoint;
 import io.swagger.v3.oas.annotations.ExternalDocumentation;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
@@ -173,7 +172,8 @@ public class APIEndpointResource extends EntityResource<APIEndpoint, APIEndpoint
   public EntityHistory listVersions(
       @Context UriInfo uriInfo,
       @Context SecurityContext securityContext,
-      @Parameter(description = "Id of the topic", schema = @Schema(type = "UUID")) @PathParam("id")
+      @Parameter(description = "Id of the APIEndpoint", schema = @Schema(type = "UUID"))
+          @PathParam("id")
           UUID id) {
     return super.listVersionsInternal(securityContext, id);
   }
@@ -181,6 +181,7 @@ public class APIEndpointResource extends EntityResource<APIEndpoint, APIEndpoint
   @GET
   @Path("/{id}")
   @Operation(
+      operationId = "getEndpointById",
       summary = "Get a APIEndpoint by id",
       description = "Get a APIEndpoint by `id`.",
       responses = {
@@ -219,16 +220,16 @@ public class APIEndpointResource extends EntityResource<APIEndpoint, APIEndpoint
   @Path("/name/{fqn}")
   @Operation(
       operationId = "getEndpointByFQN",
-      summary = "Get a Endpoint by fully qualified name",
+      summary = "Get a Endpoint by fully qualified name.",
       description = "Get a Endpoint by fully qualified name.",
       responses = {
         @ApiResponse(
             responseCode = "200",
-            description = "The Endpoint",
+            description = "The APIEndpoint",
             content =
                 @Content(
                     mediaType = "application/json",
-                    schema = @Schema(implementation = Endpoint.class))),
+                    schema = @Schema(implementation = APIEndpoint.class))),
         @ApiResponse(responseCode = "404", description = "Endpoint for instance {fqn} is not found")
       })
   public APIEndpoint getByName(