diff --git a/sdk/digitaltwins/azure-digitaltwins-core/CHANGELOG.md b/sdk/digitaltwins/azure-digitaltwins-core/CHANGELOG.md index 3a9a5f0f7f6f8..4278e8fdf8661 100644 --- a/sdk/digitaltwins/azure-digitaltwins-core/CHANGELOG.md +++ b/sdk/digitaltwins/azure-digitaltwins-core/CHANGELOG.md @@ -1,16 +1,34 @@ # Release History -## 1.0.0 (Unreleased) +## 1.0.0 (2020-10-30) ### New Features -- Regenerate protocol layer from service API version 2020-10-31 -- Update service API version to use service API version 2020-10-31 by default -- Add optional parameters for traceparent and tracestate to all service request APIs to support distributed tracing +- Regenerated protocol layer from service API version 2020-10-31. +- Updated service API version to use service API version 2020-10-31 by default. -### Breaking Changes +### Breaking changes + +Note that these breaking changes are only breaking changes from the preview version of this library. + +- Replaced all `Response` and `Pageable` APIs with `Response` and `Pageable` respectively. +- Renamed `CreateDigitalTwin`, `CreateRelationship` and `CreateEventRoute` APIs to `CreateOrReplaceDigitalTwin`, `CreateOrReplaceRelationship` and `CreateOrReplaceEventRoute` respectively. +- Renamed model type `ModelData` to `DigitalTwinsModelData` to make type less generic, and less likely to conflict with other libraries. +- Renamed model type `EventRoute` to `DigitalTwinsEventRoute` to make type less generic, and less likely to conflict with other libraries. +- `EventRoute` (now `DigitalTwinsEventRoute`) object ctor now requires filter. +- Removed `UpdateOperationsUtility` and replace it with a direct dependency on [JsonPatchDocument](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/models/JsonPatchDocument.java) from azure-core. +- Removed `WritableProperty` since service no longer returns that type. +- Removed `MaxItemCount` parameter as an option for GetEventRoutes APIs since users are expected to provide page size in pageable type's .AsPages() method instead. +- Renamed `DigitalTwinsModelData` field `DisplayName` to `DisplayNameLanguageMap` for clarity. +- Renamed `DigitalTwinsModelData` field `Description` to `DescriptionLanguageMap` for clarity. +- Renamed `DigitalTwinsModelData` field `model` to `dtdlModel`. +- Flattened `DigitalTwinsRequestOptions` so that each API takes in ifMatch and ifNoneMatch header directly. +- Reworked `BasicDigitalTwin` and other helper classes to better match the service definitions. This includes renaming `CustomProperties` to `Contents`. +- Added `messageId` as mandatory parameter for telemetry APIs. Service API version 2020-10-31 requires this parameter. +- Renamed CreateModels API parameter `models` to `dtdtlModels` for clarity. -- Add messageId as mandatory parameter for telemetry APIs. Service API version 2020-10-31 requires this parameter. +### Fixes and improvements +- Fixed bug where `CreateDigitalTwin` and `CreateRelationship` APIs always sent ifNoneMatch header with value "*" making it impossible to replace an existing entity. ## 1.0.0-beta.3 (2020-10-01) diff --git a/sdk/digitaltwins/azure-digitaltwins-core/README.md b/sdk/digitaltwins/azure-digitaltwins-core/README.md index d2e7b3bfd2fe4..14eee73909a94 100644 --- a/sdk/digitaltwins/azure-digitaltwins-core/README.md +++ b/sdk/digitaltwins/azure-digitaltwins-core/README.md @@ -18,7 +18,7 @@ For the best development experience, developers should use the official Microsof com.azure azure-digitaltwins-core - 1.0.0-beta.3 + 1.0.0 ```