Merge branch 'release/1.6.0' into main

.gitlab-ci.yml

@@ -7,7 +7,7 @@ stages:
 
 build-develop:
   except:
-      - master
+      - main
       - tags
   stage: build
   script:
@@ -18,12 +18,12 @@ build-develop:
       - build/*.xar
       - test/
 
-build-master:
+build-main:
   only:
-      - master
+      - main
   stage: build
   script:
-    - cp master.build.properties local.build.properties
+    - cp main.build.properties local.build.properties
     - npm install
     - ant test
   artifacts:
@@ -52,7 +52,7 @@ installation:
 
 upload:
   only:
-      - master
+      - main
       - develop
   except:
       - tags

build.properties

 project.name=https://lab.sub.uni-goettingen.de/openapi4restxq-develop
-project.version=1.5.1
+project.version=1.6.0
 project.title=OpenAPI for RESTXQ
 project.abbrev=openapi-develop
 project.processorversion=4.6.1

content/openapi-tests-full.xqm

@@ -23,20 +23,20 @@ declare namespace output = "http://www.w3.org/2010/xslt-xquery-serialization";
  : @see http://example.com/documentation/about/this
  :)
 declare
-%rest:POST("{$body}")
-%rest:consumes("application/xml", "text/xml")
-%rest:path("/openapi-test/full/post/{$paramPath}/{$int}.{$format}")
-%rest:query-param("getParam", "{$getParam}", "2019")
-
-%rest:produces("application/json")
-
-%output:method("json")
-
-%test:arg("paramPath", "here")
-%test:arg("int", "123")
-%test:arg("format", "xquery")
-%test:arg("getParam", "and-get")
-%test:arg("body", "<incomming><node/></incomming>")
+    %rest:POST("{$body}")
+    %rest:consumes("application/xml", "text/xml")
+    %rest:path("/openapi-test/full/post/{$paramPath}/{$int}.{$format}")
+    %rest:query-param("getParam", "{$getParam}", "2019")
+    
+    %rest:produces("application/xml" ,"text/xml")
+    
+    %output:method("json")
+    
+    %test:arg("paramPath", "here")
+    %test:arg("int", "123")
+    %test:arg("format", "xquery")
+    %test:arg("getParam", "and-get")
+    %test:arg("body", "<incoming><node/></incoming>")
 function openapi-test-full:post(
     $paramPath as xs:string,
     $int as xs:int,

content/openapi.xqm

@@ -17,7 +17,7 @@ declare namespace repo="http://exist-db.org/xquery/repo";
 declare %private variable $openapi:supported-methods := ("rest:GET", "rest:HEAD", "rest:POST", "rest:PUT", "rest:DELETE");
 
 (:~
- : Prepares a JSON document usually to be stored as "openapi.json".
+ : Prepares a JSON document conform to OpenAPI 3.0.2, usually to be stored as "openapi.json".
  : @param $target the collection to prepare the descriptor for, e.g. “/db/apps/application”
  :   :)
 declare function openapi:json($target as xs:string)
@@ -34,7 +34,7 @@ as xs:string {
  :)
 declare function openapi:main($target as xs:string)
 as map(*) {
-  let $modules-uris := collection($target)[ends-with(base-uri(), ".xqm")]/base-uri()
+  let $modules-uris := collection($target)[openapi:xquery-resource(string(base-uri()))]/base-uri()
   let $module :=
     for $module in $modules-uris
     let $test4rest := contains(util:binary-doc($module) => util:base64-decode(), "%rest:")
@@ -174,7 +174,7 @@ as map(*) {
       $method:
       map:merge((
         map{ "summary": $desc[1]},
-        map{ "description": $desc[2]},
+        $desc[2] ! map{ "description": .},
         map{ "tags": $tags},
         $see[1] ! map{"externalDocs": $see ! map{
           "url": .,
@@ -316,15 +316,19 @@ as map(*)* {
 declare %private function openapi:mediaType-object($function)
 as map(*) {
   let $produces := (
-        string($function/annotation[@name="rest:produces"]),
+        $function/annotation[@name="rest:produces"]/string(value),
         string($function/annotation[@name="output:media-type"]),
         string($function/annotation[@name="output:method"]/openapi:method-mediaType(string(.))),
         "application/xml"
       )
   return
-    map{
-      $produces[. != ""][1]: openapi:schema-object($function/returns)
-    }
+      map:merge(
+          for $iii in 1 to count($produces) return
+              if($produces[$iii] = "") then
+                  ()
+              else
+                map:entry($produces[$iii], openapi:schema-object($function/returns))
+      )
 };
 
 (:~
@@ -410,3 +414,10 @@ as map(*)* {
     string(($function/annotation[@name = "test:arg"][value[1] eq $name])[1]/value[2])
     ! map{ "example": .}
 };
+
+declare function openapi:xquery-resource($baseuri as xs:string)
+as xs:boolean {
+     ends-with($baseuri, ".xqm")
+  or ends-with($baseuri, ".xql")
+  or ends-with($baseuri, ".xq")
+};

repo.xml

@@ -8,9 +8,27 @@
     <type>application</type>
     <target>openapi</target>
     <changelog>
+      <change version="1.6.0">
+        <ul xmlns="http://www.w3.org/1999/xhtml">
+          <li class="bugs">Bugfix
+            <ul style="margin-left: 15px;">
+              <li>fix incorrect array parsing of %rest:produces</li>
+            </ul>
+          </li>
+        </ul>
+      </change>
+      <change version="1.5.2">
+        <ul xmlns="http://www.w3.org/1999/xhtml">
+          <li class="bugs">Bugfix
+            <ul style="margin-left: 15px;">
+              <li>omit “null” on description</li>
+            </ul>
+          </li>
+        </ul>
+      </change>
       <change version="1.5.1">
         <ul xmlns="http://www.w3.org/1999/xhtml">
-          <li class="bugs">Bugfixes
+          <li class="bugs">Bugfix
             <ul style="margin-left: 15px;">
               <li>bugfix for string() call with multiple test annotations</li>
             </ul>