docs(openapi): provider better documentation for space endpoint parameters (#921)
* Trying to improve documentation * Update openapi.yaml Co-authored-by: Adam Uhlíř <adam@uhlir.dev> Signed-off-by: Arnaud <arno.deville@gmail.com> * Update openapi.yaml Co-authored-by: Adam Uhlíř <adam@uhlir.dev> Signed-off-by: Arnaud <arno.deville@gmail.com> * Update openapi.yaml Co-authored-by: Adam Uhlíř <adam@uhlir.dev> Signed-off-by: Arnaud <arno.deville@gmail.com> --------- Signed-off-by: Arnaud <arno.deville@gmail.com> Co-authored-by: Adam Uhlíř <adam@uhlir.dev>
This commit is contained in:
parent
17f0988fc7
commit
f02de34f77
|
@ -330,15 +330,15 @@ components:
|
||||||
quotaMaxBytes:
|
quotaMaxBytes:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: "Maximum storage space used by the node"
|
description: "Maximum storage space (in bytes) available for the node in Codex's local repository."
|
||||||
quotaUsedBytes:
|
quotaUsedBytes:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: "Amount of storage space currently in use"
|
description: "Amount of storage space (in bytes) currently used for storing files in Codex's local repository."
|
||||||
quotaReservedBytes:
|
quotaReservedBytes:
|
||||||
type: integer
|
type: integer
|
||||||
format: int64
|
format: int64
|
||||||
description: "Amount of storage space reserved"
|
description: "Amount of storage reserved (in bytes) in the Codex's local repository for future use when storage requests will be picked up and hosted by the node using node's availabilities. This does not include the storage currently in use."
|
||||||
|
|
||||||
servers:
|
servers:
|
||||||
- url: "http://localhost:8080/api/codex/v1"
|
- url: "http://localhost:8080/api/codex/v1"
|
||||||
|
|
Loading…
Reference in New Issue