diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..a353f04eed23c8c22b94919c06b142ec99d62ceb --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Large-Scale Metrology +Schema for modeling a Large-Scale Metrology Device in SOIL + +## Viewing +To view the schema, you can use any tool that supports the OpenAPI specification and open the bundled file at [public/openapi.yml](https://git-ce.rwth-aachen.de/wzl-mq-public/soil/schemas/large-scale-metrology/-/blob/76a54aeb9f4ee987ff056d53a4a6c3b32ad2aa7f/public/openapi.yml). + +This also works with GitLab's integrated Swagger-Editor. + +## Contributing +To contribute, you can use any editor and edit the files in the folder *OpenAPI*. We recommend Visual Studio Code with the OpenAPI extension. +Please adhere to the filestructure which decomposes resources into individual files. + +## Bundling +To bundle the files to the public `openapi.yml` file, you can use `swagger-cli`: +``` +npm install -g swagger-cli +npx swagger-cli bundle .\OpenAPI\openapi.yml -o .\public\openapi.yml -r -t yaml +```