Update swagger doc

src/hazard/src/main/java/gov/usgs/earthquake/nshmp/netcdf/www/NetcdfController.java

@@ -9,7 +9,7 @@ import gov.usgs.earthquake.nshmp.netcdf.NetcdfHazardCurves;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.RequestDataImt;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.RequestDataSiteClass;
 import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.ResponseData;
-import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfService.ResponseMetadata;
+import gov.usgs.earthquake.nshmp.netcdf.www.NetcdfServiceHazardCurves.HazardResponseMetadata;
 import gov.usgs.earthquake.nshmp.www.NshmpMicronautServlet;
 import gov.usgs.earthquake.nshmp.www.ResponseBody;
 
@@ -24,7 +24,6 @@ import io.micronaut.http.annotation.Get;
 import io.micronaut.http.annotation.PathVariable;
 import io.micronaut.http.annotation.QueryValue;
 import io.micronaut.runtime.event.annotation.EventListener;
-import io.swagger.v3.oas.annotations.Hidden;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
 import io.swagger.v3.oas.annotations.media.Schema;
@@ -72,9 +71,15 @@ public class NetcdfController {
   @Operation(
       summary = "Returns static curves given a longitude, latitude, site class, and IMT",
       description = "### Returns hazard curves for a " +
-          "user-specified latitude, longitude, site class, and IMT." +
-          "\n" +
-          "Enter the latitude and longitude select the site class and IMT, and press `Execute`.",
+          "user-specified latitude, longitude, site class, and IMT.\n" +
+
+          "Enter the latitude and longitude select the site class and IMT, and press `Execute`.\n" +
+
+          "### Service call pattern\n" +
+          "This service call is slashed delimited with pattern: " +
+          "`/hazard/{longitude}/{latitude}/{siteClass}/{imt}`\n" +
+          "<br><br>" +
+          "Example: `/hazard/-118/34/BC/PGA`",
       operationId = "hazard-by-imt")
   @ApiResponse(
       description = "Spatially interpolated hazard curves",
@@ -102,9 +107,15 @@ public class NetcdfController {
   @Operation(
       summary = "Returns static curves given a longitude, latitude, and site class.",
       description = "### Returns hazard curves for a " +
-          "user-specified latitude, longitude, and site class." +
-          "\n" +
-          "Enter the latitude and longitude select the site class, and press `Execute`.",
+          "user-specified latitude, longitude, and site class.\n" +
+
+          "Enter the latitude and longitude select the site class, and press `Execute`.\n" +
+
+          "### Service call pattern\n" +
+          "This service call is slashed delimited with pattern: " +
+          "`/hazard/{longitude}/{latitude}/{siteClass}`\n" +
+          "<br><br>" +
+          "Example: `/hazard/-118/34/BC`",
       operationId = "hazard-by-siteclass")
   @ApiResponse(
       description = "Spatially interpolated hazard curves",
@@ -130,9 +141,15 @@ public class NetcdfController {
   @Operation(
       summary = "Returns static curves given a longitude and latitude",
       description = "### Returns hazard curves for all site class for a " +
-          "user-specified latitude and longitude." +
-          "\n" +
-          "Enter the latitude and longitude and press `Execute`.",
+          "user-specified latitude and longitude.\n" +
+
+          "Enter the latitude and longitude and press `Execute`.\n" +
+
+          "### Service call pattern\n" +
+          "This service call is slashed delimited with pattern: " +
+          "`/hazard/{longitude}/{latitude}`\n" +
+          "<br><br>" +
+          "Example: `/hazard/-118/34`",
       operationId = "hazard")
   @ApiResponse(
       description = "Returns static curves from the NSHM NetCDF file",
@@ -155,7 +172,25 @@ public class NetcdfController {
    * @param latitude Latitude of the site
    * @param siteClass The site class (optional)
    */
-  @Hidden
+  @Operation(
+      summary = "Returns static curves given a longitude, latitude, site class, and IMT",
+      description = "### Returns hazard curves for a " +
+          "user-specified latitude, longitude, site class, and IMT.\n" +
+
+          "Enter the latitude and longitude select the site class (optional) and " +
+          "IMT (optional), and press `Execute`.\n" +
+
+          "### Service call pattern\n" +
+          "This service call is query based with pattern: " +
+          "`/hazard?longitude={number}&latitude={number}&siteClass={string}&imt={string}`\n" +
+          "<br><br>" +
+          "Example: `/hazard?longitude=-118&latitude=34&siteClass=A&imt=PGA`",
+      operationId = "hazard-by-imt")
+  @ApiResponse(
+      description = "Spatially interpolated hazard curves",
+      responseCode = "200",
+      content = @Content(
+          schema = @Schema(implementation = ResponseByImt.class)))
   @Get(uri = "{?longitude,latitude,siteClass,imt}", produces = MediaType.APPLICATION_JSON)
   public HttpResponse<String> doGet(
       HttpRequest<?> request,
@@ -170,15 +205,15 @@ public class NetcdfController {
   // For Swagger schema
   private static class ResponseByImt
       extends
-      ResponseBody<RequestDataImt, ResponseData<ResponseMetadata>> {}
+      ResponseBody<RequestDataImt, ResponseData<HazardResponseMetadata>> {}
 
   // For Swagger schema
   private static class ResponseBySiteClass
       extends
-      ResponseBody<RequestDataSiteClass, List<ResponseData<ResponseMetadata>>> {}
+      ResponseBody<RequestDataSiteClass, List<ResponseData<HazardResponseMetadata>>> {}
 
   // For Swagger schema
   private static class Response
       extends
-      ResponseBody<RequestDataSiteClass, List<List<ResponseData<ResponseMetadata>>>> {}
+      ResponseBody<RequestDataSiteClass, List<List<ResponseData<HazardResponseMetadata>>>> {}
 }