Merge branch 'master' into bugfix/camunda-collection

camunda · Nov 29, 2024 · f83aae5 · f83aae5
2 parents 4283f57 + 736692f
commit f83aae5
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 23 deletions.
diff --git a/engine-rest/engine-rest-openapi/README.md b/engine-rest/engine-rest-openapi/README.md
@@ -2,7 +2,7 @@ REST API - OpenAPI documentation generation
 ========
 
 This project generates a single openapi.json containing the OpeanAPI documentation of the Engine Rest API.
-Aligned with OpeanAPI specification version [3.0.2](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md).
+Aligned with OpenAPI specification version [3.0.2](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/versions/3.0.2.md).
 
 # Table of Contents
 1. [Build and phases](#build-and-phases)

diff --git a/engine-rest/engine-rest-openapi/src/main/templates/lib/utils.ftl b/engine-rest/engine-rest-openapi/src/main/templates/lib/utils.ftl
@@ -255,6 +255,7 @@
 <#macro response code desc
         flatType=""
         dto=""
+        contentDesc=""
         array=false
         additionalProperties=false
         mediaType="application/json"
@@ -270,6 +271,7 @@
                 array = array
                 additionalProperties = additionalProperties
                 mediaType = mediaType
+                contentDesc = contentDesc
                 binary = binary
                 examples = examples />
           },
@@ -296,6 +298,7 @@
                   array = type["array"]
                   additionalProperties = type["additionalProperties"]
                   mediaType = type["mediaType"]
+                  contentDesc = type["contentDesc"]
                   binary = type["binary"]
                   examples = type["examples"] /><#sep>,
             </#list>
@@ -314,6 +317,7 @@
         array=false
         additionalProperties=false
         mediaType="application/json"
+        contentDesc=""
         binary = false
         examples=[] >
            <#if mediaType == "application/xhtml+xml" | (mediaType == "application/json" & !array & flatType == "string") | binary>
@@ -327,6 +331,11 @@
              "${mediaType}": {
                "schema": {
 
+               <#if mediaType == "text/plain" && contentDesc?has_content>
+                   "type" : "string",
+                   "description" : "${contentDesc}"
+               </#if>
+
                  <#if array>
                    "type" : "array",
                    "items" : {

diff --git a/...rest/engine-rest-openapi/src/main/templates/paths/external-task/{id}/errorDetails/get.ftl b/...rest/engine-rest-openapi/src/main/templates/paths/external-task/{id}/errorDetails/get.ftl
@@ -21,27 +21,21 @@
 
   "responses" : {
 
-    "200": {
-      "description": "Request successful.",
-      "content": {
-        "text/plain": {
-          "schema": {
-            "type": "string",
-            "description": "The error details for the external task."
-          },
-          "examples": {
-            "example-1": {
-              "value": "org.apache.ibatis.jdbc.RuntimeSqlException: org.apache.ibatis.jdbc.RuntimeSqlException: test cause
-                  at org.camunda.bpm.engine.test.api.externaltask.ExternalTaskServiceTest.testHandleFailureWithErrorDetails(ExternalTaskServiceTest.java:1424)
-                  at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
-                  at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
-                  at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
-                "
-            }
-          }
-        }
-      }
-    },
+    <@lib.response
+    code = "200"
+    mediaType= "text/plain"
+    desc = "Request successful."
+    contentDesc = "The error details for the external task."
+    examples = ['"example-1": {
+                       "summary": "GET `external-task/someId/errorDetails`",
+                       "description": "GET `external-task/someId/errorDetails`",
+                       "value": "org.apache.ibatis.jdbc.RuntimeSqlException: org.apache.ibatis.jdbc.RuntimeSqlException: test cause
+                                      at org.camunda.bpm.engine.test.api.externaltask.ExternalTaskServiceTest.testHandleFailureWithErrorDetails(ExternalTaskServiceTest.java:1424)
+                                      at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
+                                      at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
+                                      at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
+                                      ..."
+                     }']/>
 
 
   <@lib.response

diff --git a/...est-openapi/src/main/templates/paths/history/external-task-log/{id}/error-details/get.ftl b/...est-openapi/src/main/templates/paths/history/external-task-log/{id}/error-details/get.ftl
@@ -28,6 +28,7 @@
         code = "200"
         mediaType= "text/plain"
         desc = "Request successful."
+        contentDesc = "Returns the error details of the historic external task log with the given ID."
         examples = ['"example-1": {
                        "summary": "GET `history/external-task-log/someId/error-details`",
                        "description": "GET `history/external-task-log/someId/error-details`",

diff --git a/...rest/engine-rest-openapi/src/main/templates/paths/history/job-log/{id}/stacktrace/get.ftl b/...rest/engine-rest-openapi/src/main/templates/paths/history/job-log/{id}/stacktrace/get.ftl
@@ -28,6 +28,7 @@
         code = "200"
         mediaType= "text/plain"
         desc = "Request successful."
+        contentDesc = "Returns the stacktrace of the exception for the historic job with the given ID."
         examples = ['"example-1": {
                        "summary": "response",
                        "description": "GET `history/job-log/someId/stacktrace`

diff --git a/engine-rest/engine-rest-openapi/src/main/templates/paths/job/{id}/stacktrace/get.ftl b/engine-rest/engine-rest-openapi/src/main/templates/paths/job/{id}/stacktrace/get.ftl
@@ -27,6 +27,7 @@
         code = "200"
         mediaType= "text/plain"
         desc = "Request successful."
+        contentDesc = "Returns the stacktrace of the exception for the job with the given ID."
         examples = ['"example-1": {
                        "description": "GET `/job/aJobId/stacktrace`",
                        "value": "java.lang.RuntimeException: A exception message!

diff --git a/parent/pom.xml b/parent/pom.xml
@@ -20,7 +20,7 @@
   <properties>
     <version.quarkus>3.15.0</version.quarkus>
     <version.spring.framework>5.3.39</version.spring.framework>
-    <version.spring.framework6>6.2.0</version.spring.framework6>
+    <version.spring.framework6>6.1.15</version.spring.framework6>
     <version.spring-boot>3.3.6</version.spring-boot>
     <version.resteasy>3.15.6.Final</version.resteasy>
     <version.jersey2>2.34</version.jersey2>