Rename Bytes Components (#569)

* spec: Rename StorageType to ByteUnit Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> * spec: rename Bytes to ByteCount Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> * spec: rename StorageSize to HumanReadableByteCount Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com> --------- Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>
opensearch-project · Sep 11, 2024 · 508c210 · 508c210
1 parent d05ba73
commit 508c210
Show file tree

Hide file tree

Showing 15 changed files with 266 additions and 265 deletions.
diff --git a/spec/namespaces/cat.yaml b/spec/namespaces/cat.yaml
@@ -1105,7 +1105,7 @@ components:
       in: query
       description: The unit in which to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
     cat.all_pit_segments::query.format:
       name: format
       in: query
@@ -1164,7 +1164,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.allocation::query.cluster_manager_timeout:
       name: cluster_manager_timeout
@@ -1374,7 +1374,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.fielddata::query.fields:
       in: query
@@ -1503,7 +1503,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.indices::query.cluster_manager_timeout:
       name: cluster_manager_timeout
@@ -1754,7 +1754,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.nodes::query.cluster_manager_timeout:
       name: cluster_manager_timeout
@@ -1924,7 +1924,7 @@ components:
       in: query
       description: The unit in which to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
     cat.pit_segments::query.format:
       name: format
       in: query
@@ -2062,7 +2062,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.recovery::query.detailed:
       in: query
@@ -2233,7 +2233,7 @@ components:
       in: query
       description: The unit in which to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
     cat.segment_replication::query.completed_only:
       name: completed_only
       in: query
@@ -2365,7 +2365,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.segments::query.cluster_manager_timeout:
       name: cluster_manager_timeout
@@ -2444,7 +2444,7 @@ components:
       name: bytes
       description: The unit used to display byte values.
       schema:
-        $ref: '../schemas/_common.yaml#/components/schemas/StorageType'
+        $ref: '../schemas/_common.yaml#/components/schemas/ByteUnit'
       style: form
     cat.shards::query.cluster_manager_timeout:
       name: cluster_manager_timeout

diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -2385,10 +2385,10 @@ components:
                 items:
                   $ref: '../schemas/indices.data_streams_stats.yaml#/components/schemas/DataStreamsStatsItem'
               total_store_sizes:
-                $ref: '../schemas/_common.yaml#/components/schemas/StorageSize'
+                $ref: '../schemas/_common.yaml#/components/schemas/HumanReadableByteCount'
               total_store_size_bytes:
                 description: Total size, in bytes, of all shards for the selected data streams.
-                $ref: '../schemas/_common.yaml#/components/schemas/Bytes'
+                $ref: '../schemas/_common.yaml#/components/schemas/ByteCount'
             required:
               - _shards
               - backing_indices