Skip to content

Commit b364542

Browse files
janepiejanepie
committed
fix: regenerate openapi.json
Signed-off-by: Jana Peper <[email protected]>
1 parent b02966a commit b364542

File tree

4 files changed

+113
-21
lines changed

4 files changed

+113
-21
lines changed

‎apps/webhook_listeners/lib/Controller/WebhooksController.php‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -112,11 +112,11 @@ public function show(int $id): DataResponse {
112112
* @param ?array<string,string> $headers Array of headers to send
113113
* @param "none"|"header"|null $authMethod Authentication method to use
114114
* @param ?array<string,mixed> $authData Array of data for authentication
115-
* @param ?array{user_ids?:array<string,string>,user_roles?:array<string,string>} $tokenNeeded
116-
* List of user ids for which to include auth tokens in the event.
117-
* Has two fields: "user_ids" list of user uids for which tokens are needed, "user_roles" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included.
118-
* Possible roles: "owner" for the user creating the webhook, "trigger" for the user triggering the webhook call.
119-
* Requested auth tokens are valid for 1 hour after receiving them in the event call request.
115+
* @param ?array{user_ids?:list<string>,user_roles?:list<string>} $tokenNeeded
116+
* List of user ids for which to include auth tokens in the event.
117+
* Has two fields: "user_ids" list of user uids for which tokens are needed, "user_roles" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included.
118+
* Possible roles: "owner" for the user creating the webhook, "trigger" for the user triggering the webhook call.
119+
* Requested auth tokens are valid for 1 hour after receiving them in the event call request.
120120
*
121121
* @return DataResponse<Http::STATUS_OK, WebhookListenersWebhookInfo, array{}>
122122
*
@@ -187,11 +187,11 @@ public function create(
187187
* @param ?array<string,string> $headers Array of headers to send
188188
* @param "none"|"header"|null $authMethod Authentication method to use
189189
* @param ?array<string,mixed> $authData Array of data for authentication
190-
* @param ?array{user_ids?:array<string,string>,user_roles?:array<string,string>} $tokenNeeded
191-
* List of user ids for which to include auth tokens in the event.
192-
* Has two fields: "user_ids" list of user uids for which tokens are needed, "user_roles" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included.
193-
* Possible roles: "owner" for the user creating the webhook, "trigger" for the user triggering the webhook call.
194-
* Requested auth tokens are valid for 1 hour after receiving them in the event call request.
190+
* @param ?array{user_ids?:list<string>,user_roles?:list<string>} $tokenNeeded
191+
* List of user ids for which to include auth tokens in the event.
192+
* Has two fields: "user_ids" list of user uids for which tokens are needed, "user_roles" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included.
193+
* Possible roles: "owner" for the user creating the webhook, "trigger" for the user triggering the webhook call.
194+
* Requested auth tokens are valid for 1 hour after receiving them in the event call request.
195195
*
196196
* @return DataResponse<Http::STATUS_OK, WebhookListenersWebhookInfo, array{}>
197197
*

‎apps/webhook_listeners/lib/Db/EphemeralTokenMapper.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public function __construct(
3939
/**
4040
* @throws DoesNotExistException
4141
* @throws MultipleObjectsReturnedException
42-
* @throws \Exception
42+
* @throws Exception
4343
*/
4444
public function getById(int $id): EphemeralToken {
4545
$qb = $this->db->getQueryBuilder();
@@ -75,7 +75,7 @@ public function getOlderThan($olderThan): array {
7575
}
7676

7777
/**
78-
* @throws \Exception
78+
* @throws Exception
7979
*/
8080
public function addEphemeralToken(
8181
int $tokenId,
@@ -93,7 +93,7 @@ public function addEphemeralToken(
9393
}
9494

9595
/**
96-
* @throws \Exception
96+
* @throws Exception
9797
*/
9898
public function deleteByTokenId(int $tokenId): bool {
9999
$qb = $this->db->getQueryBuilder();

‎apps/webhook_listeners/openapi.json‎

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,20 @@
9595
},
9696
"tokenNeeded": {
9797
"type": "object",
98-
"additionalProperties": {
99-
"type": "object"
98+
"nullable": true,
99+
"properties": {
100+
"user_ids": {
101+
"type": "object",
102+
"additionalProperties": {
103+
"type": "string"
104+
}
105+
},
106+
"user_roles": {
107+
"type": "object",
108+
"additionalProperties": {
109+
"type": "string"
110+
}
111+
}
100112
}
101113
}
102114
}
@@ -315,9 +327,20 @@
315327
"type": "object",
316328
"nullable": true,
317329
"default": null,
318-
"description": "List of user ids for which to include auth tokens in the event. Has two fields: \"users\" list of user uids for which tokens are needed, \"functions\" list of functions for which tokens can be included. Possible functions: \"owner\" for the user creating the webhook, \"trigger\" for the user triggering the webhook call",
319-
"additionalProperties": {
320-
"type": "object"
330+
"description": "List of user ids for which to include auth tokens in the event. Has two fields: \"user_ids\" list of user uids for which tokens are needed, \"user_roles\" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included. Possible roles: \"owner\" for the user creating the webhook, \"trigger\" for the user triggering the webhook call. Requested auth tokens are valid for 1 hour after receiving them in the event call request.",
331+
"properties": {
332+
"user_ids": {
333+
"type": "array",
334+
"items": {
335+
"type": "string"
336+
}
337+
},
338+
"user_roles": {
339+
"type": "array",
340+
"items": {
341+
"type": "string"
342+
}
343+
}
321344
}
322345
}
323346
}
@@ -723,9 +746,20 @@
723746
"type": "object",
724747
"nullable": true,
725748
"default": null,
726-
"description": "List of user ids for which to include auth tokens in the event. Has two fields: \"users\" list of user uids for which tokens are needed, \"functions\" list of functions for which tokens can be included. Possible functions: \"owner\" for the user creating the webhook, \"trigger\" for the user triggering the webhook call",
727-
"additionalProperties": {
728-
"type": "object"
749+
"description": "List of user ids for which to include auth tokens in the event. Has two fields: \"user_ids\" list of user uids for which tokens are needed, \"user_roles\" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included. Possible roles: \"owner\" for the user creating the webhook, \"trigger\" for the user triggering the webhook call. Requested auth tokens are valid for 1 hour after receiving them in the event call request.",
750+
"properties": {
751+
"user_ids": {
752+
"type": "array",
753+
"items": {
754+
"type": "string"
755+
}
756+
},
757+
"user_roles": {
758+
"type": "array",
759+
"items": {
760+
"type": "string"
761+
}
762+
}
729763
}
730764
}
731765
}

‎openapi.json‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4687,6 +4687,24 @@
46874687
"additionalProperties": {
46884688
"type": "object"
46894689
}
4690+
},
4691+
"tokenNeeded": {
4692+
"type": "object",
4693+
"nullable": true,
4694+
"properties": {
4695+
"user_ids": {
4696+
"type": "object",
4697+
"additionalProperties": {
4698+
"type": "string"
4699+
}
4700+
},
4701+
"user_roles": {
4702+
"type": "object",
4703+
"additionalProperties": {
4704+
"type": "string"
4705+
}
4706+
}
4707+
}
46904708
}
46914709
}
46924710
}
@@ -38254,6 +38272,26 @@
3825438272
"additionalProperties": {
3825538273
"type": "object"
3825638274
}
38275+
},
38276+
"tokenNeeded": {
38277+
"type": "object",
38278+
"nullable": true,
38279+
"default": null,
38280+
"description": "List of user ids for which to include auth tokens in the event. Has two fields: \"user_ids\" list of user uids for which tokens are needed, \"user_roles\" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included. Possible roles: \"owner\" for the user creating the webhook, \"trigger\" for the user triggering the webhook call. Requested auth tokens are valid for 1 hour after receiving them in the event call request.",
38281+
"properties": {
38282+
"user_ids": {
38283+
"type": "array",
38284+
"items": {
38285+
"type": "string"
38286+
}
38287+
},
38288+
"user_roles": {
38289+
"type": "array",
38290+
"items": {
38291+
"type": "string"
38292+
}
38293+
}
38294+
}
3825738295
}
3825838296
}
3825938297
}
@@ -38653,6 +38691,26 @@
3865338691
"additionalProperties": {
3865438692
"type": "object"
3865538693
}
38694+
},
38695+
"tokenNeeded": {
38696+
"type": "object",
38697+
"nullable": true,
38698+
"default": null,
38699+
"description": "List of user ids for which to include auth tokens in the event. Has two fields: \"user_ids\" list of user uids for which tokens are needed, \"user_roles\" list of roles (users not defined by their ID but by the role they have in the webhook event) for which tokens can be included. Possible roles: \"owner\" for the user creating the webhook, \"trigger\" for the user triggering the webhook call. Requested auth tokens are valid for 1 hour after receiving them in the event call request.",
38700+
"properties": {
38701+
"user_ids": {
38702+
"type": "array",
38703+
"items": {
38704+
"type": "string"
38705+
}
38706+
},
38707+
"user_roles": {
38708+
"type": "array",
38709+
"items": {
38710+
"type": "string"
38711+
}
38712+
}
38713+
}
3865638714
}
3865738715
}
3865838716
}

0 commit comments

Comments
 (0)