Skip to content

Commit b92ea16

Browse files
committed
add documentation
1 parent 6c4ad0a commit b92ea16

3 files changed

Lines changed: 11 additions & 37 deletions

File tree

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`, `account_contract_signature`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `instance_template`, `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`, `vpc_vpc`, `vpc_subnet`, `vpc_route`, `vpc_acl`, `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`, `s2s_vpn_gateway`, `s2s_customer_gateway`, `s2s_routing_policy`, `s2s_connection`, `vpc_gw_gateway`, `vpc_gw_gateway_network`, `vpc_gw_dhcp`, `vpc_gw_dhcp_entry`, `vpc_gw_pat_rule`, `vpc_gw_ip`, `audit_trail_export_job` | (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`, `iam_scim`, `iam_scim_token`, `secret_manager_secret`, `secret_manager_version`, `key_manager_key`, `account_user`, `account_organization`, `account_project`, `account_contract_signature`, `instance_server`, `instance_placement_group`, `instance_security_group`, `instance_volume`, `instance_snapshot`, `instance_image`, `instance_template`, `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`, `vpc_vpc`, `vpc_subnet`, `vpc_route`, `vpc_acl`, `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`, `s2s_vpn_gateway`, `s2s_customer_gateway`, `s2s_routing_policy`, `s2s_connection`, `vpc_gw_gateway`, `vpc_gw_gateway_network`, `vpc_gw_dhcp`, `vpc_gw_dhcp_entry`, `vpc_gw_pat_rule`, `vpc_gw_ip` | (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/datawarehouse.md

Lines changed: 2 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ Data Warehouse API.
1414
- [List deployments](#list-deployments)
1515
- [Update a deployment](#update-a-deployment)
1616
- [Endpoint management commands](#endpoint-management-commands)
17-
- [Create a new endpoint for a deployment](#create-a-new-endpoint-for-a-deployment)
18-
- [Delete an endpoint from a deployment](#delete-an-endpoint-from-a-deployment)
1917
- [List available presets](#list-available-presets)
2018
- [List available presets](#list-available-presets)
2119
- [User management commands](#user-management-commands)
@@ -243,47 +241,15 @@ scw datawarehouse deployment update <deployment-id ...> [arg=value ...]
243241

244242
Manage endpoints associated with a deployment.
245243

246-
247-
### Create a new endpoint for a deployment
248-
249-
Create a new endpoint for a deployment.
250-
251-
**Usage:**
252-
253-
```
254-
scw datawarehouse endpoint create [arg=value ...]
255-
```
256-
257-
258-
**Args:**
259-
260-
| Name | | Description |
261-
|------|---|-------------|
262-
| deployment-id | | UUID of the deployment |
263-
| endpoint.private-network.private-network-id | | UUID of the Private Network |
264-
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
265-
266-
267-
268-
### Delete an endpoint from a deployment
269-
270-
Delete an endpoint from a deployment.
244+
Manage endpoints associated with a deployment.
271245

272246
**Usage:**
273247

274248
```
275-
scw datawarehouse endpoint delete [arg=value ...]
249+
scw datawarehouse endpoint
276250
```
277251

278252

279-
**Args:**
280-
281-
| Name | | Description |
282-
|------|---|-------------|
283-
| endpoint-id | Required | UUID of the Endpoint to delete |
284-
| region | Default: `fr-par`<br />One of: `fr-par` | Region to target. If none is passed will use default region from the config |
285-
286-
287253

288254
## List available presets
289255

docs/commands/edge-services.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,10 @@ scw edge-services backend-stage create [arg=value ...]
8686
| scaleway-lb.lbs.{index}.domain-name | | Fully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer |
8787
| scaleway-lb.lbs.{index}.has-websocket | | Defines whether to forward websocket requests to the load balancer |
8888
| pipeline-id | Required | Pipeline ID the Backend stage belongs to |
89+
| scaleway-serverless-container.region | | |
90+
| scaleway-serverless-container.container-id | | |
91+
| scaleway-serverless-function.region | | |
92+
| scaleway-serverless-function.function-id | | |
8993

9094

9195

@@ -176,6 +180,10 @@ scw edge-services backend-stage update <backend-stage-id ...> [arg=value ...]
176180
| scaleway-lb.lbs.{index}.domain-name | | Fully Qualified Domain Name (in the format subdomain.example.com) to use in HTTP requests sent towards your Load Balancer |
177181
| scaleway-lb.lbs.{index}.has-websocket | | Defines whether to forward websocket requests to the load balancer |
178182
| pipeline-id | | Pipeline ID the Backend stage belongs to |
183+
| scaleway-serverless-container.region | | |
184+
| scaleway-serverless-container.container-id | | |
185+
| scaleway-serverless-function.region | | |
186+
| scaleway-serverless-function.function-id | | |
179187

180188

181189

0 commit comments

Comments
 (0)