minor edits and add clarifying comments

Ouranosinc · Jul 6, 2023 · e40c2e1 · e40c2e1
1 parent 597ef22
commit e40c2e1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -7,8 +7,8 @@ CHANGES
 ------------------------------------------------------------------------------------
 
 * Separate the application, cron job, and proxy (nginx) into separate containers so that they can be run independently.
-* Add option to independently enable/disable the parse_logs cron job by setting the PARSE_LOGS configuration option to
-  `True`.
+* Add option to independently enable/disable the `parse_logs` cron job by setting the `PARSE_LOGS` configuration option
+  to `True`.
 * Do not handle log rotation for nginx anymore. Nginx should handle this on its own.
 * Made default port 2000 everywhere (not just in docker).
 

diff --git a/canarieapi/schema.json b/canarieapi/schema.json
@@ -47,6 +47,7 @@
         "service_description_schema": {
             "description": "Describe a service",
             "type": "object",
+            "$comment": "When the PARSE_LOG configuration option is True, \"stats\" will be dynamically added to the list of required properties",
             "required": ["info", "redirect", "monitoring"],
             "additionalProperties": false,
             "properties": {
@@ -59,6 +60,7 @@
         "platform_description_schema": {
             "description": "Describe a platform",
             "type": "object",
+            "$comment": "When the PARSE_LOG configuration option is True, \"stats\" will be dynamically added to the list of required properties",
             "required": ["info", "redirect", "monitoring"],
             "additionalProperties": false,
             "properties": {