Adds documentation for max-file/request size (#251)

* Adds documentation for max-file/request size Signed-off-by: Mohammad Ghazanfar Ali Danish <ghazanfar.danish@iese.fraunhofer.de> * Corrects syntax Signed-off-by: Mohammad Ghazanfar Ali Danish <ghazanfar.danish@iese.fraunhofer.de> --------- Signed-off-by: Mohammad Ghazanfar Ali Danish <ghazanfar.danish@iese.fraunhofer.de>
eclipse-basyx · Mar 26, 2024 · bea27c7 · bea27c7
1 parent 34a5cd7
commit bea27c7
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/basyx.aasenvironment/Readme.md b/basyx.aasenvironment/Readme.md
@@ -47,5 +47,11 @@ AAS environments (e.g. XML, JSON, AASX) can be uploaded by a multipart/form-data
 
 The upload follows the same rules as the preconfiguration in terms of handling existing AAS, submodels and concept descriptions. In order for the file to be recognized correctly, please make sure that its MIME type is properly configured.
 
+**Note** 
+If the AAS Environment file (XML, JSON, or AASX) size exceeds the below mentioned default limit, it is important to set the below two properties in the application.properties based on the size of the file to be uploaded:
+
+	spring.servlet.multipart.max-file-size (default 1 MB)
+	spring.servlet.multipart.max-request-size (default 10 MB)
+
 ## AAS Environment Features
 * [AAS Environment Authorization](basyx.aasenvironment-feature-authorization)
diff --git a/...x.aasenvironment/basyx.aasenvironment.component/src/main/resources/application.properties b/...x.aasenvironment/basyx.aasenvironment.component/src/main/resources/application.properties
@@ -44,4 +44,18 @@ basyx.backend = InMemory
 ####################################################################################
 # This feature is enabled by default
 
-#basyx.submodelrepository.feature.operation.delegation.enabled = false
+#basyx.submodelrepository.feature.operation.delegation.enabled = false
+
+####################################################################################
+# Max File Size
+####################################################################################
+# To define the maximum size of file to be uploaded in a request (default 1 MB)
+
+# spring.servlet.multipart.max-file-size=128KB
+
+####################################################################################
+# Max Request Size
+####################################################################################
+# To define the total request size for a multipart/form-data (default 10 MB)
+
+# spring.servlet.multipart.max-request-size=128KB