Skip to content

Commit 7cda413

Browse files
scaleway-botscaleway-bot
authored
docs: harmonize API descriptions (#3808)
1 parent ff8d3c9 commit 7cda413

File tree

86 files changed

+143
-142
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+143
-142
lines changed

‎cmd/scw/testdata/test-all-usage-account-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to manage projects.
3+
This API allows you to manage your Scaleway Projects.
44

55
USAGE:
66
scw account <command>

‎cmd/scw/testdata/test-all-usage-billing-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to query your consumption.
3+
This API allows you to manage and query your Scaleway billing and consumption.
44

55
USAGE:
66
scw billing <command>

‎cmd/scw/testdata/test-all-usage-block-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to use and manage your Block Storage volumes.
3+
This API allows you to manage your Block Storage volumes.
44

55
USAGE:
66
scw block <command>

‎cmd/scw/testdata/test-all-usage-cockpit-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Cockpit API.
3+
This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs.
44

55
USAGE:
66
scw cockpit <command>

‎cmd/scw/testdata/test-all-usage-container-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Container as a Service API.
3+
This API allows you to manage your Serverless Containers.
44

55
USAGE:
66
scw container <command>

‎cmd/scw/testdata/test-all-usage-dns-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Manage your domains, DNS zones and records with the Domains and DNS API.
3+
This API allows you to manage your domains, DNS zones and records.
44

55
USAGE:
66
scw dns <command>

‎cmd/scw/testdata/test-all-usage-document-db-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Managed Document Databases API
3+
This API allows you to manage your Document Databases.
44

55
USAGE:
66
scw document-db <command>

‎cmd/scw/testdata/test-all-usage-fip-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Elastic Metal - Flexible IP API.
3+
This API allows you to manage your Elastic Metal servers' flexible public IP addresses.
44

55
USAGE:
66
scw fip <command>

‎cmd/scw/testdata/test-all-usage-iam-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
IAM API.
3+
This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources.
44

55
USAGE:
66
scw iam <command>

‎cmd/scw/testdata/test-all-usage-instance-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Instance API.
3+
This API allows you to manage your Instances.
44

55
USAGE:
66
scw instance <command>

‎cmd/scw/testdata/test-all-usage-iot-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to manage IoT hubs and devices.
3+
This API allows you to manage your IoT hubs and devices.
44

55
USAGE:
66
scw iot <command>

‎cmd/scw/testdata/test-all-usage-ipam-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to manage IP addresses with Scaleway's IP Address Management tool.
3+
This API allows you to manage your Scaleway IP addresses with our IP Address Management tool.
44

55
USAGE:
66
scw ipam <command>

‎cmd/scw/testdata/test-all-usage-jobs-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Serverless Jobs API.
3+
This API allows you to manage your Serverless Jobs.
44

55
USAGE:
66
scw jobs <command>

‎cmd/scw/testdata/test-all-usage-k8s-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Kubernetes API.
3+
This API allows you to manage Kubernetes Kapsule and Kosmos clusters.
44

55
USAGE:
66
scw k8s <command>

‎cmd/scw/testdata/test-all-usage-llm-inference-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
LLM Inference API.
3+
This API allows you to manage your LLM Inference services.
44

55
USAGE:
66
scw llm-inference <command>

‎cmd/scw/testdata/test-all-usage-marketplace-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Marketplace API
3+
This API allows you to find available images for use when launching a Scaleway Instance.
44

55
USAGE:
66
scw marketplace <command>

‎cmd/scw/testdata/test-all-usage-mnq-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Messaging and Queuing APIs.
3+
These APIs allow you to manage your Messaging and Queuing NATS, SQS and SNS services.
44

55
USAGE:
66
scw mnq <command>

‎cmd/scw/testdata/test-all-usage-rdb-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Managed Database for PostgreSQL and MySQL API
3+
This API allows you to manage your Managed Databases for PostgreSQL and MySQL.
44

55
USAGE:
66
scw rdb <command>

‎cmd/scw/testdata/test-all-usage-redis-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Managed Database for Redis™ API
3+
This API allows you to manage your Managed Databases for Redis™.
44

55
USAGE:
66
scw redis <command>

‎cmd/scw/testdata/test-all-usage-registry-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Container Registry API.
3+
This API allows you to manage your Container Registry resources.
44

55
USAGE:
66
scw registry <command>

‎cmd/scw/testdata/test-all-usage-sdb-sql-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to manage your Serverless SQL DB databases.
3+
This API allows you to manage your Serverless SQL Databases.
44

55
USAGE:
66
scw sdb-sql <command>

‎cmd/scw/testdata/test-all-usage-secret-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
This API allows you to conveniently store, access and share sensitive data such as passwords, API keys and certificates.
3+
This API allows you to manage your Secret Manager services, for storing, accessing and sharing sensitive data such as passwords, API keys and certificates.
44

55
USAGE:
66
scw secret <command>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Transactional Email API
3+
This API allows you to manage your Transactional Email services.
44

55
USAGE:
66
scw tem <command>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Public Gateways API.
3+
This API allows you to manage your Public Gateways.
44

55
USAGE:
66
scw vpc-gw <command>

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
VPC API.
3+
This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks.
44

55
USAGE:
66
scw vpc <command>

‎cmd/scw/testdata/test-all-usage-webhosting-usage.golden

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
3-
Web Hosting API.
3+
This API allows you to manage your Web Hosting services.
44

55
USAGE:
66
scw webhosting <command>

‎cmd/scw/testdata/test-main-usage-usage.golden

+25-25
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,39 @@ USAGE:
44
scw <command>
55

66
AVAILABLE COMMANDS:
7-
account This API allows you to manage projects
7+
account This API allows you to manage your Scaleway Projects
88
apple-silicon Apple silicon API
99
autocomplete Autocomplete related commands
1010
baremetal Elastic Metal API
11-
billing This API allows you to query your consumption
12-
block This API allows you to use and manage your Block Storage volumes
13-
cockpit Cockpit API
14-
container Container as a Service API
15-
dns Domains and DNS API
16-
document-db Managed Document Databases API
17-
fip Elastic Metal - Flexible IP API
11+
billing This API allows you to manage and query your Scaleway billing and consumption
12+
block This API allows you to manage your Block Storage volumes
13+
cockpit This API allows you to manage your Scaleway Cockpit, for storing and visualizing metrics and logs
14+
container This API allows you to manage your Serverless Containers
15+
dns This API allows you to manage your domains, DNS zones and records
16+
document-db This API allows you to manage your Document Databases
17+
fip This API allows you to manage your Elastic Metal servers' flexible public IP addresses
1818
function Function as a Service API
1919
help Get help about how the CLI works
20-
iam IAM API
21-
instance Instance API
22-
iot This API allows you to manage IoT hubs and devices
23-
ipam This API allows you to manage IP addresses with Scaleway's IP Address Management tool
24-
jobs Serverless Jobs API
25-
k8s Kubernetes API
20+
iam This API allows you to manage Identity and Access Management (IAM) across your Scaleway Organizations, Projects and resources
21+
instance This API allows you to manage your Instances
22+
iot This API allows you to manage your IoT hubs and devices
23+
ipam This API allows you to manage your Scaleway IP addresses with our IP Address Management tool
24+
jobs This API allows you to manage your Serverless Jobs
25+
k8s This API allows you to manage Kubernetes Kapsule and Kosmos clusters
2626
lb This API allows you to manage your Scaleway Load Balancer services
27-
llm-inference LLM Inference API
28-
marketplace Marketplace API
29-
mnq Messaging and Queuing APIs
27+
llm-inference This API allows you to manage your LLM Inference services
28+
marketplace This API allows you to find available images for use when launching a Scaleway Instance
29+
mnq These APIs allow you to manage your Messaging and Queuing NATS, SQS and SNS services
3030
object Object-storage utils
31-
rdb Managed Database for PostgreSQL and MySQL API
32-
redis Managed Database for Redis™ API
33-
registry Container Registry API
34-
sdb-sql This API allows you to manage your Serverless SQL DB databases
31+
rdb This API allows you to manage your Managed Databases for PostgreSQL and MySQL
32+
redis This API allows you to manage your Managed Databases for Redis™
33+
registry This API allows you to manage your Container Registry resources
34+
sdb-sql This API allows you to manage your Serverless SQL Databases
3535
secret Secret Manager API
36-
tem Transactional Email API
37-
vpc VPC API
38-
vpc-gw Public Gateways API
39-
webhosting Web Hosting API
36+
tem This API allows you to manage your Transactional Email services
37+
vpc This API allows you to manage your Virtual Private Clouds (VPCs) and Private Networks
38+
vpc-gw This API allows you to manage your Public Gateways
39+
webhosting This API allows you to manage your Web Hosting services
4040

4141
AVAILABLE LABS COMMANDS:
4242
ipfs IPFS Pinning service API

‎docs/commands/account.md

+1-1

‎docs/commands/billing.md

+1-1

‎docs/commands/block.md

+1-1

‎docs/commands/cockpit.md

+1-1

‎docs/commands/container.md

+1-1

‎docs/commands/dns.md

+1-1

‎docs/commands/document-db.md

+1-1

‎docs/commands/fip.md

+1-1

‎docs/commands/iam.md

+1-1

‎docs/commands/instance.md

+1-1

‎docs/commands/iot.md

+1-1

‎docs/commands/ipam.md

+1-1

‎docs/commands/jobs.md

+1-1

‎docs/commands/k8s.md

+1-1

‎docs/commands/llm-inference.md

+1-1

0 commit comments

Comments
 (0)