DOC: Update client library CHANGELOG.md

Author: cjdsellers

CHANGELOG.md

@@ -1,99 +1,146 @@
 # Changelog
 
 ## 0.9.0 - 2023-06-13
+
+#### Enhancements
 - Added `Reconnect` methods to `LiveBlocking` and `LiveThreaded`
 - Added optional `exception_callback` argument to `LiveThreaded::Start` to improve
   error handling options
 - Added batch download support data files (`condition.json` and `symbology.json`)
 - Added support for logging warnings from Historical API
+- Relaxed 10 minute minimum request time range restriction
+
+#### Breaking changes
 - Changed `use_ts_out` default to `false`
+
+#### Bug fixes
 - Fixed missing definition for `operator==` for `ImbalanceMsg`
-- Removed 10 minute minimum request time range restriction
 
 ## 0.8.0 - 2023-05-16
+
+#### Enhancements
 - Changed `end` and `end_date` to optional to support new forward-fill behaviour
+
+#### Breaking changes
 - Renamed `booklevel` MBP field to `levels` for brevity and consistent naming
 - Removed `open_interest_qty` and `cleared_volume` fields from definitions schema
   that were always unset
 
 ## 0.7.0 - 2023-04-28
+
+#### Enhancements
 - Added initial support for live data with `LiveBlocking` and `LiveThreaded` clients
 - Added support for statistics schema
 - Added `SystemMsg` and `ErrorMsg` records for use in live data
 - Added `strike_price`, `strike_price_currency`, and `instrument_class` to `InstrumentDefMsg`
-- Renamed `BatchJob.cost` to `cost_usd` and value now expressed as US dollars
 - Added `FixedPx` helper class for formatting fixed prices
 - Added configurable log receiver `ILogReceiver`
 - Added `instrument_class`, `strike_price`, and `strike_price_currency` to definition schema
 - Added additional `condition` variants for `DatasetConditionDetail` (degraded, pending, missing)
 - Added additional member `last_modified_date` to `DatasetConditionDetail` Added `has_mixed_schema`, `has_mixed_stype_in`, and `ts_out` to `Metadata` to support live data
+- Added optional `compression` parameter to `BatchSubmitJob`
+
+#### Breaking changes
 - Removed `related` and `related_security_id` from `InstrumentDefMsg`
+- Renamed `BatchJob.cost` to `cost_usd` and value now expressed as US dollars
 - Renamed `SType::ProductId` to `SType::InstrumentId` and `SType::Native` to `SType::RawSymbol`
 - Renamed `RecordHeader::product_id` to `instrument_id`
 - Renamed `InstrumentDefMsg::symbol` to `raw_symbol`
 - Renamed `SymbolMapping::native_symbol` to `raw_symbol`
-- Deprecated `SType::Smart` to split into `SType::Parent` and `SType::Continuous`
 - Changed `expiration` and `action` type to `UnixNanos`
 - Changed some fields to enums in `InstrumentDefMsg`
-- Added optional `compression` parameter to `BatchSubmitJob`
+
+#### Deprecations
+- Deprecated `SType::Smart` to split into `SType::Parent` and `SType::Continuous`
+
+#### Bug fixes
 - Fixed parsing of `BatchSubmitJob` response
 - Fixed invalid read in `DbnDecoder`
 - Fixed memory leak in `TryCreateDir`
 
 ## 0.6.1 - 2023-03-28
-- Fixed Zstd decoding of files with multiple frames
+
+#### Breaking changes
 - Removed usage of unreliable `std::ifstream::readsome`
 
+#### Bug fixes
+- Fixed Zstd decoding of files with multiple frames
+
 ## 0.6.0 - 2023-03-24
+
+#### Enhancements
 - Added support for imbalance schema
 - Added support for decoding `ts_out` field
+- Added flags `kSnapshot` and `kMaybeBadBook`
+
+#### Breaking changes
 - Removed `record_count` from `Metadata`
 - Changed `Historical::BatchDownload` to return the paths of the downloaded files
-- Added flags `kSnapshot` and `kMaybeBadBook`
 
 ## 0.5.0 - 2023-03-13
+
+#### Enhancements
 - Added `Historical::MetadataGetDatasetRange`
+
+#### Breaking changes
 - Changed `MetadataGetDatasetCondition` to return `vector<DatasetConditionDetail>`
 - Removed `MetadataListCompressions` (redundant with docs)
 - Removed `MetadataListEncodings` (redundant with docs)
 - Removed optional `start` and `end` params from `MetadataListSchemas` (redundant)
 - Renamed `FileBento` to `DbnFileStore`
 
 ## 0.4.0 - 2023-03-02
-- Renamed DBZ to DBN
-  - Renamed `DbzParser` to `DbnDecoder`
-- Renamed `TimeseriesStream` to `TimeseriesGetRange`
-- Refactored rtypes
-  - Introduced separate rtypes for each OHLCV schema
+
+#### Enhancements
+
 - Added live gateway resolution
 - Added `SymbolMappingMsg` and `ErrorMsg` records
-- Improved API for `flags` record fields
 - Added `Action` and `Side` enums
-- Changed `kAllSymbols` representation
-- Fixed usage of as a system library
-- Removed `is_full_universe` and `is_example` fields from `BatchJob`
-- Disabled unit testing by default
-- Added `PKGBUILD` to demonstrate installation
-- Made `start_date` and `end_date` optional for
-  `Historical::MetadataGetDatasetCondition`
 - Added `available_start_date` and `available_end_date` to
   `DatasetConditionInfo`
+- Made `start_date` and `end_date` optional for
+  `Historical::MetadataGetDatasetCondition`
+- Improved API for `flags` record fields
+- Added `PKGBUILD` to demonstrate installation
+- Disabled unit testing by default
+
+#### Breaking changes
+- Removed `is_full_universe` and `is_example` fields from `BatchJob`
+- Refactored rtypes
+  - Introduced separate rtypes for each OHLCV schema
+- Renamed DBZ to DBN
+  - Renamed `DbzParser` to `DbnDecoder`
+- Renamed `TimeseriesStream` to `TimeseriesGetRange`
+- Changed `kAllSymbols` representation
+
+#### Bug fixes
+- Fixed usage of as a system library
 
 ## 0.3.0 - 2023-01-06
+
+#### Enhancements
 - Added support for definition schema
-- Fixed cancellation in `Historical::TimeseriesStream`
-- Fixed race condition in `Historical::TimeseriesStream` exception handling
-- Fixed gtest linker error on macOS
 - Added option for CMake to download gtest
-- Renamed `TickMsg` to `MboMsg`
-- Changed `flags` fields to unsigned
 - Updated `Flag` enum
+
+#### Breaking changes
 - Standardized getter method names to pascal case
 - Renamed `is_full_book` to `is_full_universe`
+- Renamed `TickMsg` to `MboMsg`
+- Changed `flags` fields to unsigned
+
+#### Bug fixes
+- Fixed cancellation in `Historical::TimeseriesStream`
+- Fixed race condition in `Historical::TimeseriesStream` exception handling
+- Fixed gtest linker error on macOS
 
 ## 0.2.0 - 2022-12-01
+
+#### Enhancements
 - Added `Historical::MetadataGetDatasetCondition`
 - Improved Zstd CMake integration
+
+#### Bug fixes
 - Fixed requesting all symbols for a dataset
 
 ## 0.1.0 - 2022-11-07