From 0218b3589aa66cd7ff7e3dedfc8f0f3f9c348a3a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20Pa=C3=9F?=
 <22845248+mpass99@users.noreply.github.com>
Date: Wed, 31 Aug 2022 11:35:46 +0200
Subject: [PATCH] Add openAPI definition of the WebSocket endpoint.

---
 api/swagger.yaml | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/api/swagger.yaml b/api/swagger.yaml
index 33f477d..e527e6b 100644
--- a/api/swagger.yaml
+++ b/api/swagger.yaml
@@ -506,6 +506,39 @@ paths:
         "500":
           $ref: "#/components/responses/InternalServerError"
 
+  /runners/{runnerId}/websocket:
+    get:
+      summary: Connect to an execution.
+      description: The url including all parameters will be generated and returned by the `execute` route. This is a WebSocket endpoint. The schema for the WS communication is described in `websocket.schema.json`.
+      tags:
+        - runner
+      parameters:
+        - name: runnerId
+          description: Runner on which the execution is created.
+          in: path
+          schema:
+            type: string
+            example: 123e4567-e89b-12d3-a456-426614174000
+          required: true
+        - name: executionID
+          description: The execution of the runner that you want to connect to.
+          in: query
+          schema:
+            type: string
+            example: 123e4567-e89b-12d3-a456-426614174000
+          required: true
+      responses:
+        "101":
+          description: Success. Switching protocols to WebSocket.
+        "401":
+          $ref: "#/components/responses/Unauthorized"
+        "404":
+          $ref: "#/components/responses/NotFound"
+        "410":
+          $ref: "#/components/responses/RunnerGone"
+        "500":
+          $ref: "#/components/responses/InternalServerError"
+
   /execution-environments:
     get:
       summary: List execution environments