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.

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

Added Unit-Measurement #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@
- [Filtering](#filtering)
+ [Search](#search)
+ [Asynchronous Calls](#asynchronous-calls)
+ [Unit Measurement](#unit-measurement)
- [Memory](#memory)
- [Storage](#storage)
- [Data traffic](#data-traffic)
- [Bandwidth](#bandwidth)

This guide describes a set of API Design standards used at [LeaseWeb](https://www.leaseweb.com).
When designing a new API, it's important to respect the HTTP interaction patterns
Expand Down Expand Up @@ -374,4 +379,21 @@ HTTP/1.1 200 OK
Sometimes the job might be in a state that it cannot be canceled. In this case the response is a `403 Forbidden`.

### Purged jobs
Purging can be done automatically using internal methods or not done at all. A request to an already purged job will return a `404 Not Found` response.
Purging can be done automatically using internal methods or not done at all. A request to an already purged job will return a `404 Not Found` response.

## Unit Measurement
For displaying sizes and usage we use the following standard:

#### Memory
We use faktor 2. This means that 1GB memory == 1024 MB of memory == 1.073.741.824 bytes.

Choose a reason for hiding this comment

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

typo: factor


#### Storage
We use base 10 (GB). A lot of storage is provisioned in GiB.
Which means that 1GB of storage == 0,93132 GiB of storage == 1.000.000 bytes.

#### Data traffic
We use base 10 (GB). 1GB = 1.000.0000 bytes.

#### Bandwidth
We use bps. 1Mbps == 1000Kbps == 1.000.000 bps.
*NOTE: often bandwidth is measured in bytes/second, which means you need to multiply by 8.*