Skip to content

[JSON Schema] Associate table with union _type field #8644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[JSON Schema] Associate table with union _type field #8644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 117 additions & 14 deletions src/idl_gen_json_schema.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,23 +119,42 @@ static std::string GenType(const Type &type) {
return GenTypeRef(type.struct_def);
}
case BASE_TYPE_UNION: {
std::string union_type_string("\"anyOf\": [");
std::string union_type_string("\"oneOf\": [");
const auto &union_types = type.enum_def->Vals();
bool first = true;

for (auto ut = union_types.cbegin(); ut < union_types.cend(); ++ut) {
const auto &union_type = *ut;
if (union_type->union_type.base_type == BASE_TYPE_NONE) { continue; }
if (union_type->union_type.base_type == BASE_TYPE_STRUCT) {
if (!first) union_type_string.append(",");
first = false;

union_type_string.append(
"{ " + GenTypeRef(union_type->union_type.struct_def) + " }");
}
if (union_type != *type.enum_def->Vals().rbegin()) {
union_type_string.append(",");
"{ \"type\": \"object\", \"properties\": { ");
union_type_string.append("\"type\": { \"const\": \"" +
union_type->name + "\" }, ");
union_type_string.append(
"\"value\": { " + GenTypeRef(union_type->union_type.struct_def) +
" }");
union_type_string.append(" }, \"required\": [\"type\", \"value\"] }");
}
}
union_type_string.append("]");
return union_type_string;
}
case BASE_TYPE_UTYPE: return GenTypeRef(type.enum_def);
case BASE_TYPE_UTYPE: {
std::string enumdef = GenType("string") + ", \"enum\": [";
for (auto enum_value = type.enum_def->Vals().begin();
enum_value != type.enum_def->Vals().end(); ++enum_value) {
enumdef.append("\"" + (*enum_value)->name + "\"");
if (*enum_value != type.enum_def->Vals().back()) {
enumdef.append(", ");
}
}
enumdef.append("]");
return enumdef;
}
default: {
return GenBaseType(type);
}
Expand Down Expand Up @@ -221,15 +240,34 @@ class JsonSchemaGenerator : public BaseGenerator {
for (auto e = parser_.enums_.vec.cbegin(); e != parser_.enums_.vec.cend();
++e) {
code_ += Indent(2) + "\"" + GenFullName(*e) + "\" : {" + NewLine();
code_ += Indent(3) + GenType("string") + "," + NewLine();
auto enumdef(Indent(3) + "\"enum\": [");
for (auto enum_value = (*e)->Vals().begin();
enum_value != (*e)->Vals().end(); ++enum_value) {
enumdef.append("\"" + (*enum_value)->name + "\"");
if (*enum_value != (*e)->Vals().back()) { enumdef.append(", "); }

if ((*e)->is_union) {
std::string union_type_string("\"anyOf\": [");
const auto &union_types = (*e)->Vals();
for (auto ut = union_types.cbegin(); ut < union_types.cend(); ++ut) {
const auto &union_type = *ut;
if (union_type->union_type.base_type == BASE_TYPE_NONE) { continue; }
if (union_type->union_type.base_type == BASE_TYPE_STRUCT) {
union_type_string.append(
"{ " + GenTypeRef(union_type->union_type.struct_def) + " }");
}
if (union_type != *union_types.rbegin()) {
union_type_string.append(",");
}
}
union_type_string.append("]");
code_ += Indent(3) + union_type_string + NewLine();
} else {
code_ += Indent(3) + GenType("string") + "," + NewLine();
auto enumdef(Indent(3) + "\"enum\": [");
for (auto enum_value = (*e)->Vals().begin();
enum_value != (*e)->Vals().end(); ++enum_value) {
enumdef.append("\"" + (*enum_value)->name + "\"");
if (*enum_value != (*e)->Vals().back()) { enumdef.append(", "); }
}
enumdef.append("]");
code_ += enumdef + NewLine();
}
enumdef.append("]");
code_ += enumdef + NewLine();
code_ += Indent(2) + "}," + NewLine(); // close type
}
for (auto s = parser_.structs_.vec.cbegin();
Expand Down Expand Up @@ -276,6 +314,71 @@ class JsonSchemaGenerator : public BaseGenerator {
code_ += typeLine + NewLine();
}
code_ += Indent(3) + "}," + NewLine(); // close properties
std::vector<std::string> union_conditions;

for (auto prop = properties.cbegin(); prop != properties.cend(); ++prop) {
const auto &property = *prop;

// Add conditionals to point the correct underlying data to the _type
if (property->value.type.base_type == BASE_TYPE_UNION) {
const auto &union_types = property->value.type.enum_def->Vals();
const std::string type_field_name = property->name + "_type";

for (auto ut = union_types.cbegin(); ut < union_types.cend(); ++ut) {
const auto &union_type = *ut;
if (union_type->union_type.base_type == BASE_TYPE_NONE) {
std::string none_condition;
none_condition += Indent(4) + "{" + NewLine();
none_condition += Indent(5) + "\"if\": {" + NewLine();
none_condition += Indent(6) + "\"properties\": {" + NewLine();
none_condition += Indent(7) + "\"" + type_field_name +
"\": { \"const\": \"" + union_type->name +
"\" }" + NewLine();
none_condition += Indent(6) + "}" + NewLine();
none_condition += Indent(5) + "}," + NewLine();
none_condition += Indent(5) + "\"then\": {" + NewLine();
none_condition += Indent(6) + "\"not\": {" + NewLine();
none_condition += Indent(7) + "\"required\": [\"" +
property->name + "\"]" + NewLine();
none_condition += Indent(6) + "}" + NewLine();
none_condition += Indent(5) + "}" + NewLine();
none_condition += Indent(4) + "}";

union_conditions.push_back(none_condition);
}
if (union_type->union_type.base_type == BASE_TYPE_STRUCT) {
std::string condition;
condition += Indent(4) + "{" + NewLine();
condition += Indent(5) + "\"if\": {" + NewLine();
condition += Indent(6) + "\"properties\": {" + NewLine();
condition += Indent(7) + "\"" + type_field_name +
"\": { \"const\": \"" + union_type->name + "\" }" +
NewLine();
condition += Indent(6) + "}" + NewLine();
condition += Indent(5) + "}," + NewLine();
condition += Indent(5) + "\"then\": {" + NewLine();
condition += Indent(6) + "\"properties\": {" + NewLine();
condition += Indent(7) + "\"" + property->name + "\": { " +
GenTypeRef(union_type->union_type.struct_def) +
" }" + NewLine();
condition += Indent(6) + "}" + NewLine();
condition += Indent(5) + "}" + NewLine();
condition += Indent(4) + "}";

union_conditions.push_back(condition);
}
}
}
}
if (!union_conditions.empty()) {
code_ += Indent(3) + "\"allOf\": [" + NewLine();
for (size_t i = 0; i < union_conditions.size(); ++i) {
code_ += union_conditions[i];
if (i < union_conditions.size() - 1) { code_ += ","; }
code_ += NewLine();
}
code_ += Indent(3) + "]," + NewLine();
}

std::vector<FieldDef *> requiredProperties;
std::copy_if(properties.begin(), properties.end(),
Expand Down
167 changes: 155 additions & 12 deletions tests/monster_test.schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,13 @@
"enum": ["LongOne", "LongTwo", "LongBig"]
},
"MyGame_Example_Any" : {
"type" : "string",
"enum": ["NONE", "Monster", "TestSimpleTableWithEnum", "MyGame_Example2_Monster"]
"anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" },{ "$ref" : "#/definitions/MyGame_Example2_Monster" }]
},
"MyGame_Example_AnyUniqueAliases" : {
"type" : "string",
"enum": ["NONE", "M", "TS", "M2"]
"anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" },{ "$ref" : "#/definitions/MyGame_Example2_Monster" }]
},
"MyGame_Example_AnyAmbiguousAliases" : {
"type" : "string",
"enum": ["NONE", "M1", "M2", "M3"]
"anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_Monster" }]
},
"MyGame_OtherNameSpace_Unused" : {
"type" : "object",
Expand Down Expand Up @@ -200,10 +197,10 @@
"$ref" : "#/definitions/MyGame_Example_Color"
},
"test_type" : {
"$ref" : "#/definitions/MyGame_Example_Any"
"type" : "string", "enum": ["NONE", "Monster", "TestSimpleTableWithEnum", "MyGame_Example2_Monster"]
},
"test" : {
"anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" },{ "$ref" : "#/definitions/MyGame_Example2_Monster" }]
"oneOf": [{ "type": "object", "properties": { "type": { "const": "Monster" }, "value": { "$ref" : "#/definitions/MyGame_Example_Monster" } }, "required": ["type", "value"] },{ "type": "object", "properties": { "type": { "const": "TestSimpleTableWithEnum" }, "value": { "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" } }, "required": ["type", "value"] },{ "type": "object", "properties": { "type": { "const": "MyGame_Example2_Monster" }, "value": { "$ref" : "#/definitions/MyGame_Example2_Monster" } }, "required": ["type", "value"] }]
},
"test4" : {
"type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Test"}
Expand Down Expand Up @@ -309,16 +306,16 @@
"type" : "array", "items" : {"type" : "integer", "minimum" : 0, "maximum" : 18446744073709551615}
},
"any_unique_type" : {
"$ref" : "#/definitions/MyGame_Example_AnyUniqueAliases"
"type" : "string", "enum": ["NONE", "M", "TS", "M2"]
},
"any_unique" : {
"anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" },{ "$ref" : "#/definitions/MyGame_Example2_Monster" }]
"oneOf": [{ "type": "object", "properties": { "type": { "const": "M" }, "value": { "$ref" : "#/definitions/MyGame_Example_Monster" } }, "required": ["type", "value"] },{ "type": "object", "properties": { "type": { "const": "TS" }, "value": { "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" } }, "required": ["type", "value"] },{ "type": "object", "properties": { "type": { "const": "M2" }, "value": { "$ref" : "#/definitions/MyGame_Example2_Monster" } }, "required": ["type", "value"] }]
},
"any_ambiguous_type" : {
"$ref" : "#/definitions/MyGame_Example_AnyAmbiguousAliases"
"type" : "string", "enum": ["NONE", "M1", "M2", "M3"]
},
"any_ambiguous" : {
"anyOf": [{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_Monster" },{ "$ref" : "#/definitions/MyGame_Example_Monster" }]
"oneOf": [{ "type": "object", "properties": { "type": { "const": "M1" }, "value": { "$ref" : "#/definitions/MyGame_Example_Monster" } }, "required": ["type", "value"] },{ "type": "object", "properties": { "type": { "const": "M2" }, "value": { "$ref" : "#/definitions/MyGame_Example_Monster" } }, "required": ["type", "value"] },{ "type": "object", "properties": { "type": { "const": "M3" }, "value": { "$ref" : "#/definitions/MyGame_Example_Monster" } }, "required": ["type", "value"] }]
},
"vector_of_enums" : {
"type" : "array", "items" : {"$ref" : "#/definitions/MyGame_Example_Color"}
Expand Down Expand Up @@ -366,6 +363,152 @@
"type" : "number"
}
},
"allOf": [
{
"if": {
"properties": {
"test_type": { "const": "NONE" }
}
},
"then": {
"not": {
"required": ["test"]
}
}
},
{
"if": {
"properties": {
"test_type": { "const": "Monster" }
}
},
"then": {
"properties": {
"test": { "$ref" : "#/definitions/MyGame_Example_Monster" }
}
}
},
{
"if": {
"properties": {
"test_type": { "const": "TestSimpleTableWithEnum" }
}
},
"then": {
"properties": {
"test": { "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" }
}
}
},
{
"if": {
"properties": {
"test_type": { "const": "MyGame_Example2_Monster" }
}
},
"then": {
"properties": {
"test": { "$ref" : "#/definitions/MyGame_Example2_Monster" }
}
}
},
{
"if": {
"properties": {
"any_unique_type": { "const": "NONE" }
}
},
"then": {
"not": {
"required": ["any_unique"]
}
}
},
{
"if": {
"properties": {
"any_unique_type": { "const": "M" }
}
},
"then": {
"properties": {
"any_unique": { "$ref" : "#/definitions/MyGame_Example_Monster" }
}
}
},
{
"if": {
"properties": {
"any_unique_type": { "const": "TS" }
}
},
"then": {
"properties": {
"any_unique": { "$ref" : "#/definitions/MyGame_Example_TestSimpleTableWithEnum" }
}
}
},
{
"if": {
"properties": {
"any_unique_type": { "const": "M2" }
}
},
"then": {
"properties": {
"any_unique": { "$ref" : "#/definitions/MyGame_Example2_Monster" }
}
}
},
{
"if": {
"properties": {
"any_ambiguous_type": { "const": "NONE" }
}
},
"then": {
"not": {
"required": ["any_ambiguous"]
}
}
},
{
"if": {
"properties": {
"any_ambiguous_type": { "const": "M1" }
}
},
"then": {
"properties": {
"any_ambiguous": { "$ref" : "#/definitions/MyGame_Example_Monster" }
}
}
},
{
"if": {
"properties": {
"any_ambiguous_type": { "const": "M2" }
}
},
"then": {
"properties": {
"any_ambiguous": { "$ref" : "#/definitions/MyGame_Example_Monster" }
}
}
},
{
"if": {
"properties": {
"any_ambiguous_type": { "const": "M3" }
}
},
"then": {
"properties": {
"any_ambiguous": { "$ref" : "#/definitions/MyGame_Example_Monster" }
}
}
}
],
"required" : ["name"],
"additionalProperties" : false
},
Expand Down