add APIspec

ausgerechnet · Nov 14, 2024 · 4ec5eb4 · 4ec5eb4
1 parent 0b6919b
commit 4ec5eb4
Showing 1 changed file with 83 additions and 2 deletions.
diff --git a/openapi.json b/openapi.json
@@ -1988,7 +1988,7 @@
     },
     "description": "cwb-cads: CWB-based API for Corpus-Assisted Discourse Studies",
     "title": "cwb-cads",
-    "version": "0.3.0.dev13"
+    "version": "0.3.0.dev14"
   },
   "openapi": "3.0.2",
   "paths": {
@@ -4106,6 +4106,7 @@
         ]
       },
       "post": {
+        "description": "Create collocation analysis of constellation description.",
         "parameters": [
           {
             "in": "path",
@@ -4180,7 +4181,87 @@
             "BearerAuth": []
           }
         ],
-        "summary": "Create collocation analysis of constellation description.",
+        "summary": "DEPRECATED. USE PUT INSTEAD.",
+        "tags": [
+          "Mmda.Constellation"
+        ]
+      },
+      "put": {
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "path",
+            "name": "description_id",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ConstellationCollocationIn"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ConstellationCollocationOut"
+                }
+              }
+            },
+            "description": "Successful response"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPError"
+                }
+              }
+            },
+            "description": "Authentication error"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPError"
+                }
+              }
+            },
+            "description": "Not found"
+          },
+          "422": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ValidationError"
+                }
+              }
+            },
+            "description": "Validation error"
+          }
+        },
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "summary": "Get collocation analysis of constellation description; create if necessary.",
         "tags": [
           "Mmda.Constellation"
         ]