#312 Add API to describe attributes of all entities

thehive-backend/app/controllers/DescribeCtrl.scala

@@ -4,6 +4,7 @@ import javax.inject.{ Inject, Singleton }
 
 import scala.concurrent.ExecutionContext
 
+import play.api.libs.json.{ JsObject, Json }
 import play.api.mvc.{ AbstractController, Action, AnyContent, ControllerComponents }
 
 import models.Roles
@@ -32,4 +33,17 @@ class DescribeCtrl @Inject() (
       }
       .getOrElse(NotFound(s"Model $modelName not found"))
   }
+
+  private val allModels: Seq[String] = Seq("case", "case_artifact", "case_task", "alert")
+  def describeAll: Action[AnyContent] = authenticated(Roles.read) { implicit request ⇒
+    val entityDefinitions = modelSrv.list
+      .collect {
+        case model if allModels.contains(model.name) ⇒
+          val attributeDefinitions = model.attributes.flatMap {
+            case attribute: Attribute[t] ⇒ attribute.format.definition(dblists, attribute)
+          }
+          model.name → Json.toJson(attributeDefinitions)
+      }
+    renderer.toOutput(OK, JsObject(entityDefinitions))
+  }
 }

thehive-backend/conf/routes

@@ -100,6 +100,7 @@ POST     /api/stream                              controllers.StreamCtrl.create(
 GET      /api/stream/status                       controllers.StreamCtrl.status
 GET      /api/stream/:streamId                    controllers.StreamCtrl.get(streamId)
 
+GET      /api/describe/_all                       controllers.DescribeCtrl.describeAll
 GET      /api/describe/:modelName                 controllers.DescribeCtrl.describe(modelName)
 
 ->       /api/connector                           connectors.ConnectorRouter