diff --git a/src/main/resources/gui/README.md b/src/main/resources/gui/README.md index 7c3955f..40aad58 100644 --- a/src/main/resources/gui/README.md +++ b/src/main/resources/gui/README.md @@ -2,6 +2,8 @@ [API usage](docs/api) +[configurations](docs/configurations) + # Server information View [validator configuration](/server/config) or health information diff --git a/src/main/resources/gui/docs/api.md b/src/main/resources/gui/docs/api.md index dc84852..34d0c71 100644 --- a/src/main/resources/gui/docs/api.md +++ b/src/main/resources/gui/docs/api.md @@ -1,3 +1,4 @@ +# API Usage The validation service listens to `POST`-requests to any server uri. You need to supply the xml/object to validate in the post body. The service expects a single plain input in the post body, e.g. `multipart/form-data` is not supported. diff --git a/src/main/resources/gui/docs/configurations.md b/src/main/resources/gui/docs/configurations.md new file mode 100644 index 0000000..3e8678d --- /dev/null +++ b/src/main/resources/gui/docs/configurations.md @@ -0,0 +1,15 @@ +# Configurations + +The validator needs a scenario configuration for working properly. + +Currently, there are two public third party validation configurations available. + +* Validation Configuration for [XRechnung](http://www.xoev.de/de/xrechnung): + * Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xrechnung) + * [Releases](https://github.com/itplr-kosit/validator-configuration-xrechnung/releases) can also be downloaded +* Validation Configuration for [XGewerbeanzeige](https://xgewerbeanzeige.de/) + * Source code is available on [GitHub](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige) + * [Releases](https://github.com/itplr-kosit/validator-configuration-xgewerbeanzeige/releases) can also be downloaded + +For creating custom configurations see [configaration documentation](https://github.com/itplr-kosit/validator/blob/master/docs/configurations.md) +for details \ No newline at end of file diff --git a/src/main/resources/gui/index.html b/src/main/resources/gui/index.html index 4919302..1eb48c4 100644 --- a/src/main/resources/gui/index.html +++ b/src/main/resources/gui/index.html @@ -3,36 +3,48 @@