Browse Source

update api.json to reflect shucks plugin

CauseFX 3 years ago
parent
commit
263f1aee89
1 changed files with 56 additions and 0 deletions
  1. 56 0
      docs/api.json

+ 56 - 0
docs/api.json

@@ -504,6 +504,62 @@
                 ]
             }
         },
+        "/api/v2/plugins/shuck-stop/settings": {
+            "get": {
+                "tags": [
+                    "plugins-shuck-stop"
+                ],
+                "summary": "Get settings",
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/pluginSettingsPage"
+                                }
+                            }
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    }
+                },
+                "security": [
+                    {
+                        "api_key": []
+                    }
+                ]
+            }
+        },
+        "/api/v2/plugins/shuck-stop/run": {
+            "get": {
+                "tags": [
+                    "plugins-shuck-stop"
+                ],
+                "summary": "Run ShuckStop plugin",
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/shuckStopRun"
+                                }
+                            }
+                        }
+                    },
+                    "401": {
+                        "description": "Unauthorized"
+                    }
+                },
+                "security": [
+                    {
+                        "api_key": []
+                    }
+                ]
+            }
+        },
         "/api/v2/plugins/speedtest/settings": {
             "get": {
                 "tags": [