fix: Fix TODOs about authentication data, list possible auth methods

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>
This commit is contained in:
Côme Chilliet 2024-06-04 14:21:10 +02:00 committed by Côme Chilliet
parent 85e0407aad
commit 8aae03c66c
3 changed files with 18 additions and 14 deletions

View file

@ -76,9 +76,9 @@ class WebhooksController extends OCSController {
* @param string $httpMethod HTTP method to use to contact the webhook
* @param string $uri Webhook URI endpoint
* @param string $event Event class name to listen to
* @param ?array<mixed> $eventFilter Mongo filter to apply to the serialized data to decide if firing
* @param ?array<string,mixed> $eventFilter Mongo filter to apply to the serialized data to decide if firing
* @param ?array<string,string> $headers Array of headers to send
* @param ?string $authMethod Authentication method to use. TODO
* @param "none"|"headers"|null $authMethod Authentication method to use
* @param ?array<string,mixed> $authData Array of data for authentication
*
* @return DataResponse<Http::STATUS_OK, WebhooksListenerInfo, array{}>
@ -136,7 +136,7 @@ class WebhooksController extends OCSController {
* @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 ?array<string,string> $headers Array of headers to send
* @param ?string $authMethod Authentication method to use. TODO
* @param "none"|"headers"|null $authMethod Authentication method to use
* @param ?array<string,mixed> $authData Array of data for authentication
*
* @return DataResponse<Http::STATUS_OK, WebhooksListenerInfo, array{}>

View file

@ -56,7 +56,6 @@ class Version1000Date20240527153425 extends SimpleMigrationStep {
$table->addColumn('headers', Types::TEXT, [
'notnull' => false,
]);
// TODO decide if string or int with an Enum
$table->addColumn('auth_method', Types::STRING, [
'notnull' => true,
'length' => 16,

View file

@ -203,15 +203,12 @@
}
},
{
"name": "eventFilter[]",
"name": "eventFilter",
"in": "query",
"description": "Mongo filter to apply to the serialized data to decide if firing",
"schema": {
"type": "array",
"nullable": true,
"items": {
"type": "object"
}
"type": "string",
"nullable": true
}
},
{
@ -226,10 +223,14 @@
{
"name": "authMethod",
"in": "query",
"description": "Authentication method to use. TODO",
"description": "Authentication method to use",
"schema": {
"type": "string",
"nullable": true
"nullable": true,
"enum": [
"none",
"headers"
]
}
},
{
@ -477,10 +478,14 @@
{
"name": "authMethod",
"in": "query",
"description": "Authentication method to use. TODO",
"description": "Authentication method to use",
"schema": {
"type": "string",
"nullable": true
"nullable": true,
"enum": [
"none",
"headers"
]
}
},
{