Merge pull request #509 from openreferral/PATCH-add-enums-to-field-de…

…scriptions

Schema: Added enum values to field descriptions

Merging as no objections to this PATCH were raised.

Also noting that this PR doesn't contain work resulting from running the hsds tools, which I will be doing inside the `3.1-dev` branch once merged in.

docs/hsds/changelog.md

@@ -9,6 +9,7 @@ TODO: update link to this
 
 ### Backwards compatible schema changes
 
+* Descriptions for `address.address_type`, `location.location_type`, `schedule.wkst`, and `schedule.freq` have been updated to include their enum values.
 
 ## [v3.0](https://github.com/openreferral/specification/milestone/7)
 

schema/address.json

@@ -125,7 +125,7 @@
             "name": "address_type",
             "type": "string",
             "title": "Address Type",
-            "description": "The type of address which may be physical, postal, or virtual.",
+            "description": "The type of address which may be `physical`, `postal`, or `virtual`.",
             "constraints": {
                 "unique": false
             },

schema/location.json

@@ -26,7 +26,7 @@
             "name": "location_type",
             "type": "string",
             "title": "Location Type",
-            "description": "The type of location, which may be either physical, postal, or virtual.",
+            "description": "The type of location, which may be either `physical`, `postal`, or `virtual`.",
             "constraints": {
                 "unique": false
             },

schema/schedule.json

@@ -128,7 +128,7 @@
             "name": "wkst",
             "type": "string",
             "title": "Week Start",
-            "description": "iCal - The two-letter code for the day on which the week starts.",
+            "description": "iCal - The two-letter code for the day on which the week starts: `MO`, `TU`, `WE`, `TH`, `FR`, `FR`, `SA`, `SU`",
             "constraints": {
                 "unique": false
             },
@@ -147,7 +147,7 @@
             "name": "freq",
             "type": "string",
             "title": "Frequency",
-            "description": "iCal - How often the frequency repeats.",
+            "description": "iCal - How often the frequency repeats. Values can be `WEEKLY` or `MONTHLY`",
             "constraints": {
                 "unique": false
             },