Changelog: Rephrase to move related entities closer together. (#1874)

* Move changelog entry to correct place

* Reformat breaking changes

* New feature in the right place

* body_stream.hpp

* Backtick

* Add changes made for Context

* More updates

* More updates

Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>

sdk/core/azure-core/CHANGELOG.md

@@ -4,63 +4,67 @@
 
 ### New Features
 
-- Added `HttpPolicyOrder` for adding custom Http policies to sdk clients.
+- Added `HttpPolicyOrder` for adding custom Http policies to SDK clients.
+- Added `Azure::Core::Operation<T>::GetRawResponse()`.
+- Added `Azure::Core::PackageVersion`.
+- Added support for logging to console when `AZURE_LOG_LEVEL` environment variable is set.
 
 ### Breaking Changes
 
-- Removed `Azure::Core::Http::HttpPipeline` by making it internal, used only within the SDK.
-- Split `Azure::Core::RequestConditions` into `Azure::MatchConditions` and `Azure::ModifiedConditions`.
-- Removed `TransportKind` enum from `Azure::Core::Http`.
-- Added `Azure::Core::Operation<T>::GetRawResponse().`
-- Renamed `NoRevoke` to `EnableCertificateRevocationListCheck` for `Azure::Core::Http::CurlTransportSSLOptions`.
-- Renamed `GetString()` to `ToString()` in `Azure::Core::DateTime`.
-- Renamed `GetUuidString()` to `ToString()` in `Azure::Core::Uuid`.
-- Renamed `Azure::Core::Details::Version` to `Azure::Core::PackageVersion`.
-- Moved `BodyStream` and its derived types from `Azure::Core::Http` namespace to `Azure::Core::IO`, and moved the `body_stream.hpp` header from `azure/core/http` to `azure/core/io`.
-- Moved `NullBodyStream` to internal usage only. It is not meant for public use.
-- Removed `LimitBodyStream`.
-- Renamed `AddHeader()` from `Request` and `RawResponse` to `SetHeader()`.
-- Introduced `Azure::Core::CaseInsensitiveMap` which is now used to store headers in `Azure::Core::Http::Request` and `Azure::Core::Http::RawResponse`.
-- Renamed `TransportPolicyOptions` to `TransportOptions`.
-- Renamed `TelemetryPolicyOptions` to `TelemetryOptions`.
-- Renamed `ValuePolicyOptions` to `ValueOptions`.
-- Removed `StartTry()` from `Azure::Core::Http::Request`.
-- Move `Azure::Core::Context` to be the last parameter for consistency, instead of first in various azure-core types. For example:
-  - `BodyStream::Read(uint8_t* buffer, int64_t count, Azure::Core::Context const& context)`
-  - `BodyStream::ReadToEnd(BodyStream& body, Azure::Core::Context const& context)`
-  - `HttpPolicy::Send(Request& request, NextHttpPolicy policy, Azure::Core::Context const& context)`
-  - `Operation<T>::PollUntilDone(std::chrono::milliseconds period, Azure::Core::Context& context)`
-  - `TokenCredential::GetToken(Http::TokenRequestOptions const& tokenRequestOptions, Azure::Core::Context const& context)`
-- Changed type of `Azure::Core::Http::RetryOptions::StatusCodes` from `std::vector` to `std::set`.
-- Renamed `Azure::Core::Http::LoggingPolicy` to `LogPolicy`.
-- Introduced `Azure::Core::Http::Policies::LogOptions`, a mandatory parameter for `LogPolicy` construction. Entities that are not specified in the allow lists are hidden in the log.
-- Changed the static methods `BodyStream::ReadToCount()` and `BodyStream::ReadToEnd()` into instance methods.
-- Moved `Azure::Core::Logging` namespace entities to `Azure::Core::Diagnostics::Logger` class.
-- Removed `Azure::Core::DateTime::GetRfc3339String()`: `Azure::Core::DateTime::ToString()` was extended to provide the same functionality.
-- Changed the constructor of `Azure::IO::FileBodyStream` to accept a file name directly and take ownership of opening/closing the file, instead of accepting a file descriptor, offset, and length.
-- Renamed the `Range` type to `HttpRange` within the `Azure::Core::Http` namespace.
-- Removed `Azure::Core::Http::InvalidHeaderException` and throw `std::invalid_argument` if the user provides invalid header arguments.
-- Moved the `Base64Encode()` and `Base64Decode()` functions to be static members of a `Convert` class within the `Azure::Core` namespace.
-- Moved `Azure::Core::Response<T>` to `Azure::Response<T>`.
-- Moved `Azure::Core::ETag` to `Azure::ETag`.
-- Moved `Azure::Core::DateTime` to `Azure::DateTime`.
-- Moved `Azure::Core::Nullable<T>` to `Azure::Nullable<T>`.
-- Renamed `Azure::Core::Http::TokenRequestOptions` to `Azure::Core::Credentials::TokenRequestContext`.
-- Moved `AccessToken`, `TokenCredential`, and `AuthenticationException` from `Azure::Core` to `Azure::Core::Credentials` namespace.
-- Moved the Http policies from `Azure::Core::Http` to `Azure::Core::Http::Policies`.
-- Moved `Azure::Core::Http::Url` to `Azure::Core::Url`.
-- Renamed `azure/core/credentials.hpp` to `azure/core/credentials/credentials.hpp`
-- Renamed `azure/core/logger.hpp` to `azure/core/diagnostics/logger.hpp`
-- Renamed `azure/core/http/policy.hpp` to `azure/core/http/policies/policy.hpp`
-- Renamed `azure/core/http/curl/curl.hpp` to `azure/core/http/curl_transport.hpp`
-- Renamed `azure/core/http/winhttp/win_http_client.hpp` to `azure/core/http/win_http_transport.hpp`
-- Changed return type from `std::unique_ptr<RawResponse>Operation::Poll()` to `RawResponse const& Operation::Poll()`.
+- Changes to `Azure::Core` namespace:
+  - Removed Response<void>, `ValueBase`, and `ContextValue`.
+  - Removed `Context::operator[]`, `Get()` introduced instead.
+  - Renamed `Uuid::GetUuidString()` to `ToString()`.
+  - Changed return type of `Operation<T>::Poll()` from `std::unique_ptr<RawResponse>` to `RawResponse const&`.
+  - Moved `GetApplicationContext()` to `Context::GetApplicationContext()`
+  - Moved the `Base64Encode()` and `Base64Decode()` functions to be static members of a `Convert` class.
+  - Moved `Logging` namespace entities to `Diagnostics::Logger` class.
+  - Moved `AccessToken`, `TokenCredential`, and `AuthenticationException` to `Credentials` namespace.
+  - Moved `Context` to be the last parameter for consistency, instead of first in various azure-core types. For example:
+    - `BodyStream::Read(uint8_t* buffer, int64_t count, Context const& context)`
+    - `BodyStream::ReadToEnd(BodyStream& body, Context const& context)`
+    - `HttpPolicy::Send(Request& request, NextHttpPolicy policy, Context const& context)`
+    - `Operation<T>::PollUntilDone(std::chrono::milliseconds period, Context& context)`
+    - `TokenCredential::GetToken(Http::TokenRequestOptions const& tokenRequestOptions, Context const& context)`
+  - Moved from `Azure::Core` to `Azure` namespace:
+    - `Response<T>`, `ETag`, and `Nullable<T>`.
+    - Split `RequestConditions` into `MatchConditions` and `ModifiedConditions`.
+    - Renamed `DateTime::GetString()` to `ToString()`, and removed `DateTime::GetRfc3339String()`.
+- Changes to `Azure::Core::Http` namespace:
+  - Removed `HttpPipeline`, `TransportKind`, `NullBodyStream`, and `LimitBodyStream`.
+  - Removed `Request::StartTry()`.
+  - Removed `InvalidHeaderException` and throw `std::invalid_argument` if the user provides invalid header arguments.
+  - Renamed `CurlTransportSSLOptions::NoRevoke` to `EnableCertificateRevocationListCheck`.
+  - Renamed `Range` to `HttpRange`.
+  - Renamed `TokenRequestOptions` to `TokenRequestContext`, and moved it to `Azure::Core::Credentials` namespace.
+  - Moved `Url` to `Azure::Core` namespace.
+  - `Request` and `RawResponse`:
+    - Renamed `AddHeader()` to `SetHeader()`.
+    - Introduced `Azure::Core::CaseInsensitiveMap` which is now used to store headers.
+  - `BodyStream` and the types that derive from it:
+    - Moved to `Azure::Core::IO` namespace.
+    - Changed the static methods `BodyStream::ReadToCount()` and `BodyStream::ReadToEnd()` into instance methods.
+    - Changed the constructor of `FileBodyStream` to accept a file name directly and take ownership of opening/closing the file, instead of accepting a file descriptor, offset, and length.
+  - HTTP policies and their options:
+    - Moved to `Policies` namespace.
+    - Renamed `TransportPolicyOptions` to `TransportOptions`.
+    - Renamed `TelemetryPolicyOptions` to `TelemetryOptions`.
+    - Changed type of `RetryOptions::StatusCodes` from `std::vector` to `std::set`.
+    - Renamed `LoggingPolicy` to `LogPolicy`, and introduced `LogOptions` as mandatory parameter for the constructor.
+- Moved header files:
+  - Renamed `azure/core/credentials.hpp` to `azure/core/credentials/credentials.hpp`.
+  - Renamed `azure/core/logger.hpp` to `azure/core/diagnostics/logger.hpp`.
+  - Renamed `azure/core/http/body_stream.hpp` to `azure/core/io/body_stream.hpp`.
+  - Renamed `azure/core/http/policy.hpp` to `azure/core/http/policies/policy.hpp`.
+  - Renamed `azure/core/http/curl/curl.hpp` to `azure/core/http/curl_transport.hpp`.
+  - Renamed `azure/core/http/winhttp/win_http_client.hpp` to `azure/core/http/win_http_transport.hpp`.
 
 ### Bug Fixes
 
 - Make sure to rewind the body stream at the start of each request retry attempt, including the first.
 - Connection pool resets when all connections are closed.
-- Fix `Azure::Context` to support unique_ptr.
+- Fix `Azure::Context` to support `std::unique_ptr`.
+- Throw `std::runtime_error` from `Response<T>::GetRawResponse()` if the response was already extracted.
 
 ## 1.0.0-beta.6 (2021-02-09)
 

sdk/identity/azure-identity/CHANGELOG.md

@@ -2,10 +2,13 @@
 
 ## 1.0.0-beta.4 (Unreleased)
 
+### New Features
+
+- Added `Azure::Identity::PackageVersion`.
+
 ### Breaking Changes
 
 - Removed `TransportPolicyOptions` from `ClientSecretCredentialOptions`. Updated the options to derive from ClientOptions.
-- Renamed `Azure::Identity::Details::Version` to `Azure::Identity::PackageVersion`.
 
 ## 1.0.0-beta.3 (2021-02-02)
 

sdk/storage/azure-storage-blobs/CHANGELOG.md

@@ -5,13 +5,13 @@
 ### New Features
 
 - Added support for telemetry options.
+- Added `Azure::Storage::Blobs::PackageVersion`.
 
 ### Breaking Changes
 
 - Changed the return type of `StartCopyFromUri` and `StartCopyIncremental` API from a `Response<T>` to the particular `Operation<T>` type called `StartCopyBlobOperation` directly.
 - String conversion functions of extensible enums were renamed from `Get()` to `ToString()`.
 - Moved `SecondaryHostForRetryReads` out of retry options, now it's under `BlobClientOptions`.
-- Renamed `Azure::Storage::Blobs::Details::Version` to `Azure::Storage::Blobs::PackageVersion`.
 
 ### Other Changes and Improvements
 

sdk/storage/azure-storage-common/CHANGELOG.md

@@ -2,9 +2,9 @@
 
 ## 12.0.0-beta.9 (Unreleased)
 
-### Breaking Changes
+### New Features
 
-- Renamed `Azure::Storage::Common::Details::Version` to `Azure::Storage::Common::PackageVersion`.
+- Added `Azure::Storage::Common::PackageVersion`.
 
 ## 12.0.0-beta.8 (2021-02-12)
 

sdk/storage/azure-storage-files-datalake/CHANGELOG.md

@@ -5,13 +5,13 @@
 ### New Features
 
 - Added support for telemetry options.
+- Added `Azure::Storage::Files::DataLake::PackageVersion`.
 
 ### Breaking Changes
 
 - DataLake client constructors won't automatically convert blob url to dfs url anymore.
 - String conversion functions of extensible enums were renamed from `Get()` to `ToString()`.
 - Moved `SecondaryHostForRetryReads` out of retry options, now it's under `DataLakeClientOptions`.
-- Renamed `Azure::Storage::Files::DataLake::Details::Version` to `Azure::Storage::Files::DataLake::PackageVersion`.
 
 ## 12.0.0-beta.8 (2021-02-12)
 

sdk/storage/azure-storage-files-shares/CHANGELOG.md

@@ -5,12 +5,12 @@
 ### New Features
 
 - Added support for telemetry options.
+- Added `Azure::Storage::Files::Shares::PackageVersion`.
 
 ### Breaking Changes
 
 - Changed the return type of `StartCopy` API from a `Response<T>` to the particular `Operation<T>` type called `StartCopyShareFileOperation` directly.
 - String conversion functions of extensible enums were renamed from `Get()` to `ToString()`.
-- Renamed `Azure::Storage::Files::Shares::Details::Version` to `Azure::Storage::Files::Shares::PackageVersion`.
 
 ## 12.0.0-beta.8 (2021-02-12)