Replace JSONSchemaProps with a dummy object type to prevent circula…

…r references
hectorm · Feb 4, 2024 · c215f95 · c215f95
1 parent e4c9185
commit c215f95
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 33 deletions.
diff --git a/src/fixtures/kubernetes/schemas/_definitions.json b/src/fixtures/kubernetes/schemas/_definitions.json
@@ -2797,6 +2797,9 @@
           "type": "integer"
         }
       ]
+    },
+    "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps": {
+      "type": "object"
     }
   }
 }
diff --git a/src/fixtures/kubernetes/schemas/all.json b/src/fixtures/kubernetes/schemas/all.json
@@ -266,6 +266,9 @@
     },
     {
       "$ref": "_definitions.json#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
+    },
+    {
+      "$ref": "_definitions.json#/definitions/io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps"
     }
   ]
 }
diff --git a/src/openapi2jsonschema/command.py b/src/openapi2jsonschema/command.py
@@ -10,6 +10,7 @@
 import jsonschema  # type: ignore
 import yaml
 
+from .definitions import kubernetes_definitions
 from .errors import UnsupportedError
 from .log import debug, error, info
 from .util import (
@@ -91,24 +92,18 @@ def default(output, schema, prefix, stand_alone, expanded, kubernetes, strict):
             info("Generating shared definitions")
             definitions = data["definitions"]
             if kubernetes:
-                definitions["io.k8s.apimachinery.pkg.util.intstr.IntOrString"] = {
-                    "oneOf": [{"type": "string"}, {"type": "integer"}]
-                }
-                # Although the kubernetes api does not allow `number` as valid
-                # Quantity type - almost all kubenetes tooling
-                # recognizes it is valid. For this reason, we extend the API definition to
-                # allow `number` values.
-                definitions["io.k8s.apimachinery.pkg.api.resource.Quantity"] = {
-                    "oneOf": [{"type": "string"}, {"type": "number"}]
-                }
-
+                # Add Kubernetes specific definitions
+                definitions.update(kubernetes_definitions)
                 for type_name in definitions:
                     type_def = definitions[type_name]
+                    # Skip non-object types
+                    if not isinstance(type_def.get("properties"), dict):
+                        continue
                     # For Kubernetes, populate `apiVersion` and `kind` properties from `x-kubernetes-group-version-kind`
                     has_group_version_kind = (
                         "x-kubernetes-group-version-kind" in type_def
                     )
-                    for prop_name in type_def.get("properties", []):
+                    for prop_name in type_def["properties"]:
                         if prop_name == "apiVersion":
                             if has_group_version_kind and expanded:
                                 for kube_ext in type_def[
@@ -131,7 +126,9 @@ def default(output, schema, prefix, stand_alone, expanded, kubernetes, strict):
                                 ]:
                                     kind = kube_ext["kind"]
                                     append_no_duplicates(
-                                        type_def["properties"]["kind"], "enum", kind
+                                        type_def["properties"]["kind"],
+                                        "enum",
+                                        kind,
                                     )
                         # Enum values in properties should be unique
                         if "enum" in type_def["properties"][prop_name]:
@@ -191,26 +188,6 @@ def default(output, schema, prefix, stand_alone, expanded, kubernetes, strict):
                         % title
                     )
 
-            # This list of Kubernetes types carry around jsonschema for Kubernetes and don't
-            # currently work with openapi2jsonschema
-            if (
-                kubernetes
-                and stand_alone
-                and kind
-                in [
-                    "jsonschemaprops",
-                    "jsonschemapropsorarray",
-                    "customresourcevalidation",
-                    "customresourcedefinition",
-                    "customresourcedefinitionspec",
-                    "customresourcedefinitionlist",
-                    "customresourcedefinitionspec",
-                    "jsonschemapropsorstringarray",
-                    "jsonschemapropsorbool",
-                ]
-            ):
-                raise UnsupportedError("%s not currently supported" % kind)
-
             updated = change_dict_values(specification, prefix, version)
             specification = updated
 

diff --git a/src/openapi2jsonschema/definitions.py b/src/openapi2jsonschema/definitions.py
@@ -0,0 +1,17 @@
+kubernetes_definitions = {
+    # Although the kubernetes api does not allow `number` as valid
+    # Quantity type - almost all kubenetes tooling
+    # recognizes it is valid. For this reason, we extend the API definition to
+    # allow `number` values.
+    "io.k8s.apimachinery.pkg.util.intstr.IntOrString": {
+        "oneOf": [{"type": "string"}, {"type": "integer"}]
+    },
+    "io.k8s.apimachinery.pkg.api.resource.Quantity": {
+        "oneOf": [{"type": "string"}, {"type": "number"}]
+    },
+    # Replace `JSONSchemaProps` with a dummy object type to prevent circular
+    # references
+    "io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps": {
+        "type": "object",
+    },
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -266,6 +266,9 @@ @@
         },
         {
           "$ref": "_definitions.json#/definitions/io.k8s.apimachinery.pkg.util.intstr.IntOrString"
+        },
+        {
+          "$ref": "_definitions.json#/definitions/io.k8s.apiextensions-apiserver.pkg.apis.apiextensions.v1.JSONSchemaProps"
         }
       ]
     }