mirror of
https://github.com/nextcloud/server.git
synced 2026-06-09 08:44:07 -04:00
fix(webhooks): Completed API documentation and updated openapi.json
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
This commit is contained in:
parent
8abf62715c
commit
b6aef4d235
2 changed files with 15 additions and 0 deletions
|
|
@ -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…
Reference in a new issue