Generate POJOs from subschemas defined in 'definitions'/'$defs' section

[unkish]

Closes #1123
Closes #987

[unkish]

A fairly naïve implementation inspired by #1124.
All props and kudos to Duane Zamrok.

Not supported: defaulting to using the dialect of the parent schema when figuring out whether to use/prefer definitions over $defs.

Feedback/critique is welcomed.

[lejtemxviw]

It looks like OAS3 would expect to include the schemas for the spec in components/schemas, rather than definitions - could we modify this change so that the path to look for was customizable, somehow? Or maybe leave this PR as is, but create a new ticket/PR to add that as an improvement to this PR?

[unkish]

@lejtemxviw

It looks like OAS3 would expect to include the schemas for the spec in components/schemas, rather than definitions - could we modify this change so that the path to look for was customizable, somehow

I guess one option could be changing private String getDefinitionsNodeName to protected String getDefinitionsNodeName which would then allow overriding given method in custom SchemaRule.

Please note that handling/processing of oneOf/allOf/anyOf nodes is not in the scope of given request (if OAS3 contains these - they'll be skipped)

[joelittlejohn]

I guess if we make this configurable, we need to ensure that you can specify a path to the schemas rather than just a property name. It sounds like oas3 as the node in /components/schemas. I like the idea of making this configurable as $defs was only recently standardised.

[unkish]

• renamed SchemaRule#getDefinitionsNodeName(JsonNode) to SchemaRule#getDefinitionsNodePath(JsonNode)
• changed access modifier of SchemaRule#getDefinitionsNodePath(JsonNode) from private to protected
• added SchemaIT::definitionsFromCustomPathProcessed_when_definitionsNodePathIsOverridden to validate possibility of configuring custom schema "definitions" path through custom RuleFactory

It should be possible to make custom definitions path configurable via config or extension property if needed (currently not implemented)

[unkish]

I like the idea of making this configurable as $defs was only recently standardised

@joelittlejohn what is your vision on having definitions path being configurable ?
Would it be via

• configuration property
• extension property
• both ?

Shall that be addressed within given issue ?

[joelittlejohn]

For now I was imagining a configuration property, like definitionsPath (default is as per the JSON schema spec). I think having different definitions paths per document would be a pretty confusing way to do things.

Given that the current behaviour has been in place for so long, I also think we need a new config option to turn this on: generateDefinitions, default false.

[unkish]

For now I was imagining a configuration property, like definitionsPath (default is as per the JSON schema spec)

1. Would that be per current latest JSON schema spec ? Ie. $defs
2. Which "format" it would expected to be defined
   1. $defs
   2. /$defs
   3. #/$defs
   4. ...

I think having different definitions paths per document would be a pretty confusing way to do things.

Whilst I do agree that it might be confusing, on the other hand it might as well be not that uncommon.
Note: jsonschema2pojo does not need to support all possible permutations though and given fact could be stated on wiki page.

May I assume that it would mean there will be no need for fallback logic as the behavior will be straight-forward:
if generateDefinitions is true and definitionsPath exists - process it's definitions.

[Blu2k19]

@joelittlejohn
Any news? what can we do to help get this merged?