NPE when get json schema from enum field with @Description [DATAREST-1508]

yejianfengblue opened DATAREST-1508 and commented

Given an enum field annotated with org.springframework.data.rest.core.annotation.Description, in this example, gender

@Entity
@Data
@NoArgsConstructor
public class User {

    @Id
    Long id;

    @Description("User name")
    String name;

    @Description("User gender, MALE or FEMALE")
    Gender gender;
}

when get JSON schema,

curl --request GET 'http://localhost:8080/profile/users' \
     --header 'Accept: application/schema+json' \
     --include

then NullPointerException thrown at PersistentEntityToJsonSchemaConverter.java:489.

 I guess the cause might be

1. AnnotationBasedResourceDescription forgot to override method getDefaultMessage(), while super.getDefaultMessage() return null.
2. PersistentEntityToJsonSchemaConverter.java:489 should not call getDefaultMessage().

A demo Spring Data REST application is provided in github see the reference URL.

The workaround is put the description to rest-messages.properties as mentioned at https://docs.spring.io/spring-data/rest/docs/current/reference/html/#metadata.alps.descriptions

Is the use of @Description not recommanded? Because the description in @Description is shown in ALPS document only, while the description in rest-messages.properties is shown in both ALPS and JSON schema. 
 

Affects: 3.2.6 (Moore SR6)

Reference URL: https://github.com/yejianfengblue/spring-data-rest-enum-description-npe