Skip to content

Commit b8d8c42

Browse files
committed
Fix documentation
1 parent 336f677 commit b8d8c42

File tree

3 files changed

+14
-18
lines changed

3 files changed

+14
-18
lines changed

docs/commands/audit-trail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ scw audit-trail event list [arg=value ...]
2929
| Name | | Description |
3030
|------|---|-------------|
3131
| project-id | | (Optional) ID of the Project containing the Audit Trail events |
32-
| resource-type | One of: `unknown_type`, `secm_secret`, `secm_secret_version`, `kube_cluster`, `kube_pool`, `kube_node`, `kube_acl`, `keym_key`, `iam_user`, `iam_application`, `iam_group`, `iam_policy`, `iam_api_key`, `iam_ssh_key`, `iam_rule`, `iam_saml`, `iam_saml_certificate`, `iam_scim`, `iam_scim_token`, `secret_manager_secret`, `secret_manager_version`, `key_manager_key`, `account_user`, `account_organization`, `account_project`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `apple_silicon_server`, `baremetal_server`, `baremetal_setting`, `ipam_ip`, `sbs_volume`, `sbs_snapshot`, `load_balancer_lb`, `load_balancer_ip`, `load_balancer_frontend`, `load_balancer_backend`, `load_balancer_route`, `load_balancer_acl`, `load_balancer_certificate`, `sfs_filesystem`, `vpc_private_network`, `edge_services_plan`, `edge_services_pipeline`, `edge_services_dns_stage`, `edge_services_tls_stage`, `edge_services_cache_stage`, `edge_services_route_stage`, `edge_services_route_rules`, `edge_services_waf_stage`, `edge_services_backend_stage` | (Optional) Type of the Scaleway resource |
32+
| resource-type | One of: `unknown_type`, `secm_secret`, `secm_secret_version`, `kube_cluster`, `kube_pool`, `kube_node`, `kube_acl`, `keym_key`, `iam_user`, `iam_application`, `iam_group`, `iam_policy`, `iam_api_key`, `iam_ssh_key`, `iam_rule`, `iam_saml`, `iam_saml_certificate`, `secret_manager_secret`, `secret_manager_version`, `key_manager_key`, `account_user`, `account_organization`, `account_project`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `apple_silicon_server`, `baremetal_server`, `baremetal_setting`, `ipam_ip`, `sbs_volume`, `sbs_snapshot`, `load_balancer_lb`, `load_balancer_ip`, `load_balancer_frontend`, `load_balancer_backend`, `load_balancer_route`, `load_balancer_acl`, `load_balancer_certificate`, `sfs_filesystem`, `vpc_private_network`, `edge_services_plan`, `edge_services_pipeline`, `edge_services_dns_stage`, `edge_services_tls_stage`, `edge_services_cache_stage`, `edge_services_route_stage`, `edge_services_route_rules`, `edge_services_waf_stage`, `edge_services_backend_stage` | (Optional) Type of the Scaleway resource |
3333
| method-name | | (Optional) Name of the method of the API call performed |
3434
| status | | (Optional) HTTP status code of the request. Returns either `200` if the request was successful or `403` if the permission was denied |
3535
| recorded-after | | (Optional) The `recorded_after` parameter defines the earliest timestamp from which Audit Trail events are retrieved. Returns `one hour ago` by default |

docs/commands/cockpit.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ This API allows you to manage your Scaleway Cockpit, for storing and visualizing
2020
- [Get your Cockpit's Grafana](#get-your-cockpit's-grafana)
2121
- [Synchronize Grafana data sources](#synchronize-grafana-data-sources)
2222
- [Grafana user management commands](#grafana-user-management-commands)
23-
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
24-
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
25-
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
26-
- [(Deprecated) EOL 2026-01-20](#(deprecated)-eol-2026-01-20)
23+
- [Create a Grafana user](#create-a-grafana-user)
24+
- [Delete a Grafana user](#delete-a-grafana-user)
25+
- [List Grafana users](#list-grafana-users)
26+
- [Reset a Grafana user password](#reset-a-grafana-user-password)
2727
- [Managed alerts management commands](#managed-alerts-management-commands)
2828
- [Pricing plans management commands](#pricing-plans-management-commands)
2929
- [Get current plan](#get-current-plan)
@@ -342,9 +342,8 @@ scw cockpit grafana sync-data-sources [arg=value ...]
342342
Grafana user management commands.
343343

344344

345-
### (Deprecated) EOL 2026-01-20
345+
### Create a Grafana user
346346

347-
Create a Grafana user
348347
Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
349348
Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation.
350349

@@ -365,9 +364,8 @@ scw cockpit grafana-user create [arg=value ...]
365364

366365

367366

368-
### (Deprecated) EOL 2026-01-20
367+
### Delete a Grafana user
369368

370-
Delete a Grafana user
371369
Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
372370

373371
**Usage:**
@@ -386,9 +384,8 @@ scw cockpit grafana-user delete [arg=value ...]
386384

387385

388386

389-
### (Deprecated) EOL 2026-01-20
387+
### List Grafana users
390388

391-
List Grafana users
392389
List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
393390

394391
**Usage:**
@@ -407,9 +404,8 @@ scw cockpit grafana-user list [arg=value ...]
407404

408405

409406

410-
### (Deprecated) EOL 2026-01-20
407+
### Reset a Grafana user password
411408

412-
Reset a Grafana user password
413409
Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
414410
A new password regenerates and only displays once. Make sure that you save it.
415411

@@ -451,7 +447,7 @@ Pricing plans management commands.
451447
### Get current plan
452448

453449
Retrieve a pricing plan for the given Project, specified by the ID of the Project.
454-
Deprecated due to retention now being managed at the data source level.
450+
Deprecated: retention is now managed at the data source level.
455451

456452
**Usage:**
457453

@@ -471,7 +467,7 @@ scw cockpit plan get [arg=value ...]
471467
### List plan types
472468

473469
Retrieve a list of available pricing plan types.
474-
Deprecated due to retention now being managed at the data source level.
470+
Deprecated: retention is now managed at the data source level.
475471

476472
**Usage:**
477473

@@ -491,7 +487,7 @@ scw cockpit plan list [arg=value ...]
491487
### Apply a pricing plan
492488

493489
Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
494-
Deprecated due to retention now being managed at the data source level.
490+
Deprecated: retention is now managed at the data source level.
495491

496492
**Usage:**
497493

docs/commands/mnq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -369,7 +369,7 @@ scw mnq sns get-credentials <sns-credentials-id ...> [arg=value ...]
369369

370370
### Get Topics and Events info
371371

372-
Retrieve the Topics and Events information of the specified Project ID. information include the activation status and the Topics and Events API endpoint URL.
372+
Retrieve the Topics and Events information of the specified Project ID. Information include the activation status and the Topics and Events API endpoint URL.
373373

374374
**Usage:**
375375

@@ -543,7 +543,7 @@ scw mnq sqs get-credentials <sqs-credentials-id ...> [arg=value ...]
543543

544544
### Get Queues info
545545

546-
Retrieve the Queues information of the specified Project ID. information include the activation status and the Queues API endpoint URL.
546+
Retrieve the Queues information of the specified Project ID. Information include the activation status and the Queues API endpoint URL.
547547

548548
**Usage:**
549549

0 commit comments

Comments
 (0)