chore(searchdb): update documentation phrasing (#5290)

scaleway-bot · remyleone · web-flow · commit 42f0f5c6ebe1 · 2026-01-26T13:50:04.000Z
Co-authored-by: Rémy Léone &lt;rleone@scaleway.com&gt;
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-create-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-create-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create searchdb resources.
+Create a new Cloud Essentials for OpenSearch deployment.
 
 USAGE:
   scw searchdb deployment create [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-delete-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-delete-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete searchdb resources.
+Delete a Cloud Essentials for OpenSearch deployment.
 
 USAGE:
   scw searchdb deployment delete [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-get-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-get-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get searchdb resources.
+Retrieve a specific Cloud Essentials for OpenSearch deployment.
 
 USAGE:
   scw searchdb deployment get [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-list-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List searchdb resources.
+Retrieve a list of Cloud Essentials for OpenSearch deployments.
 
 USAGE:
   scw searchdb deployment list [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-update-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-update-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update searchdb resources.
+Update a Cloud Essentials for OpenSearch deployment.
 
 USAGE:
   scw searchdb deployment update [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-upgrade-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-upgrade-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Upgrade searchdb resources.
+Upgrade a Cloud Essentials for OpenSearch deployment.
 
 USAGE:
   scw searchdb deployment upgrade [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-deployment-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-deployment-usage.golden
@@ -1,17 +1,17 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Manage your SearchDB deployment.
+Manage your Cloud Essentials for OpenSearch deployment.
 
 USAGE:
   scw searchdb deployment <command>
 
 AVAILABLE COMMANDS:
-  create      Create searchdb resources
-  delete      Delete searchdb resources
-  get         Get searchdb resources
-  list        List searchdb resources
-  update      Update searchdb resources
-  upgrade     Upgrade searchdb resources
+  create      Create a new Cloud Essentials for OpenSearch deployment
+  delete      Delete a Cloud Essentials for OpenSearch deployment
+  get         Retrieve a specific Cloud Essentials for OpenSearch deployment
+  list        Retrieve a list of Cloud Essentials for OpenSearch deployments
+  update      Update a Cloud Essentials for OpenSearch deployment
+  upgrade     Upgrade a Cloud Essentials for OpenSearch deployment
 
 FLAGS:
   -h, --help                help for deployment
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-endpoint-create-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-endpoint-create-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create searchdb resources.
+Create a new endpoint on a deployment.
 
 USAGE:
   scw searchdb endpoint create [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-endpoint-delete-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-endpoint-delete-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete searchdb resources.
+Delete an existing endpoint.
 
 USAGE:
   scw searchdb endpoint delete [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-endpoint-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-endpoint-usage.golden
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Manage your SearchDB deployment endpoint.
+Manage your Cloud Essentials for OpenSearch deployment endpoint.
 
 USAGE:
   scw searchdb endpoint <command>
 
 AVAILABLE COMMANDS:
-  create      Create searchdb resources
-  delete      Delete searchdb resources
+  create      Create a new endpoint on a deployment
+  delete      Delete an existing endpoint
 
 FLAGS:
   -h, --help                help for endpoint
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-node-types-list-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-node-types-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List searchdb resources.
+Retrieve a list of available node types.
 
 USAGE:
   scw searchdb node-types list [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-node-types-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-node-types-usage.golden
@@ -6,7 +6,7 @@ USAGE:
   scw searchdb node-types <command>
 
 AVAILABLE COMMANDS:
-  list        List searchdb resources
+  list        Retrieve a list of available node types
 
 FLAGS:
   -h, --help                help for node-types
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-SearchDB API.
+Cloud Essentials for Opensearch API.
 
 USAGE:
   scw searchdb <command>
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-user-create-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-user-create-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create searchdb resources.
+Create a new user.
 
 USAGE:
   scw searchdb user create [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-user-delete-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-user-delete-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete searchdb resources.
+Delete an existing user.
 
 USAGE:
   scw searchdb user delete [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-user-list-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-user-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List searchdb resources.
+Retrieve a list of deployment users.
 
 USAGE:
   scw searchdb user list [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-user-update-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-user-update-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update searchdb resources.
+Update an existing user.
 
 USAGE:
   scw searchdb user update [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-user-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-user-usage.golden
@@ -1,15 +1,15 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Manage your SearchDB deployment users.
+Manage your Cloud Essentials for OpenSearch deployment users.
 
 USAGE:
   scw searchdb user <command>
 
 AVAILABLE COMMANDS:
-  create      Create searchdb resources
-  delete      Delete searchdb resources
-  list        List searchdb resources
-  update      Update searchdb resources
+  create      Create a new user
+  delete      Delete an existing user
+  list        Retrieve a list of deployment users
+  update      Update an existing user
 
 FLAGS:
   -h, --help                help for user
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-versions-list-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-versions-list-usage.golden
@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List searchdb resources.
+List available Cloud Essentials for OpenSearch versions.
 
 USAGE:
   scw searchdb versions list [arg=value ...]
diff --git a/cmd/scw/testdata/test-all-usage-searchdb-versions-usage.golden b/cmd/scw/testdata/test-all-usage-searchdb-versions-usage.golden
@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List your SearchDB versions.
+List your Cloud Essentials for OpenSearch versions.
 
 USAGE:
   scw searchdb versions <command>
 
 AVAILABLE COMMANDS:
-  list        List searchdb resources
+  list        List available Cloud Essentials for OpenSearch versions
 
 FLAGS:
   -h, --help                help for versions
diff --git a/cmd/scw/testdata/test-main-usage-usage.golden b/cmd/scw/testdata/test-main-usage-usage.golden
@@ -35,7 +35,7 @@ DATABASE COMMANDS:
   rdb           This API allows you to manage your Managed Databases for PostgreSQL and MySQL
   redis         This API allows you to manage your Managed Databases for Redis™
   sdb-sql       This API allows you to manage your Serverless SQL Databases
-  searchdb      SearchDB API
+  searchdb      Cloud Essentials for Opensearch API
 
 DOMAIN & WEBHOSTING COMMANDS:
   dns           This API allows you to manage your domains, DNS zones and records
diff --git a/docs/commands/searchdb.md b/docs/commands/searchdb.md
diff --git a/internal/namespaces/searchdb/v1alpha1/searchdb_cli.go b/internal/namespaces/searchdb/v1alpha1/searchdb_cli.go
