FasterXML / FasterXML/jackson-module-jsonSchema

[Feature] Support for `definitions`

Open
#135 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
387
Forks
136
PR merge metrics
No merged PRs in 30d

Description

### Problem I am trying to solve:

Given Java Objects:

```java
@JsonSubTypes({
@JsonSubTypes.Type(value = A.class),
@JsonSubTypes.Type(value = B.class)
})
public interface I {}

public class A implements I {
public int varA;
}
public class B implements I {
public int varB;
}
public class C {
public I varC;
}
```

I desire a json schema as follows:
```json
{
"definitions": {
"urn:jsonschema:com:mycompany:GenerateSchemas:A": {
"type" : "object",
"id" : "urn:jsonschema:com:mycompany:GenerateSchemas:A",
"properties" : {
"varA" : {
"type" : "integer"
}
}
},
"urn:jsonschema:com:mycompany:GenerateSchemas:B": {
"type" : "object",
"id" : "urn:jsonschema:com:mycompany:GenerateSchemas:B",
"properties" : {
"varB" : {
"type" : "integer"
}
}
}
},
"type" : "object",
"id" : "urn:jsonschema:com:mycompany:GenerateSchemas:C",
"properties" : {
"varC" : {
"type" : "object",
"oneOf": [
{ "$ref": "urn:jsonschema:com:mycompany:GenerateSchemas:A" },
{ "$ref": "urn:jsonschema:com:mycompany:GenerateSchemas:B" }
]
}
}
}
```
Using version 2.9.8 of the library, the schema that is generated is:
```json
{
"type" : "object",
"id" : "urn:jsonschema:com:mycompany:GenerateSchemas:C",
"properties" : {
"varC" : {
"type" : "any"
}
}
}
```
It would be nice if it was possible to natively support this given that `@JsonSubType` annotations are present.

Please see related to StackOverflow Question: https://stackoverflow.com/questions/56174997/json-schema-generator-with-inheritance-and-references
My workaround: https://gist.github.com/rrmistry/2246c959d1c9cc45894ecf55305c61fd
*(Could be improved if approved)*

Thank you,

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.