fix(webhooks): Completed API documentation and updated openapi.json

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
pull/46076/head
Côme Chilliet 5 months ago
parent 8abf62715c
commit b6aef4d235
No known key found for this signature in database
GPG Key ID: A3E2F658B28C760A
  1. 2
      apps/webhook_listeners/lib/Controller/WebhooksController.php
  2. 13
      apps/webhook_listeners/openapi.json

@ -107,6 +107,7 @@ class WebhooksController extends OCSController {
* @param string $uri Webhook URI endpoint
* @param string $event Event class name to listen to
* @param ?array<string,mixed> $eventFilter Mongo filter to apply to the serialized data to decide if firing
* @param ?string $userIdFilter User id to filter on. The webhook will only be called by requests from this user. Empty or null means no filtering.
* @param ?array<string,string> $headers Array of headers to send
* @param "none"|"headers"|null $authMethod Authentication method to use
* @param ?array<string,mixed> $authData Array of data for authentication
@ -175,6 +176,7 @@ class WebhooksController extends OCSController {
* @param string $uri Webhook URI endpoint
* @param string $event Event class name to listen to
* @param ?array<string,mixed> $eventFilter Mongo filter to apply to the serialized data to decide if firing
* @param ?string $userIdFilter User id to filter on. The webhook will only be called by requests from this user. Empty or null means no filtering.
* @param ?array<string,string> $headers Array of headers to send
* @param "none"|"headers"|null $authMethod Authentication method to use
* @param ?array<string,mixed> $authData Array of data for authentication

@ -75,6 +75,9 @@
"type": "object"
}
},
"userIdFilter": {
"type": "string"
},
"headers": {
"type": "object",
"additionalProperties": {
@ -223,6 +226,11 @@
"type": "object"
}
},
"userIdFilter": {
"type": "string",
"nullable": true,
"description": "User id to filter on. The webhook will only be called by requests from this user. Empty or null means no filtering."
},
"headers": {
"type": "object",
"nullable": true,
@ -501,6 +509,11 @@
"type": "object"
}
},
"userIdFilter": {
"type": "string",
"nullable": true,
"description": "User id to filter on. The webhook will only be called by requests from this user. Empty or null means no filtering."
},
"headers": {
"type": "object",
"nullable": true,

Loading…
Cancel
Save