spec: rename StorageSize to HumanReadableByteCount

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>
opensearch-project · Sep 11, 2024 · d6e540c · d6e540c
1 parent f43249e
commit d6e540c
Show file tree

Hide file tree

Showing 14 changed files with 120 additions and 120 deletions.
diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -2385,7 +2385,7 @@ 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/ByteCount'

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -725,7 +725,7 @@ components:
             $ref: '#/components/schemas/NodeId'
     NodeId:
       type: string
-    StorageSize:
+    HumanReadableByteCount:
       type: string
       pattern: '\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)'
     ByteUnit:
@@ -931,7 +931,7 @@ components:
           description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         fields:
           type: object
           additionalProperties:
@@ -942,7 +942,7 @@ components:
       type: object
       properties:
         size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
       required:
@@ -969,7 +969,7 @@ components:
         evictions:
           type: number
         memory_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         memory_size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         fields:
@@ -982,7 +982,7 @@ components:
       type: object
       properties:
         memory_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         memory_size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
       required:
@@ -1005,7 +1005,7 @@ components:
           description: Total count of query cache hits across all shards assigned to selected nodes.
           type: number
         memory_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         memory_size_in_bytes:
           description: Total amount, in bytes, of memory used for the query cache across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
@@ -1075,19 +1075,19 @@ components:
       properties:
         failed:
           description: The number of bytes that failed to upload to the remote translog store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         failed_bytes:
           description: The number of bytes that failed to upload to the remote translog store.
           $ref: '#/components/schemas/ByteCount'
         started:
           description: The number of bytes successfully uploaded to the remote translog store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         started_bytes:
           description: The number of bytes successfully uploaded to the remote translog store.
           $ref: '#/components/schemas/ByteCount'
         succeeded:
           description: The number of bytes successfully uploaded to the remote translog store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         succeeded_bytes:
           description: The number of bytes successfully uploaded to the remote translog store.
           $ref: '#/components/schemas/ByteCount'
@@ -1129,19 +1129,19 @@ components:
       properties:
         failed:
           description: The number of bytes that failed to upload/upload to/from the remote segment store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         failed_bytes:
           description: The number of bytes that failed to upload/upload to/from the remote segment store.
           $ref: '#/components/schemas/ByteCount'
         started:
           description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         started_bytes:
           description: The number of bytes to upload/download to/from the remote segment store after the upload/download has started.
           $ref: '#/components/schemas/ByteCount'
         succeeded:
           description: The number of bytes successfully uploaded/downloaded to/from the remote segment store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         succeeded_bytes:
           description: The number of bytes successfully uploaded/downloaded to/from the remote segment store.
           $ref: '#/components/schemas/ByteCount'
@@ -1164,13 +1164,13 @@ components:
       properties:
         max:
           description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         max_bytes:
           description: The maximum amount of lag, in bytes, during the upload refresh between the remote segment store and the local store.
           $ref: '#/components/schemas/ByteCount'
         total:
           description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         total_bytes:
           description: The total number of bytes that lagged during the upload refresh between the remote segment store and the local store.
           $ref: '#/components/schemas/ByteCount'
@@ -1213,7 +1213,7 @@ components:
           description: Total number of segments across all shards assigned to selected nodes.
           type: number
         doc_values_memory:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         doc_values_memory_in_bytes:
           description: Total amount, in bytes, of memory used for doc values across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
@@ -1225,12 +1225,12 @@ components:
           additionalProperties:
             $ref: 'indices.stats.yaml#/components/schemas/ShardFileSizeInfo'
         fixed_bit_set:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         fixed_bit_set_memory_in_bytes:
           description: Total amount of memory, in bytes, used by fixed bit sets across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         index_writer_memory:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         index_writer_max_memory_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         index_writer_memory_in_bytes:
@@ -1241,43 +1241,43 @@ components:
           type: number
         memory:
           description: Total amount, of memory used for segments across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         memory_in_bytes:
           description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         norms_memory:
           description: Total amount of memory used for normalization factors across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         norms_memory_in_bytes:
           description: Total amount, in bytes, of memory used for normalization factors across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         points_memory:
           description: Total amount of memory used for points across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         points_memory_in_bytes:
           description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         stored_fields_memory:
           description: Total amount of memory used for stored fields across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         stored_fields_memory_in_bytes:
           description: Total amount, in bytes, of memory used for stored fields across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         terms_memory:
           description: Total amount of memory used for terms across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         terms_memory_in_bytes:
           description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         term_vectors_memory:
           description: Total amount of memory used for term vectors across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         term_vectors_memory_in_bytes:
           description: Total amount, in bytes, of memory used for term vectors across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         version_map_memory:
           description: Total amount of memory used by all version maps across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         version_map_memory_in_bytes:
           description: Total amount, in bytes, of memory used by all version maps across all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
@@ -1303,12 +1303,12 @@ components:
       type: object
       properties:
         size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         size_in_bytes:
           description: Total size, in bytes, of all shards assigned to selected nodes.
           $ref: '#/components/schemas/ByteCount'
         reserved:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         reserved_in_bytes:
           description: A prediction, in bytes, of how much larger the shard stores will eventually grow due to ongoing peer recoveries, restoring snapshots, and similar activities.
           $ref: '#/components/schemas/ByteCount'
@@ -1625,19 +1625,19 @@ components:
         current_docs:
           type: number
         current_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         current_size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         total:
           type: number
         total_auto_throttle:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         total_auto_throttle_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         total_docs:
           type: number
         total_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         total_size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         total_stopped_time:
@@ -1711,7 +1711,7 @@ components:
         hit_count:
           type: number
         memory_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         memory_size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         miss_count:
@@ -1834,13 +1834,13 @@ components:
         remote_store:
           $ref: '#/components/schemas/RemoteStoreTranslogStats'
         size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
         uncommitted_operations:
           type: number
         uncommitted_size:
-          $ref: '#/components/schemas/StorageSize'
+          $ref: '#/components/schemas/HumanReadableByteCount'
         uncommitted_size_in_bytes:
           $ref: '#/components/schemas/ByteCount'
       required:

diff --git a/spec/schemas/cat.segments.yaml b/spec/schemas/cat.segments.yaml
@@ -44,7 +44,7 @@ components:
             Also, OpenSearch creates extra deleted documents to internally track the recent history of operations on a shard.
           type: string
         size:
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         size.memory:
           type: string
         committed:

diff --git a/spec/schemas/cluster.allocation_explain.yaml b/spec/schemas/cluster.allocation_explain.yaml
@@ -49,7 +49,7 @@ components:
           additionalProperties:
             oneOf:
               - $ref: '_common.yaml#/components/schemas/ByteCount'
-              - $ref: '_common.yaml#/components/schemas/StorageSize'
+              - $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         shard_data_set_sizes:
           type: object
           additionalProperties:
@@ -86,15 +86,15 @@ components:
         path:
           type: string
         total:
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         total_bytes:
           $ref: '_common.yaml#/components/schemas/ByteCount'
         used:
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         used_bytes:
           $ref: '_common.yaml#/components/schemas/ByteCount'
         free:
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         free_bytes:
           $ref: '_common.yaml#/components/schemas/ByteCount'
         free_disk_percent:

diff --git a/spec/schemas/cluster.stats.yaml b/spec/schemas/cluster.stats.yaml
@@ -213,7 +213,7 @@ components:
           description: Total number of fields in all non-system indices, accounting for mapping deduplication.
           type: number
         total_deduplicated_mapping_size:
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         total_deduplicated_mapping_size_in_bytes:
           description: Total size of all mappings, in bytes, after deduplication and compression.
           $ref: '_common.yaml#/components/schemas/ByteCount'
@@ -401,7 +401,7 @@ components:
             Total number of bytes available to JVM in file stores across all selected nodes.
             Depending on operating system or process-level restrictions, this number may be less than `nodes.fs.free_in_byes`.
             This is the actual amount of free disk space the selected OpenSearch nodes can use.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         available_in_bytes:
           description: |-
             Total number of bytes available to JVM in file stores across all selected nodes.
@@ -410,19 +410,19 @@ components:
           $ref: '_common.yaml#/components/schemas/ByteCount'
         free:
           description: Total number of unallocated bytes in file stores across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         free_in_bytes:
           description: Total number of unallocated bytes in file stores across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'
         total:
           description: Total size, of all file stores across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         total_in_bytes:
           description: Total size, in bytes, of all file stores across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'
         cache_reserved:
           description: Total size, of all cache reserved across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
           x-version-added: '2.7'
         cache_reserved_in_bytes:
           description: Total size, in bytes, of all cache reserved across all selected nodes.
@@ -534,13 +534,13 @@ components:
       properties:
         heap_max:
           description: Maximum amount of memory available for use by the heap across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         heap_max_in_bytes:
           description: Maximum amount of memory, in bytes, available for use by the heap across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'
         heap_used:
           description: Memory currently in use by the heap across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         heap_used_in_bytes:
           description: Memory, in bytes, currently in use by the heap across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'
@@ -648,7 +648,7 @@ components:
           $ref: '_common.yaml#/components/schemas/ByteCount'
         free:
           description: Amount, in bytes, of free physical memory across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         free_in_bytes:
           description: Amount, in bytes, of free physical memory across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'
@@ -657,13 +657,13 @@ components:
           type: number
         total:
           description: Total amount of physical memory across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         total_in_bytes:
           description: Total amount, in bytes, of physical memory across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'
         used:
           description: Amount of physical memory in use across all selected nodes.
-          $ref: '_common.yaml#/components/schemas/StorageSize'
+          $ref: '_common.yaml#/components/schemas/HumanReadableByteCount'
         used_in_bytes:
           description: Amount, in bytes, of physical memory in use across all selected nodes.
           $ref: '_common.yaml#/components/schemas/ByteCount'