Updated the Requirement-API to return if unsetting was successful. Added requirement-deletion to the rest api.

Author: sebinside

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceController.scala

@@ -150,7 +150,7 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
               if (!ConfigurationService.fulfillRequirementByDeserializing(instanceName, requirementID, targetType,
                 value, chatOverflow.pluginInstanceRegistry, chatOverflow.typeRegistry)) {
 
-                ResultMessage(success = false, "Unable to set requirement.")
+                ResultMessage(success = false, "Unable to set the requirement.")
               } else {
                 chatOverflow.save()
                 ResultMessage(success = true)
@@ -161,6 +161,40 @@ class PluginInstanceController(implicit val swagger: Swagger) extends JsonServle
     }
   }
 
+  delete("/:instanceName/requirements/:requirementID", operation(deleteRequirement)) {
+    authKeyRequired {
+      val instanceName = params("instanceName")
+      val requirementID = params("requirementID")
+
+      if (!chatOverflow.isLoaded) {
+        ResultMessage(success = false, "Framework not loaded.")
+
+      } else {
+        val pluginInstance = chatOverflow.pluginInstanceRegistry.getPluginInstance(instanceName)
+
+        if (pluginInstance.isEmpty) {
+          ResultMessage(success = false, "Plugin instance not found.")
+
+        } else if (pluginInstance.get.isRunning) {
+          ResultMessage(success = false, "Plugin is running.")
+
+        } else if (!pluginInstance.get.getRequirements.getRequirementById(requirementID).isPresent) {
+          ResultMessage(success = false, "Requirement not found.")
+        } else {
+
+          if (!pluginInstance.get.getRequirements.unsetRequirementById(requirementID)) {
+
+            ResultMessage(success = false, "Unable to remove the requirement. Already removed.")
+          } else {
+            chatOverflow.save()
+            ResultMessage(success = true)
+          }
+        }
+      }
+
+    }
+  }
+
   get("/:instanceName/log", operation(getLog)) {
     authKeyRequired {
       val instanceName = params("instanceName")

src/main/scala/org/codeoverflow/chatoverflow/ui/web/rest/plugin/PluginInstanceControllerDefinition.scala

@@ -44,6 +44,14 @@ trait PluginInstanceControllerDefinition extends SwaggerSupport with TagSupport
       parameter pathParam[String]("instanceName").description("The name of the plugin instance.")
       parameter pathParam[String]("requirementID").description("The unique id of the requirement.")
       parameter bodyParam[RequirementInfo]("body").description("Requires target type and serialized content."))
+  val deleteRequirement: OperationBuilder =
+    (apiOperation[ResultMessage]("deleteRequirement")
+      summary "Removes a specific requirement."
+      description "Removes a specific requirement by unseting its value."
+      tags controllerTag
+      parameter authHeader
+      parameter pathParam[String]("instanceName").description("The name of the plugin instance.")
+      parameter pathParam[String]("requirementID").description("The unique id of the requirement."))
   val getLog: OperationBuilder =
     (apiOperation[List[String]]("getLog")
       summary "Shows the log of a plugin instance."