Added missing docs and organized sample files (#97)

Co-authored-by: Adam Bem <adam.bem@zoho.eu>
Reviewed-on: R11/release11-tools-web#97

SampleData/functions20

@@ -1,129 +0,0 @@
-abs(
-adjust-dateTime-to-timezone(
-adjust-date-to-timezone(
-adjust-time-to-timezone(
-avg(
-base-uri(
-boolean(
-ceiling(
-codepoints-to-string(
-collection(
-compare(
-concat(
-contains(
-context-item(
-count(
-current(
-current-date(
-current-dateTime(
-current-group(
-current-grouping-key(
-current-time(
-data(
-day-from-date(
-day-from-dateTime(
-days-from-dayTimeDuration(
-deep-equal(
-default-collation(
-distinct-nodes(
-distinct-values(
-doc(
-document(
-document-uri(
-element-available(
-empty(
-ends-with(
-error(
-escape-uri(
-exactly-one(
-exists(
-expanded-QName(
-false(
-floor(
-format-date(
-format-dateTime(
-format-number(
-format-time(
-function-available(
-generate-id(
-hours-from-dateTime(
-hours-from-dayTimeDuration(
-hours-from-time(
-id(
-idref(
-implicit-timezone(
-index-of(
-input(
-in-scope-prefixes(
-insert-before(
-item-at(
-key(
-lang(
-last(
-local-name(
-local-name-from-QName(
-lower-case(
-matches(
-max(
-min(
-minutes-from-dateTime(
-minutes-from-dayTimeDuration(
-minutes-from-time(
-month-from-date(
-month-from-dateTime(
-months-from-yearMonthDuration(
-name(
-namespace-uri(
-namespace-uri-for-prefix(
-namespace-uri-from-QName(
-node-kind(
-node-name(
-normalize-space(
-normalize-unicode(
-not(
-number(
-one-or-more(
-position(
-regex-group(
-remove(
-replace(
-resolve-QName(
-resolve-uri(
-reverse(
-root(
-round(
-round-half-to-even(
-seconds-from-dateTime(
-seconds-from-dayTimeDuration(
-seconds-from-time(
-sequence-node-identical(
-starts-with(
-string(
-string-join(
-string-length(
-string-pad(
-string-to-codepoints(
-subsequence(
-substring(
-substring-after(
-substring-before(
-subtract-dateTimes-yielding-dayTimeDuration(
-subtract-dateTimes-yielding-yearMonthDuration(
-sum(
-system-property(
-timezone-from-date(
-timezone-from-dateTime(
-timezone-from-time(
-tokenize(
-trace(
-translate(
-true(
-unordered(
-unparsed-entity-public-id(
-unparsed-entity-uri(
-unparsed-text(
-upper-case(
-year-from-date(
-year-from-dateTime(
-years-from-yearMonthDuration(
-zero-or-one(

SampleData/sample_xml.xml

@@ -1,33 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<l:library xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.release11.com" xmlns:l="http://www.release11.com/library" xmlns:p="http://www.release11.com/person" xmlns:b="http://www.release11.com/book">
-    <l:libraryName>City library</l:libraryName>
-    <l:libraryID>345123</l:libraryID>
-    <l:readerList>
-        <p:person>
-            <p:readerID>7321</p:readerID>
-            <p:name>Adam</p:name>
-            <p:surname>Choke</p:surname>
-        </p:person>
-        <p:person>
-            <p:readerID>5123</p:readerID>
-            <p:name>Lauren</p:name>
-            <p:surname>Wong</p:surname>
-        </p:person>
-    </l:readerList>
-    <l:bookList>
-        <b:book>
-            <b:bookID>6422</b:bookID>
-            <b:title>Harry Potter</b:title>
-            <p:readerID>7542</p:readerID>
-        </b:book>
-        <b:book>
-            <b:bookID>1234</b:bookID>
-            <b:title>Macbeth</b:title>
-            <p:readerID>5123</p:readerID>
-        </b:book>
-        <b:book>
-            <b:bookID>9556</b:bookID>
-            <b:title>Romeo and Juliet</b:title>
-        </b:book>
-    </l:bookList>
-</l:library>

SampleData/transform.xslt

@@ -1,9 +0,0 @@
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:b="http://www.demo.com">
-    <xsl:template match="b:books">
-		<Library>
-			<BookCount>
-				<xsl:value-of select="count(b:book)" />
-			</BookCount>
-		</Library>
-    </xsl:template>
-</xsl:stylesheet>

Samples/xsd/sample.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ns0:values xmlns:ns0 = "http://www.tibco.com/schemas/test/Test/Resources/Schema.xsd">
+    <ns0:value>Test</ns0:value>
+    <ns0:value>Test3</ns0:value>
+</ns0:values>

Samples/xsd/schema.xsd

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://www.tibco.com/schemas/test/Test/Resources/Schema.xsd" targetNamespace="http://www.tibco.com/schemas/test/Test/Resources/Schema.xsd" elementFormDefault="qualified" attributeFormDefault="unqualified">
+    <xs:element name="values">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element name="value" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+</xs:schema>

Samples/xslt/sampleXSLT.xslt

@@ -0,0 +1,12 @@
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:b="http://www.demo.com" xmlns:p="http://www.release11.com/person" xmlns:l="http://www.release11.com/library">
+    <xsl:template match="/">
+		<Library>
+			<ReaderCount>
+				<xsl:value-of select="count(//p:person)" />
+			</ReaderCount>
+            <BookCount>
+				<xsl:value-of select="count(/l:library/l:bookList/b:book)" />
+			</BookCount>
+		</Library>
+    </xsl:template>
+</xsl:stylesheet>

Swagger/swagger.json

@@ -30,6 +30,10 @@
     {
       "name": "Mocked services",
       "description": "Mocked services controller"
+    },
+    {
+      "name": "XML Formatter",
+      "description": "XML formatting API"
     }
   ],
   "paths": {
@@ -38,7 +42,7 @@
         "tags": [
           "Mocked events"
         ],
-        "summary": "filterHistory",
+        "summary": "Filter History",
         "operationId": "filterHistoryUsingPOST",
         "consumes": [
           "application/json"
@@ -84,7 +88,7 @@
         "tags": [
           "Mocked events"
         ],
-        "summary": "getLastDay",
+        "summary": "Get last day",
         "operationId": "getLastDayUsingGET",
         "produces": [
           "*/*"
@@ -131,7 +135,7 @@
         "tags": [
           "Mocked services"
         ],
-        "summary": "updateMessage",
+        "summary": "Update message",
         "operationId": "updateMessageUsingPUT",
         "consumes": [
           "application/json"
@@ -177,7 +181,7 @@
         "tags": [
           "Mocked services"
         ],
-        "summary": "getListOfMessages",
+        "summary": "Get list of messages",
         "operationId": "getListOfMessagesUsingGET",
         "produces": [
           "*/*"
@@ -218,7 +222,7 @@
         "tags": [
           "Mocked services"
         ],
-        "summary": "getMockedResponse",
+        "summary": "Get response from mocked service",
         "operationId": "getMockedResponseUsingGET",
         "produces": [
           "*/*"
@@ -300,7 +304,7 @@
         "tags": [
           "Mocked services"
         ],
-        "summary": "getListOfMessages",
+        "summary": "Get list of messages",
         "operationId": "getListOfMessagesUsingGET_1",
         "produces": [
           "*/*"
@@ -383,7 +387,7 @@
         "tags": [
           "Mocked services"
         ],
-        "summary": "removeMessage",
+        "summary": "Remove message",
         "operationId": "removeMessageUsingDELETE",
         "produces": [
           "*/*"
@@ -645,6 +649,100 @@
           }
         }
       }
+    },
+    "/minimize": {
+      "post": {
+        "tags": [
+          "XML Formatter"
+        ],
+        "summary": "Minimize given XML (only libxml)",
+        "description": "Removes any unneeded whitespace from given xml file",
+        "operationId": "minimize",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "request",
+            "description": "A XML to minimize",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/RequestPrettify"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/MinimizedResponse"
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid status value",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/XSDError"
+              }
+            }
+          }
+        }
+      }
+    },
+    "/prettify": {
+      "post": {
+        "tags": [
+          "XML Formatter"
+        ],
+        "summary": "Prettify given XML (only libxml)",
+        "description": "Removes any unneeded whitespace from given xml file",
+        "operationId": "minimize",
+        "consumes": [
+          "application/json"
+        ],
+        "produces": [
+          "application/json"
+        ],
+        "parameters": [
+          {
+            "in": "body",
+            "name": "request",
+            "description": "A XML to prettify",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/RequestMinimize"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful operation",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/MinimizedResponse"
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid status value",
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/definitions/XSDError"
+              }
+            }
+          }
+        }
+      }
     }
   },
   "definitions": {
@@ -794,7 +892,7 @@
       "properties": {
         "data": {
           "type": "string",
-          "example": " Test1 Test3 ",
+          "example": "<values><value>2</value><value>8</value></values>",
           "description": "The XML data to be processed"
         },
         "process": {
@@ -824,7 +922,7 @@
       "properties": {
         "data": {
           "type": "string",
-          "example": " Test1 Test3 ",
+          "example": "<values><value>2</value><value>8</value></values>",
           "description": "The XML data to be processed"
         },
         "process": {
@@ -854,12 +952,12 @@
       "properties": {
         "data": {
           "type": "string",
-          "example": "  Ola Nordmann Langgt 23 4000 Stavanger Norway  ",
+          "example": "<values><value>2</value><value>8</value></values>",
           "description": "The XML data to be processed"
         },
         "process": {
           "type": "string",
-          "example": "  Ola Nordmann Langgt 23 4000 Stavanger Norway  ",
+          "example": "<xs:schema xmlns:xs=\"http://www.w3.org/2001/XMLSchema\" xmlns=\"http://www.tibco.com/schemas/test/Test/Resources/Schema.xsd\" targetNamespace=\"http://www.tibco.com/schemas/test/Test/Resources/Schema.xsd\" elementFormDefault=\"qualified\" attributeFormDefault=\"unqualified\"> <xs:element name=\"values\"><xs:complexType><xs:sequence><xs:element name=\"value\" type=\"xs:string\" minOccurs=\"0\" maxOccurs=\"unbounded\"/></xs:sequence></xs:complexType></xs:element></xs:schema>",
           "description": "XSD to perform verification with"
         },
         "processor": {
@@ -896,7 +994,8 @@
           "type": "string",
           "enum": [
             "Saxon 10.3 2.0 over s9api",
-            "Xalan Java 2.7.2"
+            "Xalan Java 2.7.2",
+            "libXml over lxml"
           ]
         },
         "status": {
@@ -924,7 +1023,8 @@
           "type": "string",
           "enum": [
             "Saxon 10.3 2.0 over s9api",
-            "Xalan Java 2.7.2"
+            "Xalan Java 2.7.2",
+            "libXml over lxml"
           ]
         },
         "status": {
@@ -988,6 +1088,114 @@
           ]
         }
       }
+    },
+    "RequestPrettify": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "string",
+          "example": "<values><value>2</value><value>8</value></values>",
+          "description": "The XML data to be prettified"
+        },
+        "process": {
+          "type": "string",
+          "example": "",
+          "description": "Unused here, required only to use same json for whole project"
+        },
+        "processor": {
+          "type": "string",
+          "enum": [
+            "libxml"
+          ]
+        },
+        "version": {
+          "type": "string",
+          "enum": [
+            "1.0"
+          ]
+        }
+      }
+    },
+    "RequestMinimize": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "string",
+          "example": "<values><value>2</value><value>8</value></values>",
+          "description": "The XML data to be minimized"
+        },
+        "process": {
+          "type": "string",
+          "example": "",
+          "description": "Unused here, required only to use same json for whole project"
+        },
+        "processor": {
+          "type": "string",
+          "enum": [
+            "libxml"
+          ]
+        },
+        "version": {
+          "type": "string",
+          "enum": [
+            "1.0"
+          ]
+        }
+      }
+    },
+    "PrettifiedResponse": {
+      "type": "object",
+      "properties": {
+        "result": {
+          "type": "string",
+          "example": "<values>\\n\\t<value>2</value>\\n\\t<value>8</value>\\n</values>",
+          "description": "Prettified XML"
+        },
+        "time": {
+          "type": "string",
+          "example": "320",
+          "description": "Computation time in milliseconds"
+        },
+        "processor": {
+          "type": "string",
+          "enum": [
+            "libXml over lxml"
+          ]
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "OK"
+          ]
+        }
+      }
+    },
+    "MinimizedResponse": {
+      "type": "object",
+      "properties": {
+        "result": {
+          "type": "string",
+          "example": "<values><value>2</value><value>8</value></values>",
+          "description": "Result of minimized provided XML"
+        },
+        "time": {
+          "type": "string",
+          "example": "320",
+          "description": "Computation time in milliseconds"
+        },
+        "processor": {
+          "type": "string",
+          "enum": [
+            "libXml over lxml"
+          ]
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "OK"
+          ]
+        }
+      }
     }
   },
   "externalDocs": {