fix: reference existing schemas in Doc Gen job ouput_file and output_…

…file_version properties
box · Jan 17, 2025 · 44e4af6 · 44e4af6
1 parent e24a77b
commit 44e4af6
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 34 deletions.
diff --git a/openapi.json b/openapi.json
@@ -14,7 +14,7 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     },
     "version": "2024.0",
-    "x-box-commit-hash": "0ccd59946a"
+    "x-box-commit-hash": "1428271b4b"
   },
   "servers": [
     {

diff --git a/openapi/openapi-v2025.0.json b/openapi/openapi-v2025.0.json
@@ -14,7 +14,7 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     },
     "version": "2025.0",
-    "x-box-commit-hash": "0ccd59946a"
+    "x-box-commit-hash": "1428271b4b"
   },
   "servers": [
     {
@@ -1087,7 +1087,8 @@
             "type": "object",
             "example": {
               "name": "Aaron Levie"
-            }
+            },
+            "additionalProperties": {}
           }
         },
         "required": [
@@ -1136,44 +1137,46 @@
                 ]
               },
               "output_file": {
-                "description": "The output file of the job.",
-                "type": "object",
-                "nullable": true,
-                "properties": {
-                  "type": {
-                    "description": "`file`",
-                    "type": "string",
-                    "example": "file",
-                    "enum": [
-                      "file"
+                "allOf": [
+                  {
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/FileReference"
+                      },
+                      {
+                        "title": "OpenAPI 3.0 null schema type",
+                        "description": "The definition for a null schema type in OpenAPI 3.0",
+                        "type": "object",
+                        "nullable": true,
+                        "additionalProperties": false
+                      }
                     ]
                   },
-                  "id": {
-                    "description": "ID of the object.",
-                    "type": "string",
-                    "example": "42037322"
+                  {
+                    "description": "The output file of the job. This property is `null` until the job is completed."
                   }
-                }
+                ]
               },
               "output_file_version": {
-                "description": "File version of generated file.",
-                "type": "object",
-                "nullable": true,
-                "properties": {
-                  "type": {
-                    "description": "`file_version`",
-                    "type": "string",
-                    "example": "file_version",
-                    "enum": [
-                      "file_version"
+                "allOf": [
+                  {
+                    "oneOf": [
+                      {
+                        "$ref": "#/components/schemas/FileVersion--Base"
+                      },
+                      {
+                        "title": "OpenAPI 3.0 null schema type",
+                        "description": "The definition for a null schema type in OpenAPI 3.0",
+                        "type": "object",
+                        "nullable": true,
+                        "additionalProperties": false
+                      }
                     ]
                   },
-                  "id": {
-                    "description": "ID of the object.",
-                    "type": "string",
-                    "example": "42037322"
+                  {
+                    "description": "File version of the output file. This property is `null` until the job is completed."
                   }
-                }
+                ]
               },
               "status": {
                 "description": "Status of the job.",

diff --git a/openapi/openapi.json b/openapi/openapi.json
@@ -14,7 +14,7 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     },
     "version": "2024.0",
-    "x-box-commit-hash": "0ccd59946a"
+    "x-box-commit-hash": "1428271b4b"
   },
   "servers": [
     {