Skip to content

Commit e49ab98

Browse files
authored
docs(functions): add short and long descriptions to triggers methods (#960)
1 parent 7f57b6a commit e49ab98

File tree

2 files changed

+33
-2
lines changed

2 files changed

+33
-2
lines changed

packages/clients/src/api/function/v1beta1/api.gen.ts

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -884,6 +884,12 @@ export class API extends ParentAPI {
884884
unmarshalToken,
885885
)
886886

887+
/**
888+
* Create a trigger. Create a new trigger for a specified function.
889+
*
890+
* @param request - The request {@link CreateTriggerRequest}
891+
* @returns A Promise of Trigger
892+
*/
887893
createTrigger = (request: Readonly<CreateTriggerRequest>) =>
888894
this.client.fetch<Trigger>(
889895
{
@@ -900,6 +906,12 @@ export class API extends ParentAPI {
900906
unmarshalTrigger,
901907
)
902908

909+
/**
910+
* Get a trigger. Get a trigger with a specified ID.
911+
*
912+
* @param request - The request {@link GetTriggerRequest}
913+
* @returns A Promise of Trigger
914+
*/
903915
getTrigger = (request: Readonly<GetTriggerRequest>) =>
904916
this.client.fetch<Trigger>(
905917
{
@@ -971,9 +983,22 @@ export class API extends ParentAPI {
971983
unmarshalListTriggersResponse,
972984
)
973985

986+
/**
987+
* List all triggers. List all triggers belonging to a specified Organization
988+
* or Project.
989+
*
990+
* @param request - The request {@link ListTriggersRequest}
991+
* @returns A Promise of ListTriggersResponse
992+
*/
974993
listTriggers = (request: Readonly<ListTriggersRequest> = {}) =>
975994
enrichForPagination('triggers', this.pageOfListTriggers, request)
976995

996+
/**
997+
* Update a trigger. Update a trigger with a specified ID.
998+
*
999+
* @param request - The request {@link UpdateTriggerRequest}
1000+
* @returns A Promise of Trigger
1001+
*/
9771002
updateTrigger = (request: Readonly<UpdateTriggerRequest>) =>
9781003
this.client.fetch<Trigger>(
9791004
{
@@ -990,6 +1015,12 @@ export class API extends ParentAPI {
9901015
unmarshalTrigger,
9911016
)
9921017

1018+
/**
1019+
* Delete a trigger. Delete a trigger with a specified ID.
1020+
*
1021+
* @param request - The request {@link DeleteTriggerRequest}
1022+
* @returns A Promise of Trigger
1023+
*/
9931024
deleteTrigger = (request: Readonly<DeleteTriggerRequest>) =>
9941025
this.client.fetch<Trigger>(
9951026
{

packages/clients/src/api/function/v1beta1/types.gen.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,10 +465,10 @@ export interface TriggerMnqNatsClientConfig {
465465

466466
/** Trigger. mnq sqs client config. */
467467
export interface TriggerMnqSqsClientConfig {
468-
/** @deprecated */
469-
mnqNamespaceId?: string
470468
/** Name of the SQS queue the trigger listens to. */
471469
queue: string
470+
/** @deprecated */
471+
mnqNamespaceId?: string
472472
/** ID of the M&Q project. */
473473
mnqProjectId: string
474474
/** Region in which the M&Q project is activated. */

0 commit comments

Comments
 (0)