OpenSlides/docs/modelsvalidator/README.md

22 lines
608 B
Markdown
Raw Normal View History

2020-12-01 13:45:29 +01:00
# Modelsvalidator
2020-11-11 12:02:23 +01:00
2020-12-01 13:45:29 +01:00
Modelsvalidator is a tool to validate the models.yml file
2020-11-11 12:02:23 +01:00
## Run
2020-12-01 13:45:29 +01:00
Build first: `go build ./...`.
2020-11-11 12:02:23 +01:00
The tool requires the content of the models.yml. It can be provided via stdin, a
file system path or an url starting with http:// or https://.
```
2020-12-01 13:45:29 +01:00
cat models.yaml | modelsvalidator
modelsvalidator openslides/docs/models.yml
modelsvalidator https://raw.githubusercontent.com/OpenSlides/OpenSlides/openslides4-dev/docs/models.yml
2020-11-11 12:02:23 +01:00
```
The tool returns with status code 0 and no content, if the given content is
2020-12-01 13:45:29 +01:00
valid. It returns with a positive status code and some error messages if not.