Merge branch 'schema' into 'main'

Feature Type Schema

See merge request !678

src/main/java/gov/usgs/earthquake/nshmp/www/SwaggerController.java

@@ -5,6 +5,7 @@ import java.util.List;
 import org.slf4j.LoggerFactory;
 
 import gov.usgs.earthquake.nshmp.model.HazardModel;
+import gov.usgs.earthquake.nshmp.www.source.FeaturesService;
 
 import io.micronaut.http.HttpRequest;
 import io.micronaut.http.HttpResponse;
@@ -56,6 +57,7 @@ public class SwaggerController {
     var schemas = components.getSchemas();
     SwaggerUtils.siteClassSchema(schemas, List.copyOf(model.siteClasses().keySet()));
     SwaggerUtils.imtSchema(schemas, List.copyOf(model.config().hazard.imts));
+    FeaturesService.featureTypeSchema(schemas);
     openApi.servers(null);
 
     openApi.getInfo().setTitle(model.name() + " Web Services");

src/main/java/gov/usgs/earthquake/nshmp/www/source/FeaturesService.java

@@ -2,7 +2,10 @@ package gov.usgs.earthquake.nshmp.www.source;
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
+import java.util.Set;
+import java.util.TreeSet;
 import java.util.stream.Collectors;
 
 import org.slf4j.Logger;
@@ -22,6 +25,8 @@ import gov.usgs.earthquake.nshmp.www.source.SourceService.SourceModel;
 
 import io.micronaut.http.HttpRequest;
 import io.micronaut.http.HttpResponse;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.parser.util.SchemaTypeUtil;
 import jakarta.inject.Singleton;
 
 /**
@@ -44,6 +49,44 @@ public class FeaturesService {
     }
   }
 
+  /**
+   * Updates the {@code FeatureType} enum schema to Swagger.
+   *
+   * @param schemas The Swagger schemas
+   */
+  public static void featureTypeSchema(Map<String, Schema> schemas) {
+    var schema = new Schema<FeatureType>();
+    schema.setType(SchemaTypeUtil.STRING_TYPE);
+    featureTypes().stream().forEach(featureType -> schema.addEnumItemObject(featureType));
+
+    schemas.put(
+        String.format(
+            "%s.%s",
+            FeaturesService.class.getSimpleName(),
+            FeatureType.class.getSimpleName()),
+        schema);
+  }
+
+  private static Set<FeatureType> featureTypes() {
+    Set<FeatureType> featureTypes = new TreeSet<>();
+    featureTypes.add(FeatureType.ALL);
+
+    Arrays.stream(FeatureType.values())
+        .sorted()
+        .filter(featureType -> featureType != FeatureType.ALL)
+        .forEach(featureType -> {
+          var features = Models.features(
+              ServletUtil.model(),
+              Optional.of(SourceType.valueOf(featureType.name())));
+
+          if (features.isPresent()) {
+            featureTypes.add(featureType);
+          }
+        });
+
+    return featureTypes;
+  }
+
   private static HttpResponse<String> processResponse(
       HttpRequest<?> request,
       RequestData requestData) {
@@ -51,10 +94,14 @@ public class FeaturesService {
 
     var features = requestData.featureType == FeatureType.ALL
         ? Models.features(ServletUtil.model(), Optional.empty())
-        : Models.features(ServletUtil.model(),
+        : Models.features(
+            ServletUtil.model(),
             Optional.of(SourceType.valueOf(requestData.featureType.name())));
 
-    // TODO check features.isEmpty() and redirect to error response
+    if (features.isEmpty()) {
+      throw new IllegalStateException(
+          String.format("No features found for type %s", requestData.featureType));
+    }
 
     if (requestData.raw) {
       return HttpResponse.ok(features.orElseThrow().toJson());
@@ -124,17 +171,17 @@ public class FeaturesService {
 
     Metadata(HazardModel model) {
       this.model = new SourceModel(model);
-      this.featureType = Arrays.stream(FeatureType.values())
+      this.featureType = featureTypes().stream()
           .map(featureType -> new Parameter(featureType.toString(), featureType.name()))
           .collect(Collectors.toList());
     }
 
-    public SourceModel getModel() {
-      return model;
+    public List<Parameter> getFeatureType() {
+      return featureType;
     }
 
-    public List<Parameter> getSourceType() {
-      return featureType;
+    public SourceModel getModel() {
+      return model;
     }
   }
 }