Merge pull request #78 from delphi-hub/feature/documentationForCommandRoute

Added swagger documentation for command route

Author: johannesduesing

OpenAPISpecification.yaml

@@ -661,6 +661,36 @@ paths:
           description: One of the ids was not found on the server
         '500':
           description: Internal server error
+  /command:
+    post:
+      tags:
+        - Docker Operations
+      summary: Runs a command into a docker container
+      description: >-
+        This command runs a specified command inside a docker container.
+      operationId: command
+      parameters:
+        - in: query
+          name: Id
+          description: The ID of the instance that is a docker container
+          required: true
+          type: integer
+          format: int64
+        - in: query
+          name: Command
+          description: The Command thet will run inside a container
+          required: true
+          type: string
+      responses:
+        '200':
+          description: 'OK'
+        '400':
+          description: >-
+            Cannot run command, ID is no docker container.
+        '404':
+          description: Cannot run command, ID not found.
+        '500':
+          description: Internal server error, unknown operation result DESCRIPTION
 definitions:
   InstanceNetwork:
     type: object

src/main/scala/de/upb/cs/swt/delphi/instanceregistry/connection/Server.scala

@@ -649,7 +649,7 @@ class Server (handler: RequestHandler) extends HttpApp
 
   /**
     * Called to run a command in a  docker container. The Id an Command is the required parameter there are other optional parameter can be passed
-    * a query with required parameter Command and Id (so the resulting call is /delete?Id=42&Command=ls).
+    * a query with required parameter Command and Id (so the resulting call is /command?Id=42&Command=ls).
     * @return Server route that either maps to 200 Ok or the respective error codes.
     */
   def runCommandInContainer() : server.Route = parameters('Id.as[Long], 'Command.as[String],