Merge pull request #69 from gmlewis/i68-oneof-ref

Add support for oneof_ref
invopop · Sep 6, 2023 · 88a348b · 88a348b
2 parents aadda03 + 28cc7fb
commit 88a348b
Show file tree

Hide file tree

Showing 5 changed files with 81 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -37,6 +37,8 @@ type TestUser struct {
   BirthDate     time.Time              `json:"birth_date,omitempty" jsonschema:"oneof_required=date"`
   YearOfBirth   string                 `json:"year_of_birth,omitempty" jsonschema:"oneof_required=year"`
   Metadata      interface{}            `json:"metadata,omitempty" jsonschema:"oneof_type=string;array"`
+  IPAddress     interface{}            `json:"ip_address,omitempty" jsonschema:"oneof_ref=#/$defs/ipv4;#/$defs/ipv6"`
+  IPAddresses   []interface{}          `json:"ip_addresses,omitempty" jsonschema:"oneof_ref=#/$defs/ipv4;#/$defs/ipv6"`
   FavColor      string                 `json:"fav_color,omitempty" jsonschema:"enum=red,enum=green,enum=blue"`
 }
 ```
@@ -49,7 +51,8 @@ jsonschema.Reflect(&TestUser{})
 
 ```json
 {
-  "$schema": "http://json-schema.org/draft/2020-12/schema",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/invopop/jsonschema_test/sample-user",
   "$ref": "#/$defs/SampleUser",
   "$defs": {
     "SampleUser": {
@@ -103,6 +106,29 @@ jsonschema.Reflect(&TestUser{})
             }
           ]
         },
+        "ip_address": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/ipv4"
+            },
+            {
+              "$ref": "#/$defs/ipv6"
+            }
+          ]
+        },
+        "ip_addresses": {
+          "items": {
+            "oneOf": [
+              {
+                "$ref": "#/$defs/ipv4"
+              },
+              {
+                "$ref": "#/$defs/ipv6"
+              }
+            ]
+          },
+          "type": "array"
+        },
         "fav_color": {
           "type": "string",
           "enum": ["red", "green", "blue"]

diff --git a/examples_test.go b/examples_test.go
@@ -16,6 +16,8 @@ type SampleUser struct {
 	BirthDate   time.Time              `json:"birth_date,omitempty" jsonschema:"oneof_required=date"`
 	YearOfBirth string                 `json:"year_of_birth,omitempty" jsonschema:"oneof_required=year"`
 	Metadata    interface{}            `json:"metadata,omitempty" jsonschema:"oneof_type=string;array"`
+	IPAddress   interface{}            `json:"ip_address,omitempty" jsonschema:"oneof_ref=#/$defs/ipv4;#/$defs/ipv6"`
+	IPAddresses []interface{}          `json:"ip_addresses,omitempty" jsonschema:"oneof_ref=#/$defs/ipv4;#/$defs/ipv6"`
 	FavColor    string                 `json:"fav_color,omitempty" jsonschema:"enum=red,enum=green,enum=blue"`
 }
 
@@ -93,6 +95,29 @@ func ExampleReflect() {
 	//             }
 	//           ]
 	//         },
+	//         "ip_address": {
+	//           "oneOf": [
+	//             {
+	//               "$ref": "#/$defs/ipv4"
+	//             },
+	//             {
+	//               "$ref": "#/$defs/ipv6"
+	//             }
+	//           ]
+	//         },
+	//         "ip_addresses": {
+	//           "items": {
+	//             "oneOf": [
+	//               {
+	//                 "$ref": "#/$defs/ipv4"
+	//               },
+	//               {
+	//                 "$ref": "#/$defs/ipv6"
+	//               }
+	//             ]
+	//           },
+	//           "type": "array"
+	//         },
 	//         "fav_color": {
 	//           "type": "string",
 	//           "enum": [

diff --git a/fixtures/oneof.json b/fixtures/oneof.json
@@ -82,6 +82,19 @@
         },
         "child": {
           "$ref": "#/$defs/ChildOneOf"
+        },
+        "field6": {
+          "oneOf": [
+            {
+              "$ref": "Outer"
+            },
+            {
+              "$ref": "OuterNamed"
+            },
+            {
+              "$ref": "OuterPtr"
+            }
+          ]
         }
       },
       "additionalProperties": false,

diff --git a/reflect.go b/reflect.go
@@ -723,6 +723,21 @@ func (t *Schema) genericKeywords(tags []string, parent *Schema, propertyName str
 					parent.AnyOf = append(parent.AnyOf, typeFound)
 				}
 				typeFound.Required = append(typeFound.Required, propertyName)
+			case "oneof_ref":
+				subSchema := t
+				if t.Items != nil {
+					subSchema = t.Items
+				}
+				if subSchema.OneOf == nil {
+					subSchema.OneOf = make([]*Schema, 0, 1)
+				}
+				subSchema.Ref = ""
+				refs := strings.Split(nameValue[1], ";")
+				for _, r := range refs {
+					subSchema.OneOf = append(subSchema.OneOf, &Schema{
+						Ref: r,
+					})
+				}
 			case "oneof_type":
 				if t.OneOf == nil {
 					t.OneOf = make([]*Schema, 0, 1)

diff --git a/reflect_test.go b/reflect_test.go
@@ -138,6 +138,7 @@ type RootOneOf struct {
 	Field3 interface{} `json:"field3" jsonschema:"oneof_type=string;array"`
 	Field4 string      `json:"field4" jsonschema:"oneof_required=group1"`
 	Field5 ChildOneOf  `json:"child"`
+	Field6 interface{} `json:"field6" jsonschema:"oneof_ref=Outer;OuterNamed;OuterPtr"`
 }
 
 type ChildOneOf struct {