Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 1.31 KB

migration_1_to_2.md

File metadata and controls

39 lines (30 loc) · 1.31 KB

caffoa: Migration Guide from 1.x.x to 2.x.x/3.x.x

There are a lot of breaking changes between 1.x and 3.x, see the changelog see them all.

If you migrate from v1.x to v3.x, follow the steps below to keep the 1.x behavior.

Remove the following entries (if you have them):

acceptCaseInvariantEnums: true
removeDeprecated: true
enumsAsStaticValues: false
checkEnums: false

Add enumMode according to the following table:

enumsAsStaticValues checkEnums enumMode
false * Default
true false StaticValuesWithoutCheck
true (1.x default) true (1.x default) StaticValues

Set the following variables. If you already have some of them, just keep them at their current value.

config:
  enumMode: StaticValues # see above
  useInheritance: true
  withCancellation: false
  parsePathParameters: false
  parseQueryParameters: false
  genericAdditionalPropertiesType: JObject
  clearGeneratedFiles: false
  useDateOnly: false
  useDateTime: true

Remove the package-reference to CdIts.Caffoa 1.x.x and add add a package-reference to CdIts.Caffoa.Json.Net 3.x.x