rdm

README.md

 # xml-validation
 
-HTTP-Server written in Python for validation of xml (e.g. DCC xml) against a 
-XML Schema.
+REST service for the validation of ```xml``` against a XML Schema (```xsd```).
 
 ## Installation
 
-```
+```shell
 > git clone git@a75436.berlin.ptb.de:vaclab/xml-validation.git
 > cd xml-validation
 > python3 -m venv .
@@ -14,28 +13,51 @@ XML Schema.
 > ./server
 ```
 
+The location of the ```xsd```-file can be configured in ```config.json```. 
+The default location is ```../xsd/dcc.xsd```:
+
+```shell
+├── xml-validation
+│   ├── config.json
+│   ├── README.md
+│   ├── server
+│   ├── server.py
+│   ├── share
+│   ├── utils.py
+│   ├── xml-validation.service
+│   └── xsd
+└── xsd-dcc
+    ├── dcc.xsd
+    ├── documentation
+    ├── examples
+    ├── README.md
+    ├── schemata
+    └── wiki
+```
+
+
 ## API
 
 ### /validate endpoint [POST]
 
-```
+```shell
 > curl -X POST -H "Content-Type: text/xml" -d @valid_xml_matches_xsd http://localhost:5005/validate
 > <ok/>
 ```
 
-```
+```shell
 > curl -X POST -H "Content-Type: text/xml" -d @no_valid_xml http://localhost:5005/validate
 > <error>unvalid xml data</error>
 ```
 
-```
+```shell
 > curl -X POST -H "Content-Type: text/xml" -d @valid_xml_but_dont_matches_xsd http://localhost:5005/validate
 > <error>verbose error message</error>
 ```
 
 Example:
 
-```
+```shell
 > curl -X POST -H "Content-Type: text/xml" -d @11044_17_DCC_v1.8.1_Au_with_error.xml http://localhost:5005/validate
 > <error>failed decoding 'A' with XsdAtomicBuiltin(name='xs:double'):
 
@@ -78,7 +100,7 @@ Path: /{https://intranet.ptb.de/fileadmin/dokumente/intranet/abteilungen/abteilu
 
 Returns the version of the validation server:
 
-```
+```shell
 > curl http://localhost:5005/version
 > <version>0.2.0</version>
 ```
@@ -88,7 +110,7 @@ Returns the version of the validation server:
 Returns the version of the xsd-definition. The version is given at
 `xmlRoot.annotation.documentation`
 
-```
+```shell
 > curl http://localhost:5005/version_xsd
 <version>1.9.2</version>
 ``
@@ -100,7 +122,7 @@ Updates the server; used by webhook (no security checks so far).
 
 ### install daemon and start 
 
-```
+```shell
     > cd /usr/local/share/xml-validation              # working directory
     > sudo nobody
     > git clone git@a75436.berlin.ptb.de:vaclab/xml-validation.git