com.github.victools.jsonschema.generator.impl

Class SchemaCleanUpUtils

java.lang.Object

com.github.victools.jsonschema.generator.impl.SchemaCleanUpUtils

public class SchemaCleanUpUtils
extends Object

Utility for cleaning up generated schemas.

Constructor Summary

Constructors

Constructor and Description
SchemaCleanUpUtils(SchemaGeneratorConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
String	ensureDefinitionKeyIsPlain(String definitionKey) Replace characters in the given definition key that are neither alphanumeric nor a dot, dash or underscore (as expected by OpenAPI).
String	ensureDefinitionKeyIsUriCompatible(String definitionKey) Replace characters in the given definition key that are deemed incompatible within a URI (as expected by JSON Schema).
void	reduceAllOfNodes(List<com.fasterxml.jackson.databind.node.ObjectNode> jsonSchemas) Remove and merge SchemaKeyword.TAG_ALLOF parts when there are no conflicts between the sub-schemas.
void	reduceAnyOfNodes(List<com.fasterxml.jackson.databind.node.ObjectNode> jsonSchemas) Reduce nested SchemaKeyword.TAG_ANYOF parts when one contains an entry with only another SchemaKeyword.TAG_ANYOF inside.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SchemaCleanUpUtils

public SchemaCleanUpUtils(SchemaGeneratorConfig config)

Constructor.

Parameters:

config - configuration to be applied

Method Detail

reduceAllOfNodes

public void reduceAllOfNodes(List<com.fasterxml.jackson.databind.node.ObjectNode> jsonSchemas)

Remove and merge SchemaKeyword.TAG_ALLOF parts when there are no conflicts between the sub-schemas. This makes for more readable schemas being generated but has the side-effect that any manually added SchemaKeyword.TAG_ALLOF (e.g. through a custom definition of attribute overrides) may be removed as well if it isn't strictly speaking necessary.

Parameters:

jsonSchemas - generated schemas that may contain unnecessary SchemaKeyword.TAG_ALLOF nodes

reduceAnyOfNodes

public void reduceAnyOfNodes(List<com.fasterxml.jackson.databind.node.ObjectNode> jsonSchemas)

Reduce nested SchemaKeyword.TAG_ANYOF parts when one contains an entry with only another SchemaKeyword.TAG_ANYOF inside. This makes for more readable schemas being generated but has the side-effect that any manually added SchemaKeyword.TAG_ANYOF (e.g. through a custom definition of attribute overrides) may be removed as well if it isn't strictly speaking necessary.

Parameters:

jsonSchemas - generated schemas that may contain unnecessary nested SchemaKeyword.TAG_ANYOF nodes

ensureDefinitionKeyIsUriCompatible

public String ensureDefinitionKeyIsUriCompatible(String definitionKey)

Replace characters in the given definition key that are deemed incompatible within a URI (as expected by JSON Schema).

Parameters:

definitionKey - SchemaDefinitionNamingStrategy output

Returns:

URI compatible version of the given definition key

ensureDefinitionKeyIsPlain

public String ensureDefinitionKeyIsPlain(String definitionKey)

Replace characters in the given definition key that are neither alphanumeric nor a dot, dash or underscore (as expected by OpenAPI).

Parameters:

definitionKey - SchemaDefinitionNamingStrategy output

Returns:

simplified version of the given definition key