MIGRATION_GUIDE.md

Migration guide

All changes required to migrate generated Apigen projects to new versions will be documented in this file.

From 2.0.2 to [2.0.3]

No migration required

From 2.0.1 to 2.0.2

No migration required

From 2.0.0 to 2.0.1

No migration required

From 1.2.5 to 2.0.0

• Perform the Spring Boot migration from 3.5.x to 4.0.x

From 1.2.4 to 1.2.5

No migration required

From 1.2.3 to 1.2.4

No migration required

From 1.2.2 to 1.2.3

No migration required

From 1.2.1 to 1.2.2

No migration required

From 1.2.0 to 1.2.1

No migration required

From 1.1.3 to 1.2.0

• Perform the Spring Boot migration from 3.4.x to 3.5.x

From 1.1.2 to 1.1.3

No migration required

From 1.1.1 to 1.1.2

No migration required

From 1.1.0 to 1.1.1

No migration required

From 1.0.1 to 1.1.0

Update the management endpoints properties

Old:

management.endpoints.enabled-by-default=false
management.endpoint.<id>.enabled=true

New:

management.endpoints.access.default=none
management.endpoint.<id>.access=read-only

Remove the deprecated spring.mvc.throw-exception-if-no-handler-found property

From 1.0.0 to 1.0.1

No migration required

From 0.6.2 to 1.0.0

Update to Java 21

From 0.6.1 to 0.6.2

No migration required

From 0.6.0 to 0.6.1

No migration required

From 0.5.0 to 0.6.0

This version requires to replace the hibernate uuid generation.

Old:

    @Id
    @GeneratedValue(
            generator = "uuid"
    )
    @GenericGenerator(
            name = "uuid",
            strategy = "uuid2"
    )
    @Column(
            name = "id"
    )
    private String id;

New:

    @Id
    @UuidGenerator
    @Column(
            name = "id"
    )
    private String id;

From 0.4.1 to 0.5.0

No migration required

From 0.4.0 to 0.4.1

No migration required

From 0.3.0 to 0.4.0

In this version Apigen has been updated to use Spring Boot 3, so now you need a java version >= 17

Support for PATCH endpoints has been added and the PUT endpoint behaviour has changed. To maintain the same functionality as in the previous versions you need to use AbstractRelationsLegacyManager and AbstractCrudLegacyService instead of AbstractRelationsManager and AbstractCrudService

From 0.2.0 to 0.3.0

No migration required

From 0.1.0 to 0.2.0

In this version Apigen has been updated to be auto documented with spring-doc and all the dependencies have been updated.

• Replace the autogenerated documentation annotations in controllers from io.swagger.annotations.Api to io.swagger.v3.oas.annotations.tags.Tag
• Perform the Spring Boot migration from 2.4.x to 2.6.x
• Remove the property apigen.documentation.enabled, now the documentation is managed by the spring-doc official properties