From 6623fa3397ab6a82b374d9caa1fd46b16bce58e6 Mon Sep 17 00:00:00 2001
From: Peter Powers <pmpowers@usgs.gov>
Date: Thu, 2 Jun 2022 08:28:06 -0600
Subject: [PATCH] service and response names consistent
---
.../usgs/earthquake/nshmp/www/hazard/DisaggController.java | 3 +--
.../usgs/earthquake/nshmp/www/hazard/DisaggService.java | 3 +--
.../usgs/earthquake/nshmp/www/hazard/HazardController.java | 3 +--
.../usgs/earthquake/nshmp/www/hazard/HazardService.java | 2 +-
.../earthquake/nshmp/www/source/ProbabilityController.java | 3 +--
.../usgs/earthquake/nshmp/www/source/RateController.java | 3 +--
.../gov/usgs/earthquake/nshmp/www/source/RateService.java | 7 +++----
.../usgs/earthquake/nshmp/www/source/SourceController.java | 3 +--
.../nshmp/www/source/SourceLogicTreesController.java | 2 +-
.../nshmp/www/source/SourceLogicTreesService.java | 3 +--
.../usgs/earthquake/nshmp/www/source/SourceService.java | 2 +-
11 files changed, 13 insertions(+), 21 deletions(-)
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggController.java b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggController.java
index 6a1d8de39..26e18c2f0 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggController.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggController.java
@@ -15,7 +15,6 @@ import gov.usgs.earthquake.nshmp.www.hazard.DisaggService.RequestIml;
import gov.usgs.earthquake.nshmp.www.hazard.DisaggService.RequestRp;
import gov.usgs.earthquake.nshmp.www.hazard.DisaggService.Response;
import gov.usgs.earthquake.nshmp.www.hazard.HazardService.Metadata;
-
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
@@ -44,7 +43,7 @@ import jakarta.inject.Inject;
* @author U.S. Geological Survey
*/
@Tag(
- name = "Hazard Disaggregation",
+ name = DisaggService.NAME,
description = "USGS NSHM hazard disaggregation service")
@Controller("/disagg")
public class DisaggController {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggService.java b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggService.java
index 124d9bcfb..94d502dec 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggService.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/DisaggService.java
@@ -36,7 +36,6 @@ import gov.usgs.earthquake.nshmp.www.ServletUtil.Server;
import gov.usgs.earthquake.nshmp.www.hazard.HazardService.HazardRequest;
import gov.usgs.earthquake.nshmp.www.hazard.HazardService.Metadata;
import gov.usgs.earthquake.nshmp.www.meta.Parameter;
-
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import jakarta.inject.Singleton;
@@ -57,7 +56,7 @@ public final class DisaggService {
* OR imt=iml pairs
*/
- static final String NAME = "Disaggregation Service";
+ static final String NAME = "Hazard Disaggregation";
static final Logger LOG = LoggerFactory.getLogger(DisaggService.class);
// TODO range check return periods and imls
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardController.java b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardController.java
index 9dbddb3a2..628a48269 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardController.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardController.java
@@ -9,7 +9,6 @@ import gov.usgs.earthquake.nshmp.www.ServletUtil;
import gov.usgs.earthquake.nshmp.www.hazard.HazardService.Metadata;
import gov.usgs.earthquake.nshmp.www.hazard.HazardService.Request;
import gov.usgs.earthquake.nshmp.www.hazard.HazardService.Response;
-
import io.micronaut.core.annotation.Nullable;
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
@@ -38,7 +37,7 @@ import jakarta.inject.Inject;
* @author U.S. Geological Survey
*/
@Tag(
- name = "Hazard Calculation",
+ name = HazardService.NAME,
description = "USGS NSHM hazard calculation service")
@Controller("/hazard")
public class HazardController {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardService.java b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardService.java
index a0d5792ea..58ac15e46 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardService.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/hazard/HazardService.java
@@ -53,7 +53,7 @@ import jakarta.inject.Singleton;
@Singleton
public final class HazardService {
- static final String NAME = "Hazard Service";
+ static final String NAME = "Hazard Curves";
static final Logger LOG = LoggerFactory.getLogger(HazardService.class);
private static final String TOTAL_KEY = "Total";
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/ProbabilityController.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/ProbabilityController.java
index 202e71e23..471bf2f47 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/ProbabilityController.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/ProbabilityController.java
@@ -6,7 +6,6 @@ import gov.usgs.earthquake.nshmp.www.ServletUtil;
import gov.usgs.earthquake.nshmp.www.source.RateService.ProbMetadata;
import gov.usgs.earthquake.nshmp.www.source.RateService.Request;
import gov.usgs.earthquake.nshmp.www.source.RateService.Response;
-
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
@@ -32,7 +31,7 @@ import jakarta.inject.Inject;
* @author U.S. Geological Survey
*/
@Tag(
- name = "Earthquake Probability Calculation",
+ name = RateService.NAME_PROBABILITY,
description = "USGS NSHM earthquake probability calculation service")
@Controller("/probability")
public class ProbabilityController {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateController.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateController.java
index c77d04303..b82dac9d5 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateController.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateController.java
@@ -6,7 +6,6 @@ import gov.usgs.earthquake.nshmp.www.ServletUtil;
import gov.usgs.earthquake.nshmp.www.source.RateService.Metadata;
import gov.usgs.earthquake.nshmp.www.source.RateService.Request;
import gov.usgs.earthquake.nshmp.www.source.RateService.Response;
-
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
@@ -32,7 +31,7 @@ import jakarta.inject.Inject;
* @author U.S. Geological Survey
*/
@Tag(
- name = "Earthquake Rate Calculation",
+ name = RateService.NAME_RATE,
description = "USGS NSHM earthquake rate calculation service")
@Controller("/rate")
public class RateController {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateService.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateService.java
index 924070e7e..debaff320 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateService.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/RateService.java
@@ -42,8 +42,8 @@ import jakarta.inject.Singleton;
@Singleton
public final class RateService {
- static final String NAME_RATE = "Earthquake Rate Service";
- static final String NAME_PROBABILITY = "Earthquake Probability Service";
+ static final String NAME_RATE = "Earthquake Rates";
+ static final String NAME_PROBABILITY = "Earthquake Probabilities";
static final Logger LOG = LoggerFactory.getLogger(RateService.class);
/*
@@ -348,7 +348,7 @@ public final class RateService {
var url = request.getUri().toString();
var usage = new ProbMetadata(ServletUtil.model());
var body = ResponseBody.usage()
- .name(NAME_RATE)
+ .name(NAME_PROBABILITY)
.url(url)
.metadata(new ResponseMetadata(HazVersion.appVersions()))
.request(url)
@@ -367,7 +367,6 @@ public final class RateService {
Metadata(HazardModel model) {
this.model = new SourceModel(model);
- // TODO should get min max from model (fix via swagger openapi injection)
longitude = new DoubleParameter(
"Longitude",
"°",
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceController.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceController.java
index 7c4c8b571..4c67995ba 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceController.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceController.java
@@ -4,7 +4,6 @@ import gov.usgs.earthquake.nshmp.www.NshmpMicronautServlet;
import gov.usgs.earthquake.nshmp.www.ResponseBody;
import gov.usgs.earthquake.nshmp.www.ServletUtil;
import gov.usgs.earthquake.nshmp.www.source.SourceService.ResponseData;
-
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import io.micronaut.http.MediaType;
@@ -30,7 +29,7 @@ import jakarta.inject.Inject;
* @author U.S. Geological Survey
*/
@Tag(
- name = "Source Model Information",
+ name = SourceService.NAME,
description = "USGS NSHM source model metadata service")
@Controller("/source")
public class SourceController {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesController.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesController.java
index e15433041..0c239d4a5 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesController.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesController.java
@@ -30,7 +30,7 @@ import jakarta.inject.Inject;
* @author U.S. Geological Survey
*/
@Tag(
- name = "Source Model Logic Trees",
+ name = SourceLogicTreesService.NAME,
description = "USGS NSHM source model logic tree service")
@Controller("/trees")
public class SourceLogicTreesController {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesService.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesService.java
index d2bfdef9b..0777b148c 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesService.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceLogicTreesService.java
@@ -10,7 +10,6 @@ import gov.usgs.earthquake.nshmp.www.ResponseBody;
import gov.usgs.earthquake.nshmp.www.ResponseMetadata;
import gov.usgs.earthquake.nshmp.www.ServletUtil;
import gov.usgs.earthquake.nshmp.www.source.SourceService.SourceModel;
-
import io.micronaut.http.HttpRequest;
import io.micronaut.http.HttpResponse;
import jakarta.inject.Singleton;
@@ -23,7 +22,7 @@ import jakarta.inject.Singleton;
@Singleton
public class SourceLogicTreesService {
- static final String NAME = "Source Logic Trees";
+ static final String NAME = "Model Logic Trees";
static final Logger LOG = LoggerFactory.getLogger(SourceLogicTreesService.class);
public static HttpResponse<String> getMetadata(HttpRequest<?> request) {
diff --git a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceService.java b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceService.java
index 3ecba39d3..777cd4b06 100644
--- a/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceService.java
+++ b/src/main/java/gov/usgs/earthquake/nshmp/www/source/SourceService.java
@@ -29,7 +29,7 @@ import jakarta.inject.Singleton;
@Singleton
public class SourceService {
- static final String NAME = "Source Model";
+ static final String NAME = "Model Contents";
static final Logger LOG = LoggerFactory.getLogger(SourceService.class);
static HttpResponse<String> getMetadata(HttpRequest<?> request) {
--
GitLab