Generate $jsonSchema out of domain type meta information. [DATAMONGO-1849]

[spring-projects-issues]

Christoph Strobl opened DATAMONGO-1849 and commented

Use the information from MongoPersistentEntity and MongoPersistentProperty to generate JSON Schema for a given type using annotations like @Nullable to distinguish between required and optional fields.

MongoJsonSchema fromType(Class<?> domainType) {
		
	MongoPersistentEntity<?> entity  = mappingContext.getPersistentEntity(domainType);
	
	MongoJsonSchemaBuilder builder = MongoJsonSchema.builder();
	
	entity.doWithProperties((SimplePropertyHandler) persistentProperty -> {

		// if property is constructor arg or not @Nullable make it required
		if(entity.isConstructorArgument(persistentProperty) || persistentProperty.findAnnotation(Nullable.class) == null) {
			builder.required(persistentProperty.getName());
		}
		
		
		// append a collection type property
		if(persistentProperty.isArray() || persistentProperty.isCollectionLike()) {
			ArrayJsonSchemaProperty arrayProperty = JsonSchemaProperty.array(persistentProperty.getName()); //
			if(ClassUtils.isAssignable(Set.class, persistentProperty.getActualType())) {
				arrayProperty = arrayProperty.uniqueItems(true);
			}
			builder.property(arrayProperty);
		}
		
		if(persistentProperty.isEntity()) {
			
			// .... and so on

---

Reference URL: https://stackoverflow.com/questions/50169457/define-mongo-schema-validation-using-spring

Issue Links:

• DATACMNS-1513 Expose nullability requirements for PersistentProperty and PreferredConstructor arguments

• DATAMONGO-1322 Add support for validator when creating collection

• DATAMONGO-1835 Add support for $jsonSchema to Criteria API

Referenced from: pull request #733

2 votes, 2 watchers

[spring-projects-issues]

Christoph Strobl commented

Rules for schema generation:

General Rules

Required Properties

• constructor arguments unless annotated with @Nullable, @Null
• all @NonNull @NotNull annotated fields
• primitive types

Ignored Properties

• @Transient fields

Type Mapping

• Object.class -> UntypedJsonSchemaObject
• Simple types -> Type.of()
• Entity types -> object
• List / array -> array
• enum -> string

Type Specific Rules

Enum Types

• restrict values via enum : [] to the ones available for the enum.

String Type

• @Size(min=...) -> minLength
• @Size(max=...) -> maxLength
• @Pattern(regexp=...) -> pattern

Numeric Types

• @Max, @DecimalMax -> maximum
• @Min, @DecimalMin -> minimum
• @Digits -> NOT SUPPORTED

Arrays / Collections

• @Size(min=...) -> minItems
• @Size(max=...) -> maxItems
• Set.class -> uniqueItems : true

Entity Type

• non transient properties -> properties + nested mapping