Skip to content

Commit

Permalink
fix(functions): add short and long descriptions to triggers methods (#…
Browse files Browse the repository at this point in the history
…3454)

Co-authored-by: Jules Castéran <[email protected]>
  • Loading branch information
scaleway-bot and Codelax committed Oct 26, 2023
1 parent 4b7e2a5 commit 6e61abe
Show file tree
Hide file tree
Showing 8 changed files with 35 additions and 35 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Create function resources.
Create a new trigger for a specified function.

USAGE:
scw function trigger create [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Delete function resources.
Delete a trigger with a specified ID.

USAGE:
scw function trigger delete <trigger-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Get function resources.
Get a trigger with a specified ID.

USAGE:
scw function trigger get <trigger-id ...> [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
List function resources.
List all triggers belonging to a specified Organization or Project.

USAGE:
scw function trigger list [arg=value ...]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
Update function resources.
Update a trigger with a specified ID.

USAGE:
scw function trigger update <trigger-id ...> [arg=value ...]
Expand Down
10 changes: 5 additions & 5 deletions cmd/scw/testdata/test-all-usage-function-trigger-usage.golden
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ USAGE:
scw function trigger <command>

AVAILABLE COMMANDS:
create Create function resources
delete Delete function resources
get Get function resources
list List function resources
update Update function resources
create Create a trigger
delete Delete a trigger
get Get a trigger
list List all triggers
update Update a trigger

FLAGS:
-h, --help help for trigger
Expand Down
30 changes: 15 additions & 15 deletions docs/commands/function.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ Function as a Service API.
- [Get a token](#get-a-token)
- [List all tokens](#list-all-tokens)
- [Trigger management commands](#trigger-management-commands)
- [Create function resources](#create-function-resources)
- [Delete function resources](#delete-function-resources)
- [Get function resources](#get-function-resources)
- [List function resources](#list-function-resources)
- [Update function resources](#update-function-resources)
- [Create a trigger](#create-a-trigger)
- [Delete a trigger](#delete-a-trigger)
- [Get a trigger](#get-a-trigger)
- [List all triggers](#list-all-triggers)
- [Update a trigger](#update-a-trigger)


## Cron management commands
Expand Down Expand Up @@ -725,9 +725,9 @@ scw function token list [arg=value ...]
Trigger management commands.


### Create function resources
### Create a trigger

Create function resources.
Create a new trigger for a specified function.

**Usage:**

Expand Down Expand Up @@ -756,9 +756,9 @@ scw function trigger create [arg=value ...]



### Delete function resources
### Delete a trigger

Delete function resources.
Delete a trigger with a specified ID.

**Usage:**

Expand All @@ -776,9 +776,9 @@ scw function trigger delete <trigger-id ...> [arg=value ...]



### Get function resources
### Get a trigger

Get function resources.
Get a trigger with a specified ID.

**Usage:**

Expand All @@ -796,9 +796,9 @@ scw function trigger get <trigger-id ...> [arg=value ...]



### List function resources
### List all triggers

List function resources.
List all triggers belonging to a specified Organization or Project.

**Usage:**

Expand All @@ -819,9 +819,9 @@ scw function trigger list [arg=value ...]



### Update function resources
### Update a trigger

Update function resources.
Update a trigger with a specified ID.

**Usage:**

Expand Down
20 changes: 10 additions & 10 deletions internal/namespaces/function/v1beta1/function_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -1481,8 +1481,8 @@ func functionTokenDelete() *core.Command {

func functionTriggerCreate() *core.Command {
return &core.Command{
Short: `Create function resources`,
Long: `Create function resources.`,
Short: `Create a trigger`,
Long: `Create a new trigger for a specified function.`,
Namespace: "function",
Resource: "trigger",
Verb: "create",
Expand Down Expand Up @@ -1586,8 +1586,8 @@ func functionTriggerCreate() *core.Command {

func functionTriggerGet() *core.Command {
return &core.Command{
Short: `Get function resources`,
Long: `Get function resources.`,
Short: `Get a trigger`,
Long: `Get a trigger with a specified ID.`,
Namespace: "function",
Resource: "trigger",
Verb: "get",
Expand Down Expand Up @@ -1616,8 +1616,8 @@ func functionTriggerGet() *core.Command {

func functionTriggerList() *core.Command {
return &core.Command{
Short: `List function resources`,
Long: `List function resources.`,
Short: `List all triggers`,
Long: `List all triggers belonging to a specified Organization or Project.`,
Namespace: "function",
Resource: "trigger",
Verb: "list",
Expand Down Expand Up @@ -1671,8 +1671,8 @@ func functionTriggerList() *core.Command {

func functionTriggerUpdate() *core.Command {
return &core.Command{
Short: `Update function resources`,
Long: `Update function resources.`,
Short: `Update a trigger`,
Long: `Update a trigger with a specified ID.`,
Namespace: "function",
Resource: "trigger",
Verb: "update",
Expand Down Expand Up @@ -1715,8 +1715,8 @@ func functionTriggerUpdate() *core.Command {

func functionTriggerDelete() *core.Command {
return &core.Command{
Short: `Delete function resources`,
Long: `Delete function resources.`,
Short: `Delete a trigger`,
Long: `Delete a trigger with a specified ID.`,
Namespace: "function",
Resource: "trigger",
Verb: "delete",
Expand Down

0 comments on commit 6e61abe

Please sign in to comment.