docs(serverless): document trigger API (#3443)

scaleway-bot · remyleone · web-flow · commit c27b80c3e718 · 2023-10-23T15:17:47.000Z
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-container-trigger-create-usage.golden b/cmd/scw/testdata/test-all-usage-container-trigger-create-usage.golden
@@ -6,21 +6,17 @@ USAGE:
   scw container trigger create [arg=value ...]
 
 ARGS:
-  [name]                                  
-  [description]                           
-  [container-id]                          
-  [scw-sqs-config.queue]                  
-  [scw-sqs-config.mnq-project-id]         
-  [scw-sqs-config.mnq-region]             
-  [sqs-config.endpoint]                   
-  [sqs-config.queue-url]                  
-  [sqs-config.access-key]                 
-  [sqs-config.secret-key]                 
-  [scw-nats-config.subject]               
-  [scw-nats-config.mnq-project-id]        
-  [scw-nats-config.mnq-region]            
-  [scw-nats-config.mnq-nats-account-id]   
-  [region=fr-par]                         Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  name                                  Name of the trigger
+  container-id                          ID of the container to trigger
+  [description]                         Description of the trigger
+  scw-sqs-config.queue                  Name of the SQS queue the trigger should listen to
+  scw-sqs-config.mnq-project-id         ID of the M&Q project
+  scw-sqs-config.mnq-region             Region in which the M&Q project is activated
+  scw-nats-config.subject               Name of the NATS subject the trigger should listen to
+  scw-nats-config.mnq-nats-account-id   ID of the M&Q NATS account
+  [scw-nats-config.mnq-project-id]      ID of the M&Q project
+  scw-nats-config.mnq-region            Region of the M&Q project
+  [region=fr-par]                       Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 DEPRECATED ARGS:
   [scw-sqs-config.mnq-namespace-id]    
diff --git a/cmd/scw/testdata/test-all-usage-container-trigger-delete-usage.golden b/cmd/scw/testdata/test-all-usage-container-trigger-delete-usage.golden
@@ -3,10 +3,10 @@
 Delete a trigger with a specified ID.
 
 USAGE:
-  scw container trigger delete [arg=value ...]
+  scw container trigger delete <trigger-id ...> [arg=value ...]
 
 ARGS:
-  trigger-id        
+  trigger-id        ID of the trigger to delete
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-trigger-get-usage.golden b/cmd/scw/testdata/test-all-usage-container-trigger-get-usage.golden
@@ -3,10 +3,10 @@
 Get a trigger with a specified ID.
 
 USAGE:
-  scw container trigger get [arg=value ...]
+  scw container trigger get <trigger-id ...> [arg=value ...]
 
 ARGS:
-  trigger-id        
+  trigger-id        ID of the trigger to get
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-container-trigger-list-usage.golden b/cmd/scw/testdata/test-all-usage-container-trigger-list-usage.golden
@@ -6,9 +6,9 @@ USAGE:
   scw container trigger list [arg=value ...]
 
 ARGS:
-  [order-by]         (created_at_asc | created_at_desc)
-  [container-id]    
-  [namespace-id]    
+  [order-by]        Order in which to return results (created_at_asc | created_at_desc)
+  [container-id]    ID of the container the triggers belongs to
+  [namespace-id]    ID of the namespace the triggers belongs to
   [project-id]      Project ID to use. If none is passed the default project ID will be used
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
diff --git a/cmd/scw/testdata/test-all-usage-container-trigger-update-usage.golden b/cmd/scw/testdata/test-all-usage-container-trigger-update-usage.golden
@@ -3,15 +3,13 @@
 Update a trigger with a specified ID.
 
 USAGE:
-  scw container trigger update [arg=value ...]
+  scw container trigger update <trigger-id ...> [arg=value ...]
 
 ARGS:
-  trigger-id                
-  [name]                    
-  [description]             
-  [sqs-config.access-key]   
-  [sqs-config.secret-key]   
-  [region=fr-par]           Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  trigger-id        ID of the trigger to update
+  [name]            Name of the trigger
+  [description]     Description of the trigger
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
   -h, --help   help for update
diff --git a/cmd/scw/testdata/test-all-usage-function-trigger-create-usage.golden b/cmd/scw/testdata/test-all-usage-function-trigger-create-usage.golden
@@ -6,21 +6,17 @@ USAGE:
   scw function trigger create [arg=value ...]
 
 ARGS:
-  [name]                                  
-  [description]                           
-  [function-id]                           
-  [scw-sqs-config.queue]                  
-  [scw-sqs-config.mnq-project-id]         
-  [scw-sqs-config.mnq-region]             
-  [sqs-config.endpoint]                   
-  [sqs-config.queue-url]                  
-  [sqs-config.access-key]                 
-  [sqs-config.secret-key]                 
-  [scw-nats-config.subject]               
-  [scw-nats-config.mnq-project-id]        
-  [scw-nats-config.mnq-region]            
-  [scw-nats-config.mnq-nats-account-id]   
-  [region=fr-par]                         Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  name                                  Name of the trigger
+  function-id                           ID of the function to trigger
+  [description]                         Description of the trigger
+  scw-sqs-config.queue                  Name of the SQS queue the trigger should listen to
+  scw-sqs-config.mnq-project-id         ID of the M&Q project
+  scw-sqs-config.mnq-region             Region in which the M&Q project is activated
+  scw-nats-config.subject               Name of the NATS subject the trigger should listen to
+  scw-nats-config.mnq-nats-account-id   ID of the M&Q NATS account
+  [scw-nats-config.mnq-project-id]      ID of the M&Q project
+  scw-nats-config.mnq-region            Region of the M&Q project
+  [region=fr-par]                       Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 DEPRECATED ARGS:
   [scw-sqs-config.mnq-namespace-id]    
diff --git a/cmd/scw/testdata/test-all-usage-function-trigger-delete-usage.golden b/cmd/scw/testdata/test-all-usage-function-trigger-delete-usage.golden
@@ -3,10 +3,10 @@
 Delete function resources.
 
 USAGE:
-  scw function trigger delete [arg=value ...]
+  scw function trigger delete <trigger-id ...> [arg=value ...]
 
 ARGS:
-  trigger-id        
+  trigger-id        ID of the trigger to delete
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-function-trigger-get-usage.golden b/cmd/scw/testdata/test-all-usage-function-trigger-get-usage.golden
@@ -3,10 +3,10 @@
 Get function resources.
 
 USAGE:
-  scw function trigger get [arg=value ...]
+  scw function trigger get <trigger-id ...> [arg=value ...]
 
 ARGS:
-  trigger-id        
+  trigger-id        ID of the trigger to get
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
diff --git a/cmd/scw/testdata/test-all-usage-function-trigger-list-usage.golden b/cmd/scw/testdata/test-all-usage-function-trigger-list-usage.golden
@@ -6,9 +6,9 @@ USAGE:
   scw function trigger list [arg=value ...]
 
 ARGS:
-  [order-by]         (created_at_asc | created_at_desc)
-  [function-id]     
-  [namespace-id]    
+  [order-by]        Order in which to return results (created_at_asc | created_at_desc)
+  [function-id]     ID of the function the triggers belongs to
+  [namespace-id]    ID of the namespace the triggers belongs to
   [project-id]      Project ID to use. If none is passed the default project ID will be used
   [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw | all)
 
diff --git a/cmd/scw/testdata/test-all-usage-function-trigger-update-usage.golden b/cmd/scw/testdata/test-all-usage-function-trigger-update-usage.golden
@@ -3,15 +3,13 @@
 Update function resources.
 
 USAGE:
-  scw function trigger update [arg=value ...]
+  scw function trigger update <trigger-id ...> [arg=value ...]
 
 ARGS:
-  trigger-id                
-  [name]                    
-  [description]             
-  [sqs-config.access-key]   
-  [sqs-config.secret-key]   
-  [region=fr-par]           Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
+  trigger-id        ID of the trigger to update
+  [name]            Name of the trigger
+  [description]     Description of the trigger
+  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
 
 FLAGS:
   -h, --help   help for update
diff --git a/docs/commands/container.md b/docs/commands/container.md
@@ -683,22 +683,18 @@ scw container trigger create [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| name |  |  |
-| description |  |  |
-| container-id |  |  |
+| name | Required | Name of the trigger |
+| container-id | Required | ID of the container to trigger |
+| description |  | Description of the trigger |
 | ~~scw-sqs-config.mnq-namespace-id~~ | Deprecated |  |
-| scw-sqs-config.queue |  |  |
-| scw-sqs-config.mnq-project-id |  |  |
-| scw-sqs-config.mnq-region |  |  |
-| sqs-config.endpoint |  |  |
-| sqs-config.queue-url |  |  |
-| sqs-config.access-key |  |  |
-| sqs-config.secret-key |  |  |
+| scw-sqs-config.queue | Required | Name of the SQS queue the trigger should listen to |
+| scw-sqs-config.mnq-project-id | Required | ID of the M&Q project |
+| scw-sqs-config.mnq-region | Required | Region in which the M&Q project is activated |
 | ~~scw-nats-config.mnq-namespace-id~~ | Deprecated |  |
-| scw-nats-config.subject |  |  |
-| scw-nats-config.mnq-project-id |  |  |
-| scw-nats-config.mnq-region |  |  |
-| scw-nats-config.mnq-nats-account-id |  |  |
+| scw-nats-config.subject | Required | Name of the NATS subject the trigger should listen to |
+| scw-nats-config.mnq-nats-account-id | Required | ID of the M&Q NATS account |
+| scw-nats-config.mnq-project-id |  | ID of the M&Q project |
+| scw-nats-config.mnq-region | Required | Region of the M&Q project |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -710,15 +706,15 @@ Delete a trigger with a specified ID.
 **Usage:**
 
 ```
-scw container trigger delete [arg=value ...]
+scw container trigger delete <trigger-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| trigger-id | Required |  |
+| trigger-id | Required | ID of the trigger to delete |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -730,15 +726,15 @@ Get a trigger with a specified ID.
 **Usage:**
 
 ```
-scw container trigger get [arg=value ...]
+scw container trigger get <trigger-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| trigger-id | Required |  |
+| trigger-id | Required | ID of the trigger to get |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -758,9 +754,9 @@ scw container trigger list [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| order-by | One of: `created_at_asc`, `created_at_desc` |  |
-| container-id |  |  |
-| namespace-id |  |  |
+| order-by | One of: `created_at_asc`, `created_at_desc` | Order in which to return results |
+| container-id |  | ID of the container the triggers belongs to |
+| namespace-id |  | ID of the namespace the triggers belongs to |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
 
@@ -773,19 +769,17 @@ Update a trigger with a specified ID.
 **Usage:**
 
 ```
-scw container trigger update [arg=value ...]
+scw container trigger update <trigger-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| trigger-id | Required |  |
-| name |  |  |
-| description |  |  |
-| sqs-config.access-key |  |  |
-| sqs-config.secret-key |  |  |
+| trigger-id | Required | ID of the trigger to update |
+| name |  | Name of the trigger |
+| description |  | Description of the trigger |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
diff --git a/docs/commands/function.md b/docs/commands/function.md
@@ -740,22 +740,18 @@ scw function trigger create [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| name |  |  |
-| description |  |  |
-| function-id |  |  |
+| name | Required | Name of the trigger |
+| function-id | Required | ID of the function to trigger |
+| description |  | Description of the trigger |
 | ~~scw-sqs-config.mnq-namespace-id~~ | Deprecated |  |
-| scw-sqs-config.queue |  |  |
-| scw-sqs-config.mnq-project-id |  |  |
-| scw-sqs-config.mnq-region |  |  |
-| sqs-config.endpoint |  |  |
-| sqs-config.queue-url |  |  |
-| sqs-config.access-key |  |  |
-| sqs-config.secret-key |  |  |
+| scw-sqs-config.queue | Required | Name of the SQS queue the trigger should listen to |
+| scw-sqs-config.mnq-project-id | Required | ID of the M&Q project |
+| scw-sqs-config.mnq-region | Required | Region in which the M&Q project is activated |
 | ~~scw-nats-config.mnq-namespace-id~~ | Deprecated |  |
-| scw-nats-config.subject |  |  |
-| scw-nats-config.mnq-project-id |  |  |
-| scw-nats-config.mnq-region |  |  |
-| scw-nats-config.mnq-nats-account-id |  |  |
+| scw-nats-config.subject | Required | Name of the NATS subject the trigger should listen to |
+| scw-nats-config.mnq-nats-account-id | Required | ID of the M&Q NATS account |
+| scw-nats-config.mnq-project-id |  | ID of the M&Q project |
+| scw-nats-config.mnq-region | Required | Region of the M&Q project |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -767,15 +763,15 @@ Delete function resources.
 **Usage:**
 
 ```
-scw function trigger delete [arg=value ...]
+scw function trigger delete <trigger-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| trigger-id | Required |  |
+| trigger-id | Required | ID of the trigger to delete |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -787,15 +783,15 @@ Get function resources.
 **Usage:**
 
 ```
-scw function trigger get [arg=value ...]
+scw function trigger get <trigger-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| trigger-id | Required |  |
+| trigger-id | Required | ID of the trigger to get |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
@@ -815,9 +811,9 @@ scw function trigger list [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| order-by | One of: `created_at_asc`, `created_at_desc` |  |
-| function-id |  |  |
-| namespace-id |  |  |
+| order-by | One of: `created_at_asc`, `created_at_desc` | Order in which to return results |
+| function-id |  | ID of the function the triggers belongs to |
+| namespace-id |  | ID of the namespace the triggers belongs to |
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw`, `all` | Region to target. If none is passed will use default region from the config |
 
@@ -830,19 +826,17 @@ Update function resources.
 **Usage:**
 
 ```
-scw function trigger update [arg=value ...]
+scw function trigger update <trigger-id ...> [arg=value ...]
 ```
 
 
 **Args:**
 
 | Name |   | Description |
 |------|---|-------------|
-| trigger-id | Required |  |
-| name |  |  |
-| description |  |  |
-| sqs-config.access-key |  |  |
-| sqs-config.secret-key |  |  |
+| trigger-id | Required | ID of the trigger to update |
+| name |  | Name of the trigger |
+| description |  | Description of the trigger |
 | region | Default: `fr-par`<br />One of: `fr-par`, `nl-ams`, `pl-waw` | Region to target. If none is passed will use default region from the config |
 
 
diff --git a/go.mod b/go.mod
diff --git a/go.sum b/go.sum
diff --git a/internal/namespaces/container/v1beta1/container_cli.go b/internal/namespaces/container/v1beta1/container_cli.go
diff --git a/internal/namespaces/function/v1beta1/function_cli.go b/internal/namespaces/function/v1beta1/function_cli.go
