feat: documenting endpoint to delete speakers and companies #298

sinfo · Nov 19, 2022 · 25becbf · 25becbf
1 parent 85c7eba
commit 25becbf
Show file tree

Hide file tree

Showing 4 changed files with 115 additions and 1 deletion.
diff --git a/backend/static/swagger.json b/backend/static/swagger.json
diff --git a/backend/swagger/companies-id-participation-thread-threadID.json b/backend/swagger/companies-id-participation-thread-threadID.json
@@ -0,0 +1,54 @@
+{
+    "delete": {
+        "tags": [
+            "companies",
+            "threads"
+        ],
+        "summary": "Deletes thread from a company participation",
+        "operationId": "deleteCompanyThread",
+        "consumes": [
+            "application/json"
+        ],
+        "produces": [
+            "application/json"
+        ],
+        "security": [
+            {
+                "Bearer": []
+            }
+        ],
+        "parameters": [
+            {
+                "in": "path",
+                "name": "id",
+                "description": "ID of the company",
+                "required": true,
+                "type": "string"
+            },
+            {
+                "in": "path",
+                "name": "threadID",
+                "description": "ID of the thread",
+                "required": true,
+                "type": "string"
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Updated company",
+                "schema": {
+                    "$ref": "./models/company.json"
+                }
+            },
+            "400": {
+                "description": "Invalid payload, or invalid credentials"
+            },
+            "404": {
+                "description": "Meeting not found"
+            },
+            "401": {
+                "description": "Unauthorized"
+            }
+        }
+    }
+}
diff --git a/backend/swagger/speakers-id-participation-thread-threadID.json b/backend/swagger/speakers-id-participation-thread-threadID.json
@@ -0,0 +1,54 @@
+{
+    "delete": {
+        "tags": [
+            "speakers",
+            "threads"
+        ],
+        "summary": "Deletes thread from a speaker participation",
+        "operationId": "deleteSpeakerThread",
+        "consumes": [
+            "application/json"
+        ],
+        "produces": [
+            "application/json"
+        ],
+        "security": [
+            {
+                "Bearer": []
+            }
+        ],
+        "parameters": [
+            {
+                "in": "path",
+                "name": "id",
+                "description": "ID of the speaker",
+                "required": true,
+                "type": "string"
+            },
+            {
+                "in": "path",
+                "name": "threadID",
+                "description": "ID of the thread",
+                "required": true,
+                "type": "string"
+            }
+        ],
+        "responses": {
+            "200": {
+                "description": "Updated speaker",
+                "schema": {
+                    "$ref": "./models/speaker.json"
+                }
+            },
+            "400": {
+                "description": "Invalid payload, or invalid credentials"
+            },
+            "404": {
+                "description": "Meeting not found"
+            },
+            "401": {
+                "description": "Unauthorized"
+            }
+        }
+    }
+}
diff --git a/backend/swagger/swagger.json b/backend/swagger/swagger.json
@@ -371,6 +371,12 @@
     },
     "/meetings/{id}/participants": {
       "$ref": "./meetings-id-participants.json"
+    },
+    "/companies/{id}/participation/thread/{threadID}": {
+      "$ref": "./companies-id-participation-thread-threadID.json"
+    },
+    "/speakers/{id}/participation/thread/{threadID}": {
+      "$ref": "./speakers-id-participation-thread-threadID.json"
     }
   },
   "externalDocs": {