Skip to content

Commit 9925754

Browse files
authored
Merge pull request #152 from Edirom/feature/swagger-update
updated swagger documentation refs #149
2 parents d5741ec + 1da1b00 commit 9925754

3 files changed

Lines changed: 221 additions & 189 deletions

File tree

src/main/java/pl/psnc/dl/ege/webapp/servlet/CustomizationServlet.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,13 @@ public void doGet(
8888
description = "Customization",
8989
required = true,
9090
name = "customization",
91-
schema = @Schema(type = "string", format = "text/plain"))
91+
schema = @Schema(type = "string", format = "text/plain")),
92+
@Parameter(
93+
in = ParameterIn.PATH,
94+
description = "Output document type",
95+
required = true,
96+
name = "output-document-type",
97+
schema = @Schema(type= "string", format="text/plain"))
9298
},
9399
responses = {
94100
@ApiResponse(

src/main/webapp/openapi.json

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
}
152152
}
153153
},
154-
"/ege-webservice/Customization/{customization-setting}/{source}/{customization}": {
154+
"/ege-webservice/Customization/{customization-setting}/{source}/{customization}/{output-document-type}": {
155155
"post": {
156156
"tags": [
157157
"ege-webservice"
@@ -192,6 +192,17 @@
192192
"format": "text/plain"
193193
},
194194
"example": "c-mei-all"
195+
},
196+
{
197+
"name": "output-document-type",
198+
"in": "path",
199+
"description": "Customization",
200+
"required": true,
201+
"schema": {
202+
"type": "string",
203+
"format": "text/plain"
204+
},
205+
"example": "RelaxNG"
195206
}
196207
],
197208
"requestBody": {
@@ -344,14 +355,14 @@
344355
"xml": {
345356
"attribute": true
346357
},
347-
"example": "Documents:TEI P5 XML Document:TEI,text/xml"
358+
"example": "mei40,text/xml:mei40,text/xml"
348359
},
349360
"xlink-href": {
350361
"type": "string",
351362
"xml": {
352363
"attribute": true
353364
},
354-
"example": "https://teigarage.tei-c.de/ege-webservice/Conversions/TEI%3Atext%3Axml/"
365+
"example": "https://meigarage.edirom.de/ege-webservice/Conversions/mei40%3Atext%3Axml/"
355366
}
356367
}
357368
}
@@ -374,26 +385,26 @@
374385
"xml": {
375386
"attribute": true
376387
},
377-
"example": "Documents:TEI P5 XML Document:TEI,text/xml"
388+
"example": "Documents:mei40,text/xml:mei40,text/xml"
378389
},
379390
"xlink-href": {
380391
"type": "string",
381392
"xml": {
382393
"attribute": true
383394
},
384-
"example": "https://teigarage.tei-c.de/ege-webservice/Validation/TEI%3Atext%3Axml/"
395+
"example": "https://meigarage.edirom.de/ege-webservice/Validation/mei40%3Atext%3Axml/"
385396
}
386397
}
387398
}
388399
}
389400
},
390401
"DataInputType": {
391402
"type": "string",
392-
"example": "TEI:text:xml"
403+
"example": "mei40:text:xml"
393404
},
394405
"DataOutputType": {
395406
"type": "string",
396-
"example": "odt:application:vnd.oasis.opendocument.text"
407+
"example": "pdf-verovio:application:pdf"
397408
},
398409
"ValidationResult": {
399410
"type": "object",
@@ -554,4 +565,4 @@
554565
}
555566
}
556567
}
557-
}
568+
}

0 commit comments

Comments
 (0)