docs(openapi): provider better documentation for space endpoint param…

…eters (#921) * Trying to improve documentation * Update openapi.yaml Co-authored-by: Adam Uhlíř <[email protected]> Signed-off-by: Arnaud <[email protected]> * Update openapi.yaml Co-authored-by: Adam Uhlíř <[email protected]> Signed-off-by: Arnaud <[email protected]> * Update openapi.yaml Co-authored-by: Adam Uhlíř <[email protected]> Signed-off-by: Arnaud <[email protected]> --------- Signed-off-by: Arnaud <[email protected]> Co-authored-by: Adam Uhlíř <[email protected]>
codex-storage · Oct 8, 2024 · f02de34 · f02de34
1 parent 17f0988
commit f02de34
Showing 1 changed file with 3 additions and 3 deletions.
diff --git 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"