Skip to content

Commit 764deda

Browse files
committed
Reorganize validation endpoints under the same validation namespace
1 parent c74bd2b commit 764deda

3 files changed

Lines changed: 6 additions & 10 deletions

File tree

esdlvalidator/api/controller/validationToMessages.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,16 @@
1212
parser.add_argument("schemas", type=str, help="List of schema id's, comma separated", required=True)
1313

1414

15-
@app.ns_validation_to_msgs.route('/')
15+
@app.ns_validation.route('/validationToMessages')
1616
class ValidationToMessagesController(Resource):
17-
"""Validate an ESDL file and return an ESDL with notes"""
1817

19-
@app.ns_validation_to_msgs.doc(description="Post a new validation schema", responses={
18+
@app.ns_validation.doc(description="Post a new validation schema", responses={
2019
200: "Ok",
2120
404: "Schema not found",
2221
400: "Unknown filetype, Invalid ESDL"})
2322
@app.api.expect(parser, validate=True)
2423
def post(self):
25-
"""Validate an ESDL file against one or more validation schemas"""
24+
"""Validate an ESDL file against one or more validation schemas and return JSON"""
2625
if request.data:
2726
# 'Contains the incoming request data as string in case it came with a mimetype Flask does not handle'
2827
# > Happens with requests from the mapeditor

esdlvalidator/api/controller/validationToNotes.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,16 @@
1515
parser = app.api.parser()
1616

1717

18-
@app.ns_validation_to_notes.route('/')
18+
@app.ns_validation.route('/validationToNotes')
1919
class ValidationToNotesController(Resource):
20-
"""Validate an ESDL file and return an ESDL with notes"""
2120

22-
@app.ns_validation_to_notes.doc(deprecated=True, description="Post a new validation schema", responses={
21+
@app.ns_validation.doc(deprecated=True, description="Post a new validation schema", responses={
2322
200: "Ok",
2423
404: "Schema not found",
2524
400: "Unknown filetype, Invalid ESDL"})
2625
@app.api.expect(parser, validate=True)
2726
def post(self):
28-
"""Validate an ESDL file against one or more validation schemas"""
27+
"""Validate an ESDL file against one or more validation schemas and return an ESDL with notes"""
2928

3029
file = request.data.decode('utf-8')
3130
if "schemas" not in request.args:

esdlvalidator/api/setup.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,4 @@ def __init__(self):
4848
self.apiBlueprint = Blueprint("api", __name__)
4949
self.api = Api(self.apiBlueprint, version=self.settings.version, title=self.settings.title, description=self.settings.description)
5050
self.ns_validation = self.api.namespace("validation", "ESDL validation endpoint")
51-
self.ns_validation_to_notes = self.api.namespace("validationToNotes", "ESDL validation endpoint")
52-
self.ns_validation_to_msgs = self.api.namespace("validationToMessages", "ESDL validation endpoint to return JSON")
5351
self.ns_schema = self.api.namespace("schema", "Validation schema endpoint")

0 commit comments

Comments
 (0)