<commit_before>
# Migration guide

To see the biggest differences please consult the [changelog](Changelog.md).

## In version 1.5.0 (Not released yet)

### Configuration changes

* [#2992](https://github.com/TouK/nussknacker/pull/2992) deploySettings changed to deploymentCommentSettings, now when specified require you to also specify field validationPattern, specifying exampleComment is optional.
* commentSettings fields modified. matchExpression changed to substitutionPattern, link changed to substitutionLink.
* [#3165](https://github.com/TouK/nussknacker/pull/3165) Config is not exposed over http (GET /api/app/config/) by default. To enable it set configuration `enableConfigEndpoint` to `true`.
* [#3223](https://github.com/TouK/nussknacker/pull/3223) OAuth2 configuration `defaultTokenExpirationTime` changed to `defaultTokenExpirationDuration`
* [#3263](https://github.com/TouK/nussknacker/pull/3263) Batch periodic scenarios carry processing type to distinguish scenarios with different categories.
  For existing scenarios processing type is migrated to `default`. Set `deploymentManager.processingType` to `default`
  or update periodic scenarios table with actual processing type value - ideally it should be same value as the periodic engine key in `scenarioTypes`.

### Code API changes

* [#2992](https://github.com/TouK/nussknacker/pull/2992) OnDeployActionSuccess in ProcessChangeEvent now requires instance of Option[Comment] instead of Option[String] as parameter with deploymentComment information. Added abstract class Comment in listener-api.
* [#3136](https://github.com/TouK/nussknacker/pull/3136) Improvements: Lite Kafka testkit
  * `ConfluentUtils.serializeRecordToBytesArray` replaced by `ConfluentUtils.serializeDataToBytesArray`
  * `ConfluentUtils.deserializeSchemaIdAndRecord` replaced by `ConfluentUtils.deserializeSchemaIdAndData`
* [#3178](https://github.com/TouK/nussknacker/pull/3178) Improvements: more complex test scenario runner result:
  * Right now each method from `TestScenarioRunner` should return `ValidatedNel[ProcessCompilationError, RunResult[R]]` where:<commit_msg>Update MigrationGuide.md<commit_after>
# Migration guide

To see the biggest differences please consult the [changelog](Changelog.md).

## In version 1.5.0

### Configuration changes

* [#2992](https://github.com/TouK/nussknacker/pull/2992) deploySettings changed to deploymentCommentSettings, now when specified require you to also specify field validationPattern, specifying exampleComment is optional.
* commentSettings fields modified. matchExpression changed to substitutionPattern, link changed to substitutionLink.
* [#3165](https://github.com/TouK/nussknacker/pull/3165) Config is not exposed over http (GET /api/app/config/) by default. To enable it set configuration `enableConfigEndpoint` to `true`.
* [#3223](https://github.com/TouK/nussknacker/pull/3223) OAuth2 configuration `defaultTokenExpirationTime` changed to `defaultTokenExpirationDuration`
* [#3263](https://github.com/TouK/nussknacker/pull/3263) Batch periodic scenarios carry processing type to distinguish scenarios with different categories.
  For existing scenarios processing type is migrated to `default`. Set `deploymentManager.processingType` to `default`
  or update periodic scenarios table with actual processing type value - ideally it should be same value as the periodic engine key in `scenarioTypes`.

### Code API changes

* [#2992](https://github.com/TouK/nussknacker/pull/2992) OnDeployActionSuccess in ProcessChangeEvent now requires instance of Option[Comment] instead of Option[String] as parameter with deploymentComment information. Added abstract class Comment in listener-api.
* [#3136](https://github.com/TouK/nussknacker/pull/3136) Improvements: Lite Kafka testkit
  * `ConfluentUtils.serializeRecordToBytesArray` replaced by `ConfluentUtils.serializeDataToBytesArray`
  * `ConfluentUtils.deserializeSchemaIdAndRecord` replaced by `ConfluentUtils.deserializeSchemaIdAndData`
* [#3178](https://github.com/TouK/nussknacker/pull/3178) Improvements: more complex test scenario runner result:
  * Right now each method from `TestScenarioRunner` should return `ValidatedNel[ProcessCompilationError, RunResult[R]]` where:
{'fraction_non_alphanumeric': 0.08994334277620397, 'fraction_numerical': 0.028328611898016998, 'mean_word_length': 6.355902777777778, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2448718', 'n_tokens_mistral': 1230, 'n_tokens_neox': 1127, 'n_words': 363}