Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Tidy docs for Device API #4361

Closed
wants to merge 1 commit into from
Closed

Tidy docs for Device API #4361

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/device-api.md
View file
Open in desktop
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.
Comment on lines +3 to +4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no Device API. The Device-API means Device <-> API matrix.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. Good to know. The existing doc is confusing.


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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We prefer to use either microvm or uVM to describe VM. Adding third type of wording will only increase the confusion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's use microVM. The docs don't use “uVM” outside this page.

(μ is an abbreviation for micro, which is why I suggested it).

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