aboutsummaryrefslogtreecommitdiffstats
path: root/apps/webhook_listeners/openapi.json
diff options
context:
space:
mode:
authorCôme Chilliet <come.chilliet@nextcloud.com>2024-09-09 14:50:52 +0200
committerCôme Chilliet <come.chilliet@nextcloud.com>2024-09-09 14:50:52 +0200
commit22a2893addb857b7007d0d9322aeca1bbd87b16a (patch)
tree35b9f3073b1bcef5bfc29157756a8271808afc82 /apps/webhook_listeners/openapi.json
parent4459af41c92748bceb7d7c6ef5f55a568a7fff01 (diff)
downloadnextcloud-server-22a2893addb857b7007d0d9322aeca1bbd87b16a.tar.gz
nextcloud-server-22a2893addb857b7007d0d9322aeca1bbd87b16a.zip
chore(webhook_listeners): Update openapi.json
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
Diffstat (limited to 'apps/webhook_listeners/openapi.json')
-rw-r--r--apps/webhook_listeners/openapi.json130
1 files changed, 129 insertions, 1 deletions
diff --git a/apps/webhook_listeners/openapi.json b/apps/webhook_listeners/openapi.json
index 7b6fdd6241f..fcd26efdf6d 100644
--- a/apps/webhook_listeners/openapi.json
+++ b/apps/webhook_listeners/openapi.json
@@ -686,7 +686,7 @@
],
"responses": {
"200": {
- "description": "Boolean returned whether something was deleted FIXME",
+ "description": "Boolean returned whether something was deleted",
"content": {
"application/json": {
"schema": {
@@ -773,6 +773,134 @@
}
}
}
+ },
+ "/ocs/v2.php/apps/webhook_listeners/api/v1/webhooks/byappid/{appid}": {
+ "delete": {
+ "operationId": "webhooks-delete-by-app-id",
+ "summary": "Remove all existing webhook registration mapped to an AppAPI app id",
+ "description": "This endpoint requires admin access",
+ "tags": [
+ "webhooks"
+ ],
+ "security": [
+ {
+ "bearer_auth": []
+ },
+ {
+ "basic_auth": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "appid",
+ "in": "path",
+ "description": "id of the app, as in the EX-APP-ID for creation",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "OCS-APIRequest",
+ "in": "header",
+ "description": "Required to be true for the API request to pass",
+ "required": true,
+ "schema": {
+ "type": "boolean",
+ "default": true
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Integer number of registrations deleted",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "ocs"
+ ],
+ "properties": {
+ "ocs": {
+ "type": "object",
+ "required": [
+ "meta",
+ "data"
+ ],
+ "properties": {
+ "meta": {
+ "$ref": "#/components/schemas/OCSMeta"
+ },
+ "data": {
+ "type": "integer",
+ "format": "int64"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "ocs"
+ ],
+ "properties": {
+ "ocs": {
+ "type": "object",
+ "required": [
+ "meta",
+ "data"
+ ],
+ "properties": {
+ "meta": {
+ "$ref": "#/components/schemas/OCSMeta"
+ },
+ "data": {}
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Insufficient permissions",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "required": [
+ "ocs"
+ ],
+ "properties": {
+ "ocs": {
+ "type": "object",
+ "required": [
+ "meta",
+ "data"
+ ],
+ "properties": {
+ "meta": {
+ "$ref": "#/components/schemas/OCSMeta"
+ },
+ "data": {}
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
}
},
"tags": []