From f02de34f772beaa9ada92a655167a4750ec5d59f Mon Sep 17 00:00:00 2001 From: Arnaud Date: Tue, 8 Oct 2024 08:37:10 +0200 Subject: [PATCH] docs(openapi): provider better documentation for space endpoint parameters (#921) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Trying to improve documentation * Update openapi.yaml Co-authored-by: Adam Uhlíř Signed-off-by: Arnaud * Update openapi.yaml Co-authored-by: Adam Uhlíř Signed-off-by: Arnaud * Update openapi.yaml Co-authored-by: Adam Uhlíř Signed-off-by: Arnaud --------- Signed-off-by: Arnaud Co-authored-by: Adam Uhlíř --- openapi.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index d29799a5..e34c8b10 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -330,15 +330,15 @@ components: quotaMaxBytes: type: integer 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: type: integer 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: type: integer 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: - url: "http://localhost:8080/api/codex/v1"