Add docs for paas commands

kuzzleio · Nov 13, 2023 · de001a2 · de001a2
1 parent 4c13d71
commit de001a2
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/src/commands/paas/snapshots/cat.ts b/src/commands/paas/snapshots/cat.ts
@@ -30,6 +30,8 @@ class PaasSnapshotsCat extends PaasKommand {
     }
   ];
 
+  static examples = ["kourou paas:snapshots:cat --project paas-project-myproject api main"];
+
   async runSafe() {
     const apiKey = await this.getCredentials();
 

diff --git a/src/commands/paas/snapshots/dump.ts b/src/commands/paas/snapshots/dump.ts
@@ -4,7 +4,7 @@ import { PaasKommand } from "../../../support/PaasKommand";
 
 class PaasSnapshotsDump extends PaasKommand {
   public static description =
-    "List all snapshots for a given kuzzle application in a environment";
+    "Create a new snapshot of the current application state";
 
   public static flags = {
     help: flags.help(),
@@ -30,6 +30,8 @@ class PaasSnapshotsDump extends PaasKommand {
     }
   ];
 
+  static examples = ["kourou paas:snapshots:dump --project paas-project-myproject api main"];
+
   async runSafe() {
     const apiKey = await this.getCredentials();
 

diff --git a/src/commands/paas/snapshots/restore.ts b/src/commands/paas/snapshots/restore.ts
@@ -4,7 +4,7 @@ import { PaasKommand } from "../../../support/PaasKommand";
 
 class PaasSnapshotsRestore extends PaasKommand {
   public static description =
-    "List all snapshots for a given kuzzle application in a environment";
+    "Restore a snapshot of the current application state";
 
   public static flags = {
     help: flags.help(),
@@ -35,6 +35,8 @@ class PaasSnapshotsRestore extends PaasKommand {
     }
   ];
 
+  static examples = ["kourou paas:snapshots:restore --project paas-project-myproject api main snapshot-id"];
+
   async runSafe() {
     const apiKey = await this.getCredentials();
-Original file line number
+Diff line change
@@ Expand Up / @@ -30,6 +30,8 @@ class PaasSnapshotsCat extends PaasKommand { @@
         }
       ];
+      static examples = ["kourou paas:snapshots:cat --project paas-project-myproject api main"];
       async runSafe() {
         const apiKey = await this.getCredentials();
@@ Expand Down @@