From d6e540ca01562c386cf84b826ec95983ea528a3c Mon Sep 17 00:00:00 2001 From: Jakob Hahn Date: Wed, 11 Sep 2024 11:34:38 +0200 Subject: [PATCH] spec: rename StorageSize to HumanReadableByteCount Signed-off-by: Jakob Hahn --- spec/namespaces/indices.yaml | 2 +- spec/schemas/_common.yaml | 64 +++++++------- spec/schemas/cat.segments.yaml | 2 +- spec/schemas/cluster.allocation_explain.yaml | 8 +- spec/schemas/cluster.stats.yaml | 20 ++--- spec/schemas/indices._common.yaml | 12 +-- spec/schemas/indices.data_streams_stats.yaml | 2 +- spec/schemas/indices.recovery.yaml | 8 +- spec/schemas/indices.rollover.yaml | 8 +- spec/schemas/indices.segments.yaml | 4 +- spec/schemas/indices.stats.yaml | 2 +- spec/schemas/nodes._common.yaml | 90 ++++++++++---------- spec/schemas/nodes.info.yaml | 16 ++-- spec/schemas/snapshot._common.yaml | 2 +- 14 files changed, 120 insertions(+), 120 deletions(-) diff --git a/spec/namespaces/indices.yaml b/spec/namespaces/indices.yaml index 4dcf6d396..b3cc12eb7 100644 --- 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 index 218ce6f49..9535014a0 100644 --- 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 index 177c74e40..b0a119457 100644 --- 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 index 09885eddb..55d93622d 100644 --- 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 index 96e970c3e..d1590c7f7 100644 --- 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' diff --git a/spec/schemas/indices._common.yaml b/spec/schemas/indices._common.yaml index ea02f12f8..90d6776d6 100644 --- a/spec/schemas/indices._common.yaml +++ b/spec/schemas/indices._common.yaml @@ -382,7 +382,7 @@ components: durability: $ref: '#/components/schemas/TranslogDurability' flush_threshold_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' retention: $ref: '#/components/schemas/TranslogRetention' TranslogDurability: @@ -394,7 +394,7 @@ components: type: object properties: size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' age: $ref: '_common.yaml#/components/schemas/Duration' SettingsQueryString: @@ -787,13 +787,13 @@ components: max_docs: type: number min_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' min_primary_shard_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_primary_shard_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' min_primary_shard_docs: type: number max_primary_shard_docs: diff --git a/spec/schemas/indices.data_streams_stats.yaml b/spec/schemas/indices.data_streams_stats.yaml index c4ae2504b..f8309bb2e 100644 --- a/spec/schemas/indices.data_streams_stats.yaml +++ b/spec/schemas/indices.data_streams_stats.yaml @@ -17,7 +17,7 @@ components: maximum_timestamp: $ref: '_common.yaml#/components/schemas/EpochTimeUnitMillis' store_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' store_size_bytes: description: Total size, in bytes, of all shards for the data stream's backing indices. $ref: '_common.yaml#/components/schemas/ByteCount' diff --git a/spec/schemas/indices.recovery.yaml b/spec/schemas/indices.recovery.yaml index 3e384573d..a4f6eaeec 100644 --- a/spec/schemas/indices.recovery.yaml +++ b/spec/schemas/indices.recovery.yaml @@ -95,19 +95,19 @@ components: percent: $ref: '_common.yaml#/components/schemas/Percentage' recovered: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' recovered_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' recovered_from_snapshot: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' recovered_from_snapshot_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' reused: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' reused_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' total: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' required: diff --git a/spec/schemas/indices.rollover.yaml b/spec/schemas/indices.rollover.yaml index 251d80d74..f78347fe4 100644 --- a/spec/schemas/indices.rollover.yaml +++ b/spec/schemas/indices.rollover.yaml @@ -20,19 +20,19 @@ components: max_docs: type: number max_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_size_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' min_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' min_size_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' max_primary_shard_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_primary_shard_size_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' min_primary_shard_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' min_primary_shard_size_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' max_primary_shard_docs: diff --git a/spec/schemas/indices.segments.yaml b/spec/schemas/indices.segments.yaml index 29490137a..ae2c62292 100644 --- a/spec/schemas/indices.segments.yaml +++ b/spec/schemas/indices.segments.yaml @@ -60,11 +60,11 @@ components: deleted_docs: type: integer size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' memory: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' memory_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' committed: diff --git a/spec/schemas/indices.stats.yaml b/spec/schemas/indices.stats.yaml index 849bcf649..b2391cddb 100644 --- a/spec/schemas/indices.stats.yaml +++ b/spec/schemas/indices.stats.yaml @@ -12,7 +12,7 @@ components: description: type: string size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' min_size_in_bytes: diff --git a/spec/schemas/nodes._common.yaml b/spec/schemas/nodes._common.yaml index c6a253c2d..51fb8b7cf 100644 --- a/spec/schemas/nodes._common.yaml +++ b/spec/schemas/nodes._common.yaml @@ -388,7 +388,7 @@ components: type: object properties: size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' evictions: @@ -428,13 +428,13 @@ components: properties: estimated_size: description: Estimated memory used for the operation. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' estimated_size_in_bytes: description: Estimated memory used, in bytes, for the operation. $ref: '_common.yaml#/components/schemas/ByteCount' limit_size: description: Memory limit for the circuit breaker. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' limit_size_in_bytes: description: Memory limit, in bytes, for the circuit breaker. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -466,14 +466,14 @@ components: properties: available: description: Total amount of disk space available to this Java virtual machine on this file store. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' available_in_bytes: description: Total number of bytes available to this Java virtual machine on this file store. $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: x-version-added: '2.7' description: Total number of cache bytes reserved available to this Java virtual machine on this file store. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' cache_reserved_in_bytes: x-version-added: '2.7' description: Total number of cache bytes reserved available to this Java virtual machine on this file store. @@ -483,18 +483,18 @@ components: disk_reads: type: number disk_read_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' disk_read_size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' disk_writes: type: number disk_write_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' disk_write_size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Total amount of unallocated disk space in the file store. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: description: Total number of unallocated bytes in the file store. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -506,7 +506,7 @@ components: type: string total: description: Total size of the file store. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: description: Total size of the file store in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -521,7 +521,7 @@ components: Total disk space available to this Java virtual machine on all file stores. Depending on OS or process level restrictions, this might appear less than `free`. This is the actual amount of free disk space the OpenSearch node can utilize. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' available_in_bytes: description: |- Total number of bytes available to this Java virtual machine on all file stores. @@ -530,20 +530,20 @@ components: $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Total unallocated disk space in all file stores. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: description: Total number of unallocated bytes in all file stores. $ref: '_common.yaml#/components/schemas/ByteCount' total: description: Total size of all file stores. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: description: Total size of all file stores in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' cache_reserved: x-version-added: '2.7' description: Total size of cache bytes reserved in all file stores. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' cache_reserved_in_bytes: x-version-added: '2.7' description: Total size of cache bytes reserved in all file stores. @@ -624,13 +624,13 @@ components: type: number total_capacity: description: Total capacity of buffer pools. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_capacity_in_bytes: description: Total capacity of buffer pools in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' used: description: Size of buffer pools. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: description: Size of buffer pools in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -671,7 +671,7 @@ components: properties: heap_used: description: Memory currently in use by the heap. - $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. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -680,25 +680,25 @@ components: type: number heap_committed: description: Amount of memory available for use by the heap. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_committed_in_bytes: description: Amount of memory, in bytes, available for use by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' heap_max: description: Maximum amount of memory available for use by the heap. - $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. $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_used: description: Non-heap memory used. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' non_heap_used_in_bytes: description: Non-heap memory used, in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_committed: description: Amount of non-heap memory available. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' non_heap_committed_in_bytes: description: Amount of non-heap memory available, in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -712,25 +712,25 @@ components: properties: used: description: Memory used by the heap. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: description: Memory, in bytes, used by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' max: description: Maximum amount of memory available for use by the heap. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_in_bytes: description: Maximum amount of memory, in bytes, available for use by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' peak_used: description: Largest amount of memory historically used by the heap. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' peak_used_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' peak_max: description: Largest amount of memory historically used by the heap. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' peak_max_in_bytes: description: Largest amount of memory, in bytes, historically used by the heap. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -741,11 +741,11 @@ components: type: object properties: used: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' max: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' usage_percent: @@ -813,32 +813,32 @@ components: Otherwise it reports the same value as `total_in_bytes`. $ref: '_common.yaml#/components/schemas/ByteCount' resident: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' resident_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' share: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' share_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' total_virtual: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_virtual_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' total: description: Total amount of physical memory. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: description: Total amount of physical memory in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' free: description: Amount of free physical memory. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' free_in_bytes: description: Amount of free physical memory in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' used: description: Amount of used physical memory. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' used_in_bytes: description: Amount of used physical memory in bytes. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -951,7 +951,7 @@ components: type: number rx_size: description: Size of RX packets received by the node during internal cluster communication. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' rx_size_in_bytes: description: Size, in bytes, of RX packets received by the node during internal cluster communication. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -963,7 +963,7 @@ components: type: number tx_size: description: Size of TX packets sent by the node during internal cluster communication. - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' tx_size_in_bytes: description: Size, in bytes, of TX packets sent by the node during internal cluster communication. $ref: '_common.yaml#/components/schemas/ByteCount' @@ -1096,11 +1096,11 @@ components: count: type: number uncompressed_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' uncompressed_size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' compressed_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' compressed_size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' ClusterAppliedStats: @@ -1179,15 +1179,15 @@ components: cancellation_count: type: number current_max: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' current_max_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' current_avg: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' current_avg_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' rolling_avg: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' rolling_avg_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats: @@ -1240,7 +1240,7 @@ components: type: object properties: limit: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' limit_in_bytes: description: |- Configured memory limit, in bytes, for the indexing requests. @@ -1254,29 +1254,29 @@ components: type: object properties: all: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' all_in_bytes: description: Memory consumed, in bytes, by indexing requests in the coordinating, primary, or replica stage. $ref: '_common.yaml#/components/schemas/ByteCount' combined_coordinating_and_primary: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' combined_coordinating_and_primary_in_bytes: description: |- Memory consumed, in bytes, by indexing requests in the coordinating or primary stage. This value is not the sum of coordinating and primary as a node can reuse the coordinating memory if the primary stage is executed locally. $ref: '_common.yaml#/components/schemas/ByteCount' coordinating: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' coordinating_in_bytes: description: Memory consumed, in bytes, by indexing requests in the coordinating stage. $ref: '_common.yaml#/components/schemas/ByteCount' primary: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' primary_in_bytes: description: Memory consumed, in bytes, by indexing requests in the primary stage. $ref: '_common.yaml#/components/schemas/ByteCount' replica: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' replica_in_bytes: description: Memory consumed, in bytes, by indexing requests in the replica stage. $ref: '_common.yaml#/components/schemas/ByteCount' diff --git a/spec/schemas/nodes.info.yaml b/spec/schemas/nodes.info.yaml index fa9708a90..2d27da447 100644 --- a/spec/schemas/nodes.info.yaml +++ b/spec/schemas/nodes.info.yaml @@ -115,7 +115,7 @@ components: items: type: string max_content_length: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' max_content_length_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' publish_address: @@ -170,23 +170,23 @@ components: type: object properties: direct_max: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' direct_max_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' heap_init: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_init_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' heap_max: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' heap_max_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_init: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' non_heap_init_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' non_heap_max: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' non_heap_max_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' required: @@ -251,7 +251,7 @@ components: type: object properties: cache_size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' cache_size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' cores_per_socket: @@ -279,7 +279,7 @@ components: type: object properties: total: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' total_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' required: diff --git a/spec/schemas/snapshot._common.yaml b/spec/schemas/snapshot._common.yaml index 4d39c4590..83c8a8d9c 100644 --- a/spec/schemas/snapshot._common.yaml +++ b/spec/schemas/snapshot._common.yaml @@ -89,7 +89,7 @@ components: shard_count: type: number size: - $ref: '_common.yaml#/components/schemas/StorageSize' + $ref: '_common.yaml#/components/schemas/HumanReadableByteCount' size_in_bytes: $ref: '_common.yaml#/components/schemas/ByteCount' max_segments_per_shard: