Swagger docs (#188)

* added flask-cors to requirements.txt

* added exaple data and Info

* added ratelimit exception

* Bruno collection

* changed info message

docs/Bruno-Collection/BPMN-PNML-Transformer/BPMN to PNML.bru

@@ -0,0 +1,19 @@
+meta {
+  name: BPMN to PNML
+  type: http
+  seq: 2
+}
+
+post {
+  url: https://europe-west3-woped-422510.cloudfunctions.net/transform?direction=bpmntopnml
+  body: formUrlEncoded
+  auth: none
+}
+
+query {
+  direction: bpmntopnml
+}
+
+body:form-urlencoded {
+  bpmn: <?xml version="1.0" encoding="UTF-8"?> <bpmn:definitions xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI" xmlns:dc="http://www.omg.org/spec/DD/20100524/DC" xmlns:di="http://www.omg.org/spec/DD/20100524/DI" id="Definitions_0uh33yr" targetNamespace="http://bpmn.io/schema/bpmn" exporter="bpmn-js (https://demo.bpmn.io)" exporterVersion="17.6.2"> <bpmn:process id="Process_05gf0wk" isExecutable="false"> <bpmn:startEvent id="StartEvent_1kldrri"> <bpmn:outgoing>Flow_03wmhzd</bpmn:outgoing> </bpmn:startEvent> <bpmn:task id="Activity_16g2nsl" name="Task"> <bpmn:incoming>Flow_03wmhzd</bpmn:incoming> <bpmn:outgoing>Flow_06lknmg</bpmn:outgoing> </bpmn:task> <bpmn:sequenceFlow id="Flow_03wmhzd" sourceRef="StartEvent_1kldrri" targetRef="Activity_16g2nsl" /> <bpmn:endEvent id="Event_02tt0ub"> <bpmn:incoming>Flow_06lknmg</bpmn:incoming> </bpmn:endEvent> <bpmn:sequenceFlow id="Flow_06lknmg" sourceRef="Activity_16g2nsl" targetRef="Event_02tt0ub" /> </bpmn:process> <bpmndi:BPMNDiagram id="BPMNDiagram_1"> <bpmndi:BPMNPlane id="BPMNPlane_1" bpmnElement="Process_03gf0wk"> <bpmndi:BPMNShape id="_BPMNShape_StartEvent_2" bpmnElement="StartEvent_1kldrri"> <dc:Bounds x="156" y="82" width="36" height="36" /> </bpmndi:BPMNShape> <bpmndi:BPMNShape id="Activity_16g2nsl_di" bpmnElement="Activity_16g2nsl"> <dc:Bounds x="250" y="60" width="100" height="80" /> <bpmndi:BPMNLabel /> </bpmndi:BPMNShape> <bpmndi:BPMNShape id="Event_02tt0ub_di" bpmnElement="Event_02tt0ub"> <dc:Bounds x="412" y="82" width="36" height="36" /> </bpmndi:BPMNShape> <bpmndi:BPMNEdge id="Flow_03wmhzd_di" bpmnElement="Flow_03wmhzd"> <di:waypoint x="192" y="100" /> <di:waypoint x="250" y="100" /> </bpmndi:BPMNEdge> <bpmndi:BPMNEdge id="Flow_06lknmg_di" bpmnElement="Flow_06lknmg"> <di:waypoint x="350" y="100" /> <di:waypoint x="412" y="100" /> </bpmndi:BPMNEdge> </bpmndi:BPMNPlane> </bpmndi:BPMNDiagram> </bpmn:definitions>
+}

docs/Bruno-Collection/BPMN-PNML-Transformer/Health.bru

@@ -0,0 +1,15 @@
+meta {
+  name: Health
+  type: http
+  seq: 3
+}
+
+get {
+  url: https://europe-west3-woped-422510.cloudfunctions.net/health?message=testMessage
+  body: none
+  auth: none
+}
+
+query {
+  message: testMessage
+}

docs/Bruno-Collection/BPMN-PNML-Transformer/PNML to BPMN.bru

@@ -0,0 +1,19 @@
+meta {
+  name: PNML to BPMN
+  type: http
+  seq: 1
+}
+
+post {
+  url: https://europe-west3-woped-422510.cloudfunctions.net/transform?direction=pnmltobpmn
+  body: formUrlEncoded
+  auth: none
+}
+
+query {
+  direction: pnmltobpmn
+}
+
+body:form-urlencoded {
+  pnml: <?xml version="1.0" encoding="UTF-8"?> <!--PLEASE DO NOT EDIT THIS FILE Created with Workflow PetriNet Designer Version 3.2.0 (woped.org)--> <pnml> <net type="http://www.informatik.hu-berlin.de/top/pntd/ptNetb" id="noID"> <place id="p1"> <name> <text>p1</text> <graphics> <offset x="130" y="130"/> </graphics> </name> <graphics> <position x="130" y="90"/> <dimension x="40" y="40"/> </graphics> </place> <place id="p2"> <name> <text>p2</text> <graphics> <offset x="300" y="130"/> </graphics> </name> <graphics> <position x="300" y="90"/> <dimension x="40" y="40"/> </graphics> </place> <transition id="t1"> <name> <text>t1</text> <graphics> <offset x="220" y="130"/> </graphics> </name> <graphics> <position x="220" y="90"/> <dimension x="40" y="40"/> </graphics> <toolspecific tool="WoPeD" version="1.0"> <time>0</time> <timeUnit>1</timeUnit> <orientation>1</orientation> </toolspecific> </transition> <arc id="a1" source="p1" target="t1"> <inscription> <text>1</text> <graphics> <offset x="500.0" y="-12.0"/> </graphics> </inscription> <graphics/> <toolspecific tool="WoPeD" version="1.0"> <probability>1.0</probability> <displayProbabilityOn>false</displayProbabilityOn> <displayProbabilityPosition x="500.0" y="12.0"/> </toolspecific> </arc> <arc id="a2" source="t1" target="p2"> <inscription> <text>1</text> <graphics> <offset x="500.0" y="-12.0"/> </graphics> </inscription> <graphics/> <toolspecific tool="WoPeD" version="1.0"> <probability>1.0</probability> <displayProbabilityOn>false</displayProbabilityOn> <displayProbabilityPosition x="500.0" y="12.0"/> </toolspecific> </arc> <toolspecific tool="WoPeD" version="1.0"> <bounds> <position x="2" y="25"/> <dimension x="966" y="650"/> </bounds> <scale>100</scale> <treeWidthRight>739</treeWidthRight> <overviewPanelVisible>true</overviewPanelVisible> <treeHeightOverview>100</treeHeightOverview> <treePanelVisible>true</treePanelVisible> <verticalLayout>false</verticalLayout> <resources/> <simulations/> <partnerLinks/> <variables/> </toolspecific> </net> </pnml>
+}

docs/Bruno-Collection/BPMN-PNML-Transformer/bruno.json

@@ -0,0 +1,9 @@
+{
+  "version": "1",
+  "name": "BPMN-PNML-Transformer",
+  "type": "collection",
+  "ignore": [
+    "node_modules",
+    ".git"
+  ]
+}

docs/openapi.yaml

@@ -18,7 +18,7 @@ paths:
             enum: [bpmntopnml, pnmltobpmn]
           description: Specifies the direction of the transformation.
       requestBody:
-        description: "Info: Swagger only works if the XML does not contain any line breaks and all quotation marks are escaped with a backslash as shown in the examples. For other XMLs you could use tools like Bruno."
+        description: "Info: Swagger only works if the XML does not contain any line breaks and all quotation marks are escaped with a backslash as shown in the examples. Furthermore, the error cases are not correctly displayed in Swagger. For a better experience please use the Bruno Collection from the repository."
         required: true
         content:
           application/x-www-form-urlencoded: