Skip to content

Commit

Permalink
Tidy docs for Device API
Browse files Browse the repository at this point in the history
Signed-off-by: Tim Bannister <tim@scalefactory.com>
  • Loading branch information
sftim committed Jan 12, 2024
1 parent a774e26 commit 5d099cf
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/device-api.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down

0 comments on commit 5d099cf

Please sign in to comment.