Updating schemas

[JohnRDOrazio]

We should document how to handle updating schemas for tests, when new properties are introduced either for the Request or the Response in the API.

For example, we have recently introduced a new LitCalSetting which can be used in the Request: CalendarType. We also introduced a couple new properties in the Response such as isVigilFor and liturgicalSeason. I updated the LitCal.json schema to account for these. However, even after pulling the changes to the api/dev branch on the server, tests are still failing.

Turns out it's because we are actually using the litcal.org domain, purchased by J. Hudon, for our schemas. So after any changes to schemas, they need to be pulled in under that domain's directory on the server. How to deal with this in the future? Perhaps purchase a new domain name?

[JohnRDOrazio]

May have to restart the websocket server: sudo service litcal-tests restart.

The service is defined on the server at /etc/systemd/system/litcal-tests.service.

[JohnRDOrazio]

I was able to update the JSON schemas to use local references, rather than remote references, which not only solves some of these problems, but also makes the validation much faster at least when running the server locally. Local references are resolved much faster than having to make network requests.