From dbeb92288240da5856f883bb77ee3b141beaedc9 Mon Sep 17 00:00:00 2001
From: Yi Wang <wang.yi59@zte.com.cn>
Date: Thu, 5 May 2022 18:51:47 +0800
Subject: [PATCH] doc: add vm coredump support

Signed-off-by: Yi Wang <wang.yi59@zte.com.cn>
Co-authored-by: Sebastien Boeuf <sebastien.boeuf@intel.com>
---
 docs/api.md                               |  1 +
 vmm/src/api/openapi/cloud-hypervisor.yaml | 24 +++++++++++++++++++++++
 2 files changed, 25 insertions(+)

diff --git a/docs/api.md b/docs/api.md
index 5ffd07194..219af8694 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -89,6 +89,7 @@ Trigger power button of the VM     | `/vm.power-button`   | N/A
 Pause the VM                       | `/vm.pause`          | N/A                       | N/A                      | The VM is booted
 Resume the VM                      | `/vm.resume`         | N/A                       | N/A                      | The VM is paused
 Task a snapshot of the VM          | `/vm.snapshot`       | `/schemas/VmSnapshotConfig`| N/A                     | The VM is paused
+Perform a coredump of the VM       | `/vm.coredump`       | `/schemas/VmCoredumpData` | N/A                      | The VM is paused
 Restore the VM from a snapshot     | `/vm.restore`        | `/schemas/RestoreConfig`  | N/A                      | The VM is created but not booted
 Add/remove CPUs to/from the VM     | `/vm.resize`         | `/schemas/VmResize`       | N/A                      | The VM is booted
 Add/remove memory from the VM      | `/vm.resize`         | `/schemas/VmResize`       | N/A                      | The VM is booted
diff --git a/vmm/src/api/openapi/cloud-hypervisor.yaml b/vmm/src/api/openapi/cloud-hypervisor.yaml
index d3fbdbf14..d8b8ed5f2 100644
--- a/vmm/src/api/openapi/cloud-hypervisor.yaml
+++ b/vmm/src/api/openapi/cloud-hypervisor.yaml
@@ -366,6 +366,24 @@ paths:
         405:
           description: The VM instance could not be snapshotted because it is not booted.
 
+  /vm.coredump:
+    put:
+      summary: Takes a VM coredump.
+      requestBody:
+        description: The coredump configuration
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/VmCoredumpData'
+        required: true
+      responses:
+        204:
+          description: The VM instance was successfully coredumped.
+        404:
+          description: The VM instance could not be coredumped because it is not created.
+        405:
+          description: The VM instance could not be coredumped because it is not booted.
+
   /vm.restore:
     put:
       summary: Restore a VM from a snapshot.
@@ -1098,6 +1116,12 @@ components:
         destination_url:
           type: string
 
+    VmCoredumpData:
+      type: object
+      properties:
+        destination_url:
+          type: string
+
     RestoreConfig:
       required:
       - source_url