From 5d099cfc0a176c1ade5857ecb2376b2a940a2a1a Mon Sep 17 00:00:00 2001 From: Tim Bannister Date: Fri, 12 Jan 2024 11:53:22 +0000 Subject: [PATCH] Tidy docs for Device API Signed-off-by: Tim Bannister --- docs/device-api.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/device-api.md b/docs/device-api.md index 459f0239e1b..97b0d53b2d5 100644 --- a/docs/device-api.md +++ b/docs/device-api.md @@ -1,14 +1,17 @@ # Device -The Device-API following functionality matrix indicates which devices are +Firecracker provides the _Device_ API to let you manage the virtual hardware +available inside each microVM. + +The Device API following functionality matrix indicates which devices are required for an API call to be usable. **O** - Optional: The device (column) **is not required** for a Firecracker -microVM API call to succeed. If the device (column) is omitted from a uVM +microVM API call to succeed. If the device (column) is omitted from a μVM definition, a call to one of the [API Endpoints](#api-endpoints) will succeed. **R** - Required: The device (column) **is required** for a Firecracker microVM -API call to succeed. If the device (column) is omitted from a uVM definition, +API call to succeed. If the device (column) is omitted from a μVM definition, a call to one of the [API Endpoints](#api-endpoints) will fail with a 400 - BadRequest - HTTP response.