Adjust component for Human readable Bytes #552

Jakob3xD · 2024-09-04T16:12:08Z

Description

Add human parameter to some test
Add new component type for human readable bytes
Replace Component referenced to new types
Add missing fields

Issues Resolved

Related to #423
Closes #554

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2024-09-04T18:30:57Z

Changes Analysis

Commit SHA: 8e7c18d
Comparing To SHA: 0733e62

API Changes

Summary

├─┬Paths
│ ├─┬/_data_stream/_stats
│ │ └─┬GET
│ │   └─┬Responses
│ │     └─┬200
│ │       └─┬application/json
│ │         └─┬Schema
│ │           ├─┬total_store_size_bytes
│ │           │ └──[🔀] $ref (27990:13)❌ 
│ │           └─┬total_store_sizes
│ │             └──[🔀] $ref (29693:13)❌ 
│ └─┬/_data_stream/{name}/_stats
│   └─┬GET
│     └─┬Responses
│       └─┬200
│         └─┬application/json
│           └─┬Schema
│             ├─┬total_store_size_bytes
│             │ └──[🔀] $ref (27990:13)❌ 
│             └─┬total_store_sizes
│               └──[🔀] $ref (29693:13)❌ 
└─┬Components
  ├──[➖] schemas (28004:7)❌ 
  ├──[➕] schemas (29693:7)
  ├──[➕] schemas (29696:7)
  ├─┬nodes._common:DataPathStats
  │ ├──[➕] properties (47668:9)
  │ ├─┬cache_reserved_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬disk_read_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬available_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬disk_read_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬disk_write_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬disk_write_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬available
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬total
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬free_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:Transport
  │ ├─┬tx_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬tx_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬rx_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬rx_size
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬cluster.stats:ClusterJvm
  │ └──[➕] properties (43716:9)
  ├─┬nodes._common:LastGcStats
  │ ├──[➕] properties (48028:9)
  │ ├──[➕] properties (48024:9)
  │ ├─┬max_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬used_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:RequestCacheStats
  │ ├─┬memory_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬memory_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:JvmMemoryStats
  │ ├──[➕] properties (47976:9)
  │ ├──[➕] properties (47982:9)
  │ ├──[➕] properties (47967:9)
  │ ├──[➕] properties (47994:9)
  │ ├──[➕] properties (47988:9)
  │ ├─┬heap_committed_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬non_heap_committed_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬heap_used_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬heap_max_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬non_heap_used_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:SegmentReplicationStats
  │ ├─┬max_bytes_behind
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬max_replication_lag
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬total_bytes_behind
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:RequestStats
  │ └──[➕] properties (29263:9)
  ├─┬cat.segments:SegmentsRecord
  │ ├─┬size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬size.memory
  │   └──[🔀] $ref (42230:11)❌ 
  ├─┬nodes._common:PressureMemory
  │ ├─┬coordinating
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬combined_coordinating_and_primary
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬all_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬primary_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬all
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬primary
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬replica_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬replica
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬combined_coordinating_and_primary_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬coordinating_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cluster.stats:IndicesVersions
  │ └─┬total_primary_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cluster.allocation_explain:AllocationStore
  │ └─┬matching_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬indices._common:DataStreamLifecycleRolloverConditions
  │ ├─┬min_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬max_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬max_primary_shard_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬min_primary_shard_size
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬_common:GetStats
  │ ├──[➕] properties (28404:9)
  │ └──[➖] properties (28420:9)❌ 
  ├─┬nodes.info:NodeInfoOSCPU
  │ ├─┬cache_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬cache_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬snapshot._common:ShardsStatsSummaryItem
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:QueryCacheStats
  │ ├─┬memory_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬memory_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:ShardCacheStats
  │ ├──[➕] properties (48321:9)
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cluster.stats:FieldTypesMappings
  │ ├─┬total_deduplicated_mapping_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬total_deduplicated_mapping_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:IngestTotal
  │ └──[➕] properties (47880:9)
  ├─┬indices.stats:ShardFileSizeInfo
  │ ├──[➕] properties (46117:9)
  │ ├─┬average_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬min_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬max_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬indices.segments:Segment
  │ ├──[➕] properties (45875:9)
  │ ├──[➕] properties (45877:9)
  │ ├──[➕] properties (45871:9)
  │ ├─┬deleted_docs
  │ │ └──[🔀] type (45870:17)❌ 
  │ ├─┬num_docs
  │ │ └──[🔀] type (45868:17)❌ 
  │ ├─┬generation
  │ │ └──[🔀] type (45866:17)❌ 
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:ShardSearchBackpressureTaskResourceTrackerCpuUsageTrackerStats
  │ ├──[➕] properties (48417:9)
  │ └──[➕] properties (48413:9)
  ├─┬cluster.stats:ClusterFileSystem
  │ ├──[➕] properties (43598:9)
  │ ├──[➕] properties (43622:9)
  │ ├──[➕] properties (43610:9)
  │ ├──[➕] properties (43616:9)
  │ ├─┬total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬available_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬cache_reserved_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:StoreStats
  │ ├─┬reserved
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬reserved_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:ShardSearchBackpressureTaskResourceTrackerElapsedTimeTrackerStats
  │ ├──[➕] properties (48430:9)
  │ └──[➕] properties (48426:9)
  ├─┬indices.data_streams_stats:DataStreamsStatsItem
  │ ├─┬store_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬store_size_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cluster.allocation_explain:DiskUsage
  │ ├──[➕] properties (43029:9)
  │ ├──[➕] properties (43021:9)
  │ ├──[➕] properties (43025:9)
  │ ├─┬total_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬used_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬indices.rollover:RolloverConditions
  │ ├─┬min_size_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬min_primary_shard_size_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬max_primary_shard_size_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬min_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬min_primary_shard_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬max_size_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬max_primary_shard_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬max_size
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬cluster.stats:IndexingPressureMemory
  │ └─┬limit_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:ThreadCount
  │ └──[➕] properties (48632:9)
  ├─┬cat.nodes:NodesRecord
  │ ├─┬disk.avail
  │ │ └──[🔀] $ref (41801:11)❌ 
  │ ├─┬disk.used
  │ │ └──[🔀] $ref (41799:11)❌ 
  │ └─┬disk.total
  │   └──[🔀] $ref (41797:11)❌ 
  ├─┬_common:SegmentsStats
  │ ├──[➕] properties (29542:9)
  │ ├──[➖] properties (29518:9)❌ 
  │ ├──[➕] properties (29554:9)
  │ ├──[➖] properties (29528:9)❌ 
  │ ├─┬term_vectors_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬index_writer_memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬version_map_memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬points_memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬fixed_bit_set
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬stored_fields_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬norms_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬terms_memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬terms_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬index_writer_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬version_map_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬points_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬fixed_bit_set_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬norms_memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬doc_values_memory
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬index_writer_max_memory_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬doc_values_memory_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:SerializedClusterStateDetail
  │ ├─┬compressed_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬uncompressed_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬compressed_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬uncompressed_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:ShardSearchPipelineTotalStats
  │ └──[➕] properties (48484:9)
  ├─┬_common:FieldMemoryUsage
  │ ├─┬memory_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬memory_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬snapshot._common:IndexDetails
  │ ├─┬size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬snapshot._common:FileCountSnapshotStats
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:FieldSizeUsage
  │ ├─┬size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cat.allocation:AllocationRecord
  │ ├─┬disk.avail
  │ │ ├──[➕] type (40910:13)❌ 
  │ │ ├──[➖] anyOf (40866:15)❌ 
  │ │ └──[➖] anyOf (28004:7)❌ 
  │ ├─┬disk.indices
  │ │ ├──[➕] type (40893:13)❌ 
  │ │ ├──[➖] anyOf (40849:15)❌ 
  │ │ └──[➖] anyOf (28004:7)❌ 
  │ ├─┬disk.total
  │ │ ├──[➕] type (40915:13)❌ 
  │ │ ├──[➖] anyOf (40871:15)❌ 
  │ │ └──[➖] anyOf (28004:7)❌ 
  │ └─┬disk.used
  │   ├──[➕] type (40902:13)❌ 
  │   ├──[➖] anyOf (40858:15)❌ 
  │   └──[➖] anyOf (28004:7)❌ 
  ├─┬cluster.allocation_explain:ClusterInfo
  │ └─┬shard_sizes
  │   └─┬Schema
  │     ├──[➖] type (42919:19)❌ 
  │     ├──[➕] oneOf (27990:7)
  │     └──[➕] oneOf (29693:7)
  ├─┬nodes._common:Pool
  │ ├──[➕] properties (48130:9)
  │ ├──[➕] properties (48142:9)
  │ ├──[➕] properties (48136:9)
  │ ├──[➕] properties (48124:9)
  │ ├─┬used_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬max_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬peak_used_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬peak_max_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cluster.stats:IndexingPressureMemorySummary
  │ ├─┬combined_coordinating_and_primary_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬all_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬replica_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬coordinating_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬primary_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes.info:NodeInfoMemory
  │ ├─┬total
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬total_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:FielddataStats
  │ ├─┬memory_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬memory_size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:TranslogStats
  │ ├─┬uncommitted_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬uncommitted_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:RemoteStoreTranslogUploadTotalUploadSizeStats
  │ ├──[➕] properties (29121:9)
  │ ├──[➕] properties (29127:9)
  │ ├──[➕] properties (29133:9)
  │ ├─┬failed_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬started_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬succeeded_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:MemoryStats
  │ ├──[➕] properties (48060:9)
  │ ├──[➕] properties (48054:9)
  │ ├──[➕] properties (48066:9)
  │ ├─┬resident
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬adjusted_total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬total_virtual_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬share_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬total_virtual
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬resident_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬share
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬used_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:MergesStats
  │ ├─┬total_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬total_auto_throttle_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬current_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬total_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬current_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬total_auto_throttle
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬_common:RemoteStoreUploadRefreshSizeLagStats
  │ ├──[➕] properties (29199:9)
  │ ├──[➕] properties (29205:9)
  │ ├─┬max_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬total_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:ShardSearchBackpressureTaskResourceTrackerHeapUsageTrackerStats
  │ ├──[➕] properties (48443:9)
  │ ├──[➕] properties (48439:9)
  │ ├──[➕] properties (48447:9)
  │ ├─┬current_max_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬rolling_avg_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬current_avg_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes.info:NodeInfo
  │ └─┬total_indexing_buffer_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:Breaker
  │ ├─┬estimated_size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬limit_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬estimated_size_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬limit_size
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬nodes.info:NodeInfoJvmMemory
  │ ├─┬direct_max
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬non_heap_init_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬heap_max
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬heap_max_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬heap_init_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬non_heap_max_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬non_heap_init
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬direct_max_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬non_heap_max
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬heap_init
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬indices.recovery:RecoveryBytes
  │ ├─┬reused
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬reused_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬total
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬recovered
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬recovered_from_snapshot
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬recovered_from_snapshot_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬recovered_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes.info:NodeInfoHttp
  │ ├─┬max_content_length
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬max_content_length_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬cluster.stats:OperatingSystemMemoryInfo
  │ ├──[➕] properties (44176:9)
  │ ├──[➕] properties (44185:9)
  │ ├──[➕] properties (44191:9)
  │ ├─┬total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬used_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬adjusted_total_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬nodes._common:Client
  │ └─┬request_size_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:RemoteStoreUploadStats
  │ ├──[➕] properties (29218:9)
  │ └──[➕] properties (29228:9)
  ├─┬nodes._common:IndexingPressureMemory
  │ ├─┬limit
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬limit_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬_common:Bytes
  │ ├──[➖] enum (27995:11)❌ 
  │ ├──[➖] enum (27996:11)❌ 
  │ ├──[➖] enum (27999:11)❌ 
  │ ├──[➖] enum (28001:11)❌ 
  │ ├──[➖] enum (28002:11)❌ 
  │ ├──[➖] enum (27992:11)❌ 
  │ ├──[➖] enum (27993:11)❌ 
  │ ├──[➖] enum (27994:11)❌ 
  │ ├──[➖] enum (27997:11)❌ 
  │ ├──[➖] enum (27998:11)❌ 
  │ ├──[➖] enum (28000:11)❌ 
  │ └──[🔀] type (27990:13)❌ 
  ├─┬nodes._common:NodeBufferPool
  │ ├─┬total_capacity_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬total_capacity
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬used_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬used
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬_common:RemoteStoreUploadDownloadStats
  │ ├──[➕] properties (29164:9)
  │ ├──[➕] properties (29170:9)
  │ ├──[➕] properties (29176:9)
  │ ├─┬failed_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬started_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬succeeded_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬indices._common:Translog
  │ └─┬flush_threshold_size
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬nodes._common:FileSystemTotal
  │ ├──[➕] properties (47788:9)
  │ ├─┬available_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬cache_reserved_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬free_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ ├─┬available
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ ├─┬total_in_bytes
  │ │ └──[🔀] $ref (27990:13)❌ 
  │ └─┬total
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬_common:RefreshStats
  │ └──[➕] properties (29045:9)
  ├─┬_common:CompletionStats
  │ ├─┬size
  │ │ └──[🔀] $ref (29693:13)❌ 
  │ └─┬size_in_bytes
  │   └──[🔀] $ref (27990:13)❌ 
  ├─┬indices._common:TranslogRetention
  │ └─┬size
  │   └──[🔀] $ref (29693:13)❌ 
  ├─┬_common:RemoteStoreDownloadStats
  │ └──[➕] properties (29079:9)
  └─┬cluster.stats:ClusterJvmMemory
    ├──[➕] properties (43738:9)
    ├──[➕] properties (43744:9)
    ├─┬heap_max_in_bytes
    │ └──[🔀] $ref (27990:13)❌ 
    └─┬heap_used_in_bytes
      └──[🔀] $ref (27990:13)❌

Document Element	Total Changes	Breaking Changes
paths	4	4
components	302	238

❌ BREAKING Changes: 242 out of 306
Modifications: 214
Removals: 24
Additions: 68
Breaking Removals: 24
Breaking Modifications: 214
Breaking Additions: 4

Report

The full API changes report is available at: https://github.com/opensearch-project/opensearch-api-specification/actions/runs/10722709973/artifacts/1897111192

API Coverage

	Before	After	Δ
Covered (%)	533 (52.2 %)	533 (52.2 %)	0 (0 %)
Uncovered (%)	488 (47.8 %)	488 (47.8 %)	0 (0 %)
Unknown	26	26	0

expand_wildcards none with all Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

…nent Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

github-actions · 2024-09-05T14:04:41Z

Spec Test Coverage Analysis

Total	Tested
559	267 (47.76 %)

dblock

Typo in CHANGELOG, thanks!

CHANGELOG.md

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

dblock · 2024-09-05T15:53:02Z

I have a fix for the flaky routing test in #556

Xtansia · 2024-09-05T21:20:18Z

spec/schemas/_common.yaml

+    StorageSize:
+      type: string
+      pattern: '\d+(\.\d+)?(b|kb|k|mb|m|gb|g|tb|t|pb|p)'
+    StorageType:


This naming does not make sense to me. The name would imply this is types of storage (cold, warm, hdd, etc). When in actuality this is byte units.

What would you prefer? My suggestion would be BytesUnit ?

I think that's reasonable as we do have other ...Unit enums.

Xtansia · 2024-09-05T21:21:07Z

spec/schemas/_common.yaml

@@ -686,7 +686,10 @@ components:
            $ref: '#/components/schemas/NodeId'
    NodeId:
      type: string
-    Bytes:
+    StorageSize:


Related to my comment on StorageType, this doesn't seem accurate to me, not all things measured in bytes are storage.

What would you prefer? My suggestion would be BytesHuman or BytesString ?

I feel BytesString could be mis-interpreted as some mechanism for encoding raw-bytes as a string (ie. a hex/base64 string). Which also kind of applies to Bytes on it's own too.

Maybe a more verbose ByteCount and HumanReadableByteCount would make sense?

cc: @dblock @nhtruong ^^

The original Elastic docs call these "human-formatted", so I think we could use that term, HumanFormattedBytes, or since these appear a lot in the CAT API, which is "compact and aligned text", we could use BytesText. WDYT?

Just as a side note for CAT API.
Due to the bytes parameter the content differ. Without bytes parameter it would be printed as "1gb" and with it as "1024". So it would not match the StorageSize. We would need an extra Type where the unit suffix is optional.

The type can have a anyOf: with different configurations, one of which is a string with all numbers?

Xtansia · 2024-09-05T21:22:00Z

spec/schemas/_common.yaml

-        - type: number
-        - type: string
+    Bytes:
+      type: integer


This probably should have had a format: int64 as well

Jakob3xD force-pushed the jh-human branch from b7c284b to f5eec25 Compare September 4, 2024 16:14

Jakob3xD added 2 commits September 5, 2024 14:24

tests/default: add human paramete to some tests, repalce

6fbf47b

expand_wildcards none with all Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

spec: replace Bytes component with StorageType, add StorageSize compo…

f1e6392

…nent Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

Jakob3xD force-pushed the jh-human branch from f5eec25 to ebf0811 Compare September 5, 2024 12:24

Jakob3xD marked this pull request as ready for review September 5, 2024 12:52

Jakob3xD requested review from dblock, harshavamsi, sachetalva, nhtruong, Xtansia, VachaShah, Tokesh and aabeshov as code owners September 5, 2024 12:52

dblock requested changes Sep 5, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

CHANGELOG.md Outdated Show resolved Hide resolved

Jakob3xD added 2 commits September 5, 2024 16:44

add changelog

9ff0e8c

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

tests/routing: Fix reroute test

8e7c18d

Signed-off-by: Jakob Hahn <jakob.hahn@hetzner.com>

Jakob3xD force-pushed the jh-human branch from f9c462b to 8e7c18d Compare September 5, 2024 14:44

dblock approved these changes Sep 5, 2024

View reviewed changes

dblock merged commit 62e21f0 into opensearch-project:main Sep 5, 2024
17 checks passed

Xtansia reviewed Sep 5, 2024

View reviewed changes

Jakob3xD deleted the jh-human branch September 6, 2024 06:40

This was referenced Sep 10, 2024

[FEATURE] Generate API code from OpenSearch API Spec opensearch-project/opensearch-go#284

Open

Rename Bytes Components #569

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adjust component for Human readable Bytes #552

Adjust component for Human readable Bytes #552

Jakob3xD commented Sep 4, 2024 •

edited

Loading

github-actions bot commented Sep 4, 2024 •

edited

Loading

github-actions bot commented Sep 5, 2024

dblock left a comment

dblock commented Sep 5, 2024

Xtansia Sep 5, 2024

Jakob3xD Sep 6, 2024

Xtansia Sep 7, 2024

Xtansia Sep 5, 2024

Jakob3xD Sep 6, 2024

Xtansia Sep 7, 2024

Xtansia Sep 7, 2024

dblock Sep 7, 2024

Jakob3xD Sep 9, 2024

dblock Sep 9, 2024

Xtansia Sep 5, 2024

Adjust component for Human readable Bytes #552

Adjust component for Human readable Bytes #552

Conversation

Jakob3xD commented Sep 4, 2024 • edited Loading

Description

Issues Resolved

github-actions bot commented Sep 4, 2024 • edited Loading

Changes Analysis

API Changes

Summary

Report

API Coverage

github-actions bot commented Sep 5, 2024

Spec Test Coverage Analysis

dblock left a comment

Choose a reason for hiding this comment

dblock commented Sep 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jakob3xD commented Sep 4, 2024 •

edited

Loading

github-actions bot commented Sep 4, 2024 •

edited

Loading