vmm: api: Update our OpenAPI document

In most cases we return a 204 (No Content) and not a 201.
In those cases, we do not send any HTTP body back at all.

Signed-off-by: Samuel Ortiz <sameo@linux.intel.com>
This commit is contained in:
Samuel Ortiz
2019-11-08 23:39:43 +01:00
parent 96aa2441ad
commit 3dde848c8f
+8 -25
View File
@@ -28,9 +28,8 @@ paths:
summary: Shuts the cloud-hypervisor VMM. summary: Shuts the cloud-hypervisor VMM.
operationId: shutdownVMM operationId: shutdownVMM
responses: responses:
201: 204:
description: The VMM successfully shutdown. description: The VMM successfully shutdown.
content: {}
/vm.info: /vm.info:
get: get:
@@ -55,90 +54,74 @@ paths:
$ref: '#/components/schemas/VmConfig' $ref: '#/components/schemas/VmConfig'
required: true required: true
responses: responses:
201: 204:
description: The VM instance was successfully created. description: The VM instance was successfully created.
content: {}
/vm.delete: /vm.delete:
put: put:
summary: Delete the cloud-hypervisor Virtual Machine (VM) instance. summary: Delete the cloud-hypervisor Virtual Machine (VM) instance.
operationId: deleteVM operationId: deleteVM
responses: responses:
201: 204:
description: The VM instance was successfully deleted. description: The VM instance was successfully deleted.
content: {}
/vm.boot: /vm.boot:
put: put:
summary: Boot the previously created VM instance. summary: Boot the previously created VM instance.
operationId: bootVM operationId: bootVM
responses: responses:
201: 204:
description: The VM instance successfully booted. description: The VM instance successfully booted.
content: {}
404: 404:
description: The VM instance could not boot because it is not created yet description: The VM instance could not boot because it is not created yet
content: {}
/vm.pause: /vm.pause:
put: put:
summary: Pause a previously booted VM instance. summary: Pause a previously booted VM instance.
operationId: pauseVM operationId: pauseVM
responses: responses:
201: 204:
description: The VM instance successfully paused. description: The VM instance successfully paused.
content: {}
404: 404:
description: The VM instance could not pause because it is not created yet description: The VM instance could not pause because it is not created yet
content: {}
405: 405:
description: The VM instance could not pause because it is not booted. description: The VM instance could not pause because it is not booted.
content: {}
/vm.resume: /vm.resume:
put: put:
summary: Resume a previously paused VM instance. summary: Resume a previously paused VM instance.
operationId: resumeVM operationId: resumeVM
responses: responses:
201: 204:
description: The VM instance successfully paused. description: The VM instance successfully paused.
content: {}
404: 404:
description: The VM instance could not resume because it is not booted yet description: The VM instance could not resume because it is not booted yet
content: {}
405: 405:
description: The VM instance could not resume because it is not paused. description: The VM instance could not resume because it is not paused.
content: {}
/vm.shutdown: /vm.shutdown:
put: put:
summary: Shut the VM instance down. summary: Shut the VM instance down.
operationId: shutdownVM operationId: shutdownVM
responses: responses:
201: 204:
description: The VM instance successfully shut down. description: The VM instance successfully shut down.
content: {}
404: 404:
description: The VM instance could not shut down because is not created. description: The VM instance could not shut down because is not created.
content: {}
405: 405:
description: The VM instance could not shut down because it is not started. description: The VM instance could not shut down because it is not started.
content: {}
/vm.reboot: /vm.reboot:
put: put:
summary: Reboot the VM instance. summary: Reboot the VM instance.
operationId: rebootVM operationId: rebootVM
responses: responses:
201: 204:
description: The VM instance successfully rebooted. description: The VM instance successfully rebooted.
content: {}
404: 404:
description: The VM instance could not reboot because it is not created. description: The VM instance could not reboot because it is not created.
content: {}
405: 405:
description: The VM instance could not reboot because it is not booted. description: The VM instance could not reboot because it is not booted.
content: {}
components: components:
schemas: schemas: