spec: rename Bytes to ByteCount

Signed-off-by: Jakob Hahn <[email protected]>
opensearch-project · Sep 11, 2024 · f43249e · f43249e
1 parent 2226fe5
commit f43249e
Show file tree

Hide file tree

Showing 12 changed files with 135 additions and 134 deletions.
diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml
@@ -2388,7 +2388,7 @@ components:
                 $ref: '../schemas/_common.yaml#/components/schemas/StorageSize'
               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

diff --git a/spec/schemas/_common.yaml b/spec/schemas/_common.yaml
@@ -742,8 +742,9 @@ components:
         - pb
         - t
         - tb
-    Bytes:
+    ByteCount:
       type: integer
+      format: int64
     Percentage:
       oneOf:
         - type: string
@@ -928,7 +929,7 @@ components:
       properties:
         size_in_bytes:
           description: Total amount, in bytes, of memory used for completion across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         size:
           $ref: '#/components/schemas/StorageSize'
         fields:
@@ -943,7 +944,7 @@ components:
         size:
           $ref: '#/components/schemas/StorageSize'
         size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - size_in_bytes
     DocStats:
@@ -970,7 +971,7 @@ components:
         memory_size:
           $ref: '#/components/schemas/StorageSize'
         memory_size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         fields:
           type: object
           additionalProperties:
@@ -983,7 +984,7 @@ components:
         memory_size:
           $ref: '#/components/schemas/StorageSize'
         memory_size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - memory_size_in_bytes
     QueryCacheStats:
@@ -1007,7 +1008,7 @@ components:
           $ref: '#/components/schemas/StorageSize'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         miss_count:
           description: Total count of query cache misses across all shards assigned to selected nodes.
           type: number
@@ -1077,19 +1078,19 @@ components:
           $ref: '#/components/schemas/StorageSize'
         failed_bytes:
           description: The number of bytes that failed to upload to the remote translog store.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         started:
           description: The number of bytes successfully uploaded to the remote translog store.
           $ref: '#/components/schemas/StorageSize'
         started_bytes:
           description: The number of bytes successfully uploaded to the remote translog store.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         succeeded:
           description: The number of bytes successfully uploaded to the remote translog store.
           $ref: '#/components/schemas/StorageSize'
         succeeded_bytes:
           description: The number of bytes successfully uploaded to the remote translog store.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - failed_bytes
         - started_bytes
@@ -1131,19 +1132,19 @@ components:
           $ref: '#/components/schemas/StorageSize'
         failed_bytes:
           description: The number of bytes that failed to upload/upload to/from the remote segment store.
-          $ref: '#/components/schemas/Bytes'
+          $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'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         succeeded:
           description: The number of bytes successfully uploaded/downloaded to/from the remote segment store.
           $ref: '#/components/schemas/StorageSize'
         succeeded_bytes:
           description: The number of bytes successfully uploaded/downloaded to/from the remote segment store.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - failed_bytes
         - started_bytes
@@ -1166,13 +1167,13 @@ components:
           $ref: '#/components/schemas/StorageSize'
         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/Bytes'
+          $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'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - max_bytes
         - total_bytes
@@ -1196,11 +1197,11 @@ components:
       type: object
       properties:
         max_bytes_behind:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         max_replication_lag:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         total_bytes_behind:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - max_bytes_behind
         - max_replication_lag
@@ -1215,7 +1216,7 @@ components:
           $ref: '#/components/schemas/StorageSize'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         file_sizes:
           description: |-
             This object is not populated by the cluster stats API.
@@ -1227,14 +1228,14 @@ components:
           $ref: '#/components/schemas/StorageSize'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         index_writer_memory:
           $ref: '#/components/schemas/StorageSize'
         index_writer_max_memory_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         index_writer_memory_in_bytes:
           description: Total amount, in bytes, of memory used by all index writers across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         max_unsafe_auto_id_timestamp:
           description: Unix timestamp, in milliseconds, of the most recently retried indexing request.
           type: number
@@ -1243,43 +1244,43 @@ components:
           $ref: '#/components/schemas/StorageSize'
         memory_in_bytes:
           description: Total amount, in bytes, of memory used for segments across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/Bytes'
+          $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'
         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/Bytes'
+          $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'
         points_memory_in_bytes:
           description: Total amount, in bytes, of memory used for points across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/Bytes'
+          $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'
         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/Bytes'
+          $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'
         terms_memory_in_bytes:
           description: Total amount, in bytes, of memory used for terms across all shards assigned to selected nodes.
-          $ref: '#/components/schemas/Bytes'
+          $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'
         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/Bytes'
+          $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'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         remote_store:
           $ref: '#/components/schemas/RemoteStoreStats'
         segment_replication:
@@ -1305,12 +1306,12 @@ components:
           $ref: '#/components/schemas/StorageSize'
         size_in_bytes:
           description: Total size, in bytes, of all shards assigned to selected nodes.
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         reserved:
           $ref: '#/components/schemas/StorageSize'
         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/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - reserved_in_bytes
         - size_in_bytes
@@ -1626,19 +1627,19 @@ components:
         current_size:
           $ref: '#/components/schemas/StorageSize'
         current_size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         total:
           type: number
         total_auto_throttle:
           $ref: '#/components/schemas/StorageSize'
         total_auto_throttle_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         total_docs:
           type: number
         total_size:
           $ref: '#/components/schemas/StorageSize'
         total_size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         total_stopped_time:
           $ref: '#/components/schemas/Duration'
         total_stopped_time_in_millis:
@@ -1712,7 +1713,7 @@ components:
         memory_size:
           $ref: '#/components/schemas/StorageSize'
         memory_size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         miss_count:
           type: number
       required:
@@ -1835,13 +1836,13 @@ components:
         size:
           $ref: '#/components/schemas/StorageSize'
         size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
         uncommitted_operations:
           type: number
         uncommitted_size:
           $ref: '#/components/schemas/StorageSize'
         uncommitted_size_in_bytes:
-          $ref: '#/components/schemas/Bytes'
+          $ref: '#/components/schemas/ByteCount'
       required:
         - earliest_last_modified_age
         - operations

diff --git a/spec/schemas/cluster.allocation_explain.yaml b/spec/schemas/cluster.allocation_explain.yaml
@@ -48,7 +48,7 @@ components:
           type: object
           additionalProperties:
             oneOf:
-              - $ref: '_common.yaml#/components/schemas/Bytes'
+              - $ref: '_common.yaml#/components/schemas/ByteCount'
               - $ref: '_common.yaml#/components/schemas/StorageSize'
         shard_data_set_sizes:
           type: object
@@ -88,15 +88,15 @@ components:
         total:
           $ref: '_common.yaml#/components/schemas/StorageSize'
         total_bytes:
-          $ref: '_common.yaml#/components/schemas/Bytes'
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         used:
           $ref: '_common.yaml#/components/schemas/StorageSize'
         used_bytes:
-          $ref: '_common.yaml#/components/schemas/Bytes'
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         free:
           $ref: '_common.yaml#/components/schemas/StorageSize'
         free_bytes:
-          $ref: '_common.yaml#/components/schemas/Bytes'
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         free_disk_percent:
           type: number
         used_disk_percent:
@@ -188,7 +188,7 @@ components:
         in_sync:
           type: boolean
         matching_size_in_bytes:
-          $ref: '_common.yaml#/components/schemas/Bytes'
+          $ref: '_common.yaml#/components/schemas/ByteCount'
         matching_sync_id:
           type: boolean
         store_exception: