Skip to content

Commit 8c2f03f

Browse files
scaleway-botscaleway-bot
committed
feat: update generated APIs
1 parent 674bd50 commit 8c2f03f

13 files changed

+375
-12
lines changed

‎cmd/scw/testdata/test-all-usage-tem-offers-list-usage.golden‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Retrieve the list of the available and free-of-charge offers you can subscribe to.
4+
5+
USAGE:
6+
scw tem offers list [arg=value ...]
7+
8+
ARGS:
9+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
10+
11+
FLAGS:
12+
-h, --help help for list
13+
14+
GLOBAL FLAGS:
15+
-c, --config string The path to the config file
16+
-D, --debug Enable debug mode
17+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
18+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-tem-offers-update-usage.golden‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Update a subscribed offer.
4+
5+
USAGE:
6+
scw tem offers update [arg=value ...]
7+
8+
ARGS:
9+
[project-id] Project ID to use. If none is passed the default project ID will be used
10+
[name] Name of the offer-subscription (unknown_name | essential | scale)
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
12+
13+
FLAGS:
14+
-h, --help help for update
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-tem-offers-usage.golden‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
This section allows you to manage and get get subscribed information about your project email offer.
44

55
USAGE:
6-
scw tem offers
6+
scw tem offers <command>
7+
8+
AVAILABLE COMMANDS:
9+
list List the available offers.
10+
update Update a subscribed offer
711

812
FLAGS:
913
-h, --help help for offers
@@ -13,3 +17,5 @@ GLOBAL FLAGS:
1317
-D, --debug Enable debug mode
1418
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
1519
-p, --profile string The config profile to use
20+
21+
Use "scw tem offers [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-tem-project-consumption-get-usage.golden‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Get project resource consumption.
4+
5+
USAGE:
6+
scw tem project-consumption get [arg=value ...]
7+
8+
ARGS:
9+
[project-id] Project ID to use. If none is passed the default project ID will be used
10+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par)
11+
12+
FLAGS:
13+
-h, --help help for get
14+
15+
GLOBAL FLAGS:
16+
-c, --config string The path to the config file
17+
-D, --debug Enable debug mode
18+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
19+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-tem-project-consumption-usage.golden‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,10 @@
33
Project consumption allow you to see your project consumption.
44

55
USAGE:
6-
scw tem project-consumption
6+
scw tem project-consumption <command>
7+
8+
AVAILABLE COMMANDS:
9+
get Get project resource consumption.
710

811
FLAGS:
912
-h, --help help for project-consumption
@@ -13,3 +16,5 @@ GLOBAL FLAGS:
1316
-D, --debug Enable debug mode
1417
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
1518
-p, --profile string The config profile to use
19+
20+
Use "scw tem project-consumption [command] --help" for more information about a command.

‎cmd/scw/testdata/test-all-usage-vpc-rule-get-usage.golden‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Retrieve a list of ACL rules for a VPC, specified by its VPC ID.
4+
5+
USAGE:
6+
scw vpc rule get [arg=value ...]
7+
8+
ARGS:
9+
vpc-id ID of the Network ACL's VPC
10+
is-ipv6 Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each Network ACL can have rules for only one IP type.
11+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
12+
13+
FLAGS:
14+
-h, --help help for get
15+
16+
GLOBAL FLAGS:
17+
-c, --config string The path to the config file
18+
-D, --debug Enable debug mode
19+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
20+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-vpc-rule-set-usage.golden‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
2+
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3+
Set the list of ACL rules and the default routing policy for a VPC.
4+
5+
USAGE:
6+
scw vpc rule set [arg=value ...]
7+
8+
ARGS:
9+
vpc-id ID of the Network ACL's VPC
10+
rules.{index}.protocol Protocol to which this rule applies (ANY | TCP | UDP | ICMP)
11+
rules.{index}.source Source IP range to which this rule applies (CIDR notation with subnet mask)
12+
rules.{index}.src-port-low Starting port of the source port range to which this rule applies (inclusive)
13+
rules.{index}.src-port-high Ending port of the source port range to which this rule applies (inclusive)
14+
rules.{index}.destination Destination IP range to which this rule applies (CIDR notation with subnet mask)
15+
rules.{index}.dst-port-low Starting port of the destination port range to which this rule applies (inclusive)
16+
rules.{index}.dst-port-high Ending port of the destination port range to which this rule applies (inclusive)
17+
rules.{index}.action Policy to apply to the packet (unknown_action | accept | drop)
18+
rules.{index}.description Rule description
19+
is-ipv6 Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each Network ACL can have rules for only one IP type.
20+
default-policy Action to take for packets which do not match any rules (unknown_action | accept | drop)
21+
[region=fr-par] Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)
22+
23+
FLAGS:
24+
-h, --help help for set
25+
26+
GLOBAL FLAGS:
27+
-c, --config string The path to the config file
28+
-D, --debug Enable debug mode
29+
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
30+
-p, --profile string The config profile to use

‎cmd/scw/testdata/test-all-usage-vpc-rule-usage.golden‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
Acl Rules.
44

55
USAGE:
6-
scw vpc rule
6+
scw vpc rule <command>
7+
8+
AVAILABLE COMMANDS:
9+
get Get Acl Rules for VPC
10+
set Set VPC ACL rules
711

812
FLAGS:
913
-h, --help help for rule
@@ -13,3 +17,5 @@ GLOBAL FLAGS:
1317
-D, --debug Enable debug mode
1418
-o, --output string Output format: json or human, see 'scw help output' for more info (default "human")
1519
-p, --profile string The config profile to use
20+
21+
Use "scw vpc rule [command] --help" for more information about a command.

‎docs/commands/tem.md‎

Lines changed: 49 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ This API allows you to manage your Transactional Email services.
2121
- [Email statuses](#email-statuses)
2222
- [List emails](#list-emails)
2323
- [Project offers management commands](#project-offers-management-commands)
24+
- [List the available offers.](#list-the-available-offers.)
25+
- [Update a subscribed offer](#update-a-subscribed-offer)
2426
- [Project consumption management commands](#project-consumption-management-commands)
27+
- [Get project resource consumption.](#get-project-resource-consumption.)
2528
- [Project settings management commands](#project-settings-management-commands)
2629
- [Webhook management commands](#webhook-management-commands)
2730
- [Create a Webhook](#create-a-webhook)
@@ -398,29 +401,71 @@ scw tem email list [arg=value ...]
398401

399402
This section allows you to manage and get get subscribed information about your project email offer.
400403

401-
This section allows you to manage and get get subscribed information about your project email offer.
404+
405+
### List the available offers.
406+
407+
Retrieve the list of the available and free-of-charge offers you can subscribe to.
408+
409+
**Usage:**
410+
411+
```
412+
scw tem offers list [arg=value ...]
413+
```
414+
415+
416+
**Args:**
417+
418+
| Name | | Description |
419+
|------|---|-------------|
420+
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
421+
422+
423+
424+
### Update a subscribed offer
425+
426+
Update a subscribed offer.
402427

403428
**Usage:**
404429

405430
```
406-
scw tem offers
431+
scw tem offers update [arg=value ...]
407432
```
408433

409434

435+
**Args:**
436+
437+
| Name | | Description |
438+
|------|---|-------------|
439+
| project-id | | Project ID to use. If none is passed the default project ID will be used |
440+
| name | One of: `unknown_name`, `essential`, `scale` | Name of the offer-subscription |
441+
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
442+
443+
410444

411445
## Project consumption management commands
412446

413447
Project consumption allow you to see your project consumption.
414448

415-
Project consumption allow you to see your project consumption.
449+
450+
### Get project resource consumption.
451+
452+
Get project resource consumption.
416453

417454
**Usage:**
418455

419456
```
420-
scw tem project-consumption
457+
scw tem project-consumption get [arg=value ...]
421458
```
422459

423460

461+
**Args:**
462+
463+
| Name | | Description |
464+
|------|---|-------------|
465+
| project-id | | Project ID to use. If none is passed the default project ID will be used |
466+
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
467+
468+
424469

425470
## Project settings management commands
426471

‎docs/commands/vpc.md‎

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This API allows you to manage your Virtual Private Clouds (VPCs) and Private Net
1717
- [Return routes with associated next hop data](#return-routes-with-associated-next-hop-data)
1818
- [Update Route](#update-route)
1919
- [Rule management command](#rule-management-command)
20+
- [Get Acl Rules for VPC](#get-acl-rules-for-vpc)
21+
- [Set VPC ACL rules](#set-vpc-acl-rules)
2022
- [Subnet management command](#subnet-management-command)
2123
- [VPC management command](#vpc-management-command)
2224
- [Create a VPC](#create-a-vpc)
@@ -313,15 +315,58 @@ scw vpc route update <route-id ...> [arg=value ...]
313315

314316
Acl Rules.
315317

316-
Acl Rules.
318+
319+
### Get Acl Rules for VPC
320+
321+
Retrieve a list of ACL rules for a VPC, specified by its VPC ID.
322+
323+
**Usage:**
324+
325+
```
326+
scw vpc rule get [arg=value ...]
327+
```
328+
329+
330+
**Args:**
331+
332+
| Name | | Description |
333+
|------|---|-------------|
334+
| vpc-id | Required | ID of the Network ACL's VPC |
335+
| is-ipv6 | Required | Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each Network ACL can have rules for only one IP type. |
336+
| 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 |
337+
338+
339+
340+
### Set VPC ACL rules
341+
342+
Set the list of ACL rules and the default routing policy for a VPC.
317343

318344
**Usage:**
319345

320346
```
321-
scw vpc rule
347+
scw vpc rule set [arg=value ...]
322348
```
323349

324350

351+
**Args:**
352+
353+
| Name | | Description |
354+
|------|---|-------------|
355+
| vpc-id | Required | ID of the Network ACL's VPC |
356+
| rules.{index}.protocol | Required<br />One of: `ANY`, `TCP`, `UDP`, `ICMP` | Protocol to which this rule applies |
357+
| rules.{index}.source | Required | Source IP range to which this rule applies (CIDR notation with subnet mask) |
358+
| rules.{index}.src-port-low | Required | Starting port of the source port range to which this rule applies (inclusive) |
359+
| rules.{index}.src-port-high | Required | Ending port of the source port range to which this rule applies (inclusive) |
360+
| rules.{index}.destination | Required | Destination IP range to which this rule applies (CIDR notation with subnet mask) |
361+
| rules.{index}.dst-port-low | Required | Starting port of the destination port range to which this rule applies (inclusive) |
362+
| rules.{index}.dst-port-high | Required | Ending port of the destination port range to which this rule applies (inclusive) |
363+
| rules.{index}.action | Required<br />One of: `unknown_action`, `accept`, `drop` | Policy to apply to the packet |
364+
| rules.{index}.description | Required | Rule description |
365+
| is-ipv6 | Required | Defines whether this set of ACL rules is for IPv6 (false = IPv4). Each Network ACL can have rules for only one IP type. |
366+
| default-policy | Required<br />One of: `unknown_action`, `accept`, `drop` | Action to take for packets which do not match any rules |
367+
| 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 |
368+
369+
325370

326371
## Subnet management command
327372

0 commit comments

Comments
 (0)