Replace nullable: true with OpenAPI 3.1.0 type arrays on 14 properties

Author: beran-t

openapi-public.yml

@@ -3174,18 +3174,21 @@ components:
         envdVersion:
           $ref: '#/components/schemas/EnvdVersion'
         envdAccessToken:
-          type: string
+          type:
+          - string
+          - 'null'
           description: 'Access token for authenticating envd requests to this sandbox.
             Only returned when the sandbox is created with `secure: true`. Null for
             non-secure sandboxes (envd endpoints work without auth).'
-          nullable: true
         trafficAccessToken:
-          type: string
-          nullable: true
+          type:
+          - string
+          - 'null'
           description: Token required for accessing sandbox via proxy.
         domain:
-          type: string
-          nullable: true
+          type:
+          - string
+          - 'null'
           description: 'Deprecated: always null. Construct sandbox URLs as `https://{port}-{sandboxID}.e2b.app`.'
           deprecated: true
       type: object
@@ -3226,14 +3229,16 @@ components:
         envdVersion:
           $ref: '#/components/schemas/EnvdVersion'
         envdAccessToken:
-          type: string
+          type:
+          - string
+          - 'null'
           description: 'Access token for authenticating envd requests to this sandbox.
             Only returned when the sandbox is created with `secure: true`. Null for
             non-secure sandboxes (envd endpoints work without auth).'
-          nullable: true
         domain:
-          type: string
-          nullable: true
+          type:
+          - string
+          - 'null'
           description: 'Deprecated: always null. Construct sandbox URLs as `https://{port}-{sandboxID}.e2b.app`.'
           deprecated: true
         cpuCount:
@@ -3473,12 +3478,13 @@ components:
           format: date-time
           description: Time when the template was last updated
         createdBy:
-          allOf:
+          oneOf:
           - $ref: '#/components/schemas/TeamUser'
-          nullable: true
+          - type: 'null'
         lastSpawnedAt:
-          type: string
-          nullable: true
+          type:
+          - string
+          - 'null'
           format: date-time
           description: Time when the template was last used
         spawnCount:
@@ -3575,12 +3581,13 @@ components:
           format: date-time
           description: Time when the template was last updated
         createdBy:
-          allOf:
+          oneOf:
           - $ref: '#/components/schemas/TeamUser'
-          nullable: true
+          - type: 'null'
         lastSpawnedAt:
-          type: string
-          nullable: true
+          type:
+          - string
+          - 'null'
           format: date-time
           description: Time when the template was last used
         spawnCount:
@@ -3675,8 +3682,9 @@ components:
           format: date-time
           description: Time when the template was last updated
         lastSpawnedAt:
-          type: string
-          nullable: true
+          type:
+          - string
+          - 'null'
           format: date-time
           description: Time when the template was last used
         spawnCount:

scripts/generate_openapi_reference.py

@@ -1119,6 +1119,39 @@ def _singularize(word: str) -> str:
     if summary_count:
         fixes.append(f"Added summary to {summary_count} platform endpoints")
 
+    # 27. Replace nullable: true with OpenAPI 3.1.0 type arrays
+    #     In 3.1.0, nullable was removed. Use type: ["string", "null"] instead,
+    #     or oneOf with type: 'null' for $ref properties.
+    nullable_fixed = 0
+    for schema_name, schema in schemas.items():
+        if "properties" not in schema:
+            continue
+        for prop_name, prop in schema["properties"].items():
+            if not isinstance(prop, dict) or not prop.pop("nullable", False):
+                continue
+            # allOf + nullable → oneOf: [allOf[...], type: 'null']
+            if "allOf" in prop:
+                all_of = prop.pop("allOf")
+                prop["oneOf"] = all_of + [{"type": "null"}]
+            # plain type + nullable → type: [original, "null"]
+            elif "type" in prop:
+                orig_type = prop["type"]
+                if isinstance(orig_type, list):
+                    if "null" not in orig_type:
+                        orig_type.append("null")
+                else:
+                    prop["type"] = [orig_type, "null"]
+            # $ref + nullable → oneOf: [$ref, type: 'null']
+            elif "$ref" in prop:
+                ref = prop.pop("$ref")
+                prop["oneOf"] = [{"$ref": ref}, {"type": "null"}]
+            # additionalProperties + nullable (e.g. McpConfig)
+            elif "additionalProperties" in prop:
+                prop["type"] = ["object", "null"]
+            nullable_fixed += 1
+    if nullable_fixed:
+        fixes.append(f"Replaced nullable: true with 3.1.0 type arrays on {nullable_fixed} properties")
+
     if fixes:
         print(f"==> Fixed {len(fixes)} spec issues:")
         for f in fixes: