Merge branch 'rendering-tests-no-merge' of github.com:box/box-openapi…

… into staging
box · Sep 30, 2024 · a189cc4 · a189cc4
2 parents 44edb86 + 74e21fd
commit a189cc4
Showing 1 changed file with 180 additions and 2 deletions.
diff --git a/openapi.json b/openapi.json
@@ -14,7 +14,7 @@
       "url": "http://www.apache.org/licenses/LICENSE-2.0"
     },
     "version": "2.0.0",
-    "x-box-commit-hash": "76b3e9a8ea"
+    "x-box-commit-hash": ""
   },
   "servers": [
     {
@@ -25078,6 +25078,174 @@
           }
         ]
       },
+      "DocgenTemplateCreateRequest": {
+        "title": "Marking file as Docgen Template",
+        "type": "object",
+        "description": "The schema for marking document as Docgen Template.",
+        "required": [
+          "file"
+        ],
+        "properties": {
+          "file": {
+            "allOf": [
+              {
+                "title": "File reference",
+                "type": "object",
+                "description": "File reference",
+                "required": [
+                  "type",
+                  "id"
+                ],
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "description": "`file`",
+                    "example": "file",
+                    "enum": [
+                      "file"
+                    ],
+                    "nullable": false
+                  },
+                  "id": {
+                    "description": "ID of the object",
+                    "type": "string",
+                    "example": "42037322"
+                  }
+                }
+              },
+              {
+                "description": "Enable the file to create a docgen document from."
+              }
+            ]
+          }
+        }
+      },
+      "DocgenBatchCreateRequest": {
+        "title": "Create batch request",
+        "type": "object",
+        "description": "The schema for Docgen Document Generation post job request.",
+        "required": [
+          "file",
+          "input_source",
+          "destination_folder",
+          "output_type",
+          "document_generation_data"
+        ],
+        "properties": {
+          "file": {
+            "allOf": [
+              {
+                "title": "File reference",
+                "type": "object",
+                "description": "File reference",
+                "required": [
+                  "type",
+                  "id"
+                ],
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "description": "`file`",
+                    "example": "file",
+                    "enum": [
+                      "file"
+                    ],
+                    "nullable": false
+                  },
+                  "id": {
+                    "description": "ID of the object",
+                    "type": "string",
+                    "example": "42037322"
+                  }
+                }
+              },
+              {
+                "description": "Template file."
+              }
+            ]
+          },
+          "file_version": {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/FileVersion--Base"
+              },
+              {
+                "description": "File version of a template."
+              }
+            ]
+          },
+          "input_source": {
+            "type": "string",
+            "description": "source of input.",
+            "example": "api"
+          },
+          "destination_folder": {
+            "allOf": [
+              {
+                "title": "Folder reference",
+                "type": "object",
+                "description": "Folder reference",
+                "required": [
+                  "type",
+                  "id"
+                ],
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "description": "`folder`",
+                    "example": "folder",
+                    "enum": [
+                      "folder"
+                    ],
+                    "nullable": false
+                  },
+                  "id": {
+                    "description": "ID of the folder",
+                    "type": "string",
+                    "example": "42037322"
+                  }
+                }
+              },
+              {
+                "description": "Destination folder for generated files."
+              }
+            ]
+          },
+          "output_type": {
+            "type": "string",
+            "description": "Type of the output file.",
+            "example": "docx"
+          },
+          "document_generation_data": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DocgenDocumentGenerationData"
+            }
+          }
+        }
+      },
+      "DocgenDocumentGenerationData": {
+        "title": "Document generation data",
+        "type": "object",
+        "description": "The schema for Docgen Document Generation post job request.",
+        "required": [
+          "generated_file_name",
+          "user_input"
+        ],
+        "properties": {
+          "generated_file_name": {
+            "type": "string",
+            "example": "New_Template",
+            "description": "File name of the output file"
+          },
+          "user_input": {
+            "type": "object",
+            "example": {
+              "name": "Aaron Levie"
+            }
+          }
+        }
+      },
       "IntegrationMappingSlackCreateRequest": {
         "title": "Create Slack integration mapping request",
         "type": "object",
@@ -25839,7 +26007,7 @@
         "title": "App item",
         "type": "object",
         "x-box-tag": "app_item_associations",
-        "x-box-resource-id": "app_item_associations",
+        "x-box-resource-id": "app_item",
         "description": "An app item represents an content object owned by an application. It can\ngroup files and folders together from different paths. That set can be shared\nvia a collaboration.",
         "required": [
           "id",
@@ -39616,6 +39784,16 @@
       "description": "Device pinners allow enterprises to\ncontrol what devices can use\nnative Box applications.",
       "x-box-tag": "device_pinners"
     },
+    {
+      "name": "Docgen",
+      "description": "Docgen are used to generate documents\nusing a template.",
+      "x-box-tag": "docgen"
+    },
+    {
+      "name": "Docgen template",
+      "description": "Docgen are used to generate documents\nusing a template.",
+      "x-box-tag": "docgen_template"
+    },
     {
       "name": "Domain restrictions (User exemptions)",
       "description": "A set of endpoints that allow exempting users\nfrom restrictions imposed by the list of\nallowed collaboration domains for a specific enterprise.",