Remove overdrive

Author: JonasWanke

.github/workflows/generate-docs.yaml

@@ -21,9 +21,7 @@ jobs:
         run: python -m pip install -U md2html-phuker
 
       - name: Generate HTML documentation
-        run: |
-          md2html docs/s4-api-docs.md
-          md2html docs/s4-api-docs-od.md
+        run: md2html docs/s4-api-docs.md
 
       - name: Upload artifact
         uses: actions/upload-artifact@v4

docs/s4-api-docs-od.md

@@ -4,7 +4,7 @@ This is the API documentation for the AEC 2024 Skill 08 Session 4 API.
 
 ## Events
 
-The API provides an endpoint to subscribe to the actions of an event.
+The API provides endpoints to subscribe to the actions of an event and to send an answer to a voting poll.
 
 ### Subscribe to an Event
 
@@ -16,7 +16,7 @@ For the initial request, it is possible to pass the query parameter `wait=false`
 GET /events/:id/subscribe
 ```
 
-Example Response
+Example Responses
 
 ```json
 {
@@ -25,3 +25,30 @@ Example Response
   }
 }
 ```
+
+```json
+{
+  "action": {
+    "type": "vote",
+    "question": "Which protocol is used to transfer web pages over the internet?",
+    "answerA": "HTTP",
+    "answerB": "FTP"
+  }
+}
+```
+
+### Answer a Poll
+
+This endpoint allows clients to answer a poll. The client should make a POST request to this endpoint with the answer in the request body.
+
+```
+POST /events/:id/vote
+```
+
+Request Body
+
+```
+{
+  answer: "a" | "b"
+}
+```

docs/s4-api-docs.md

@@ -48,8 +48,8 @@ <h1>Jury Tool</h1>
       const events = [
         'aeg-beneficiary-concert',
         'pop-concert',
-        'AEC-OC',
-        'AEC-CC',
+        'aec-oc',
+        'aec-cc',
       ];
 
       // Create html elements for each event

jury/index.html

@@ -3,18 +3,18 @@ export const actions = ['flashlight', 'vote'];
 export const events = [
   {
     name: 'aeg-beneficiary-concert',
-    availableActions: ['flashlight'],
+    availableActions: ['flashlight', 'vote'],
   },
   {
     name: 'pop-concert',
-    availableActions: ['flashlight'],
+    availableActions: ['flashlight', 'vote'],
   },
   {
-    name: 'AEC-OC',
+    name: 'aec-oc',
     availableActions: ['flashlight', 'vote'],
   },
   {
-    name: 'AEC-CC',
+    name: 'aec-cc',
     availableActions: ['flashlight', 'vote'],
   },
 ];