From baf323d692cbb1bfdc931053821b5bc4329cfc12 Mon Sep 17 00:00:00 2001 From: Matt Marshall Date: Tue, 6 Aug 2024 10:49:58 +0100 Subject: [PATCH 1/2] Schema: Added enum values to field descriptions HSDS contains several fields where the values must be taken from enumerated values. These are represented in the schemas with `enum` properties. There is currently no documentation for these values, so I have added them to the `description` property of each field. This gives some inline documentation where appropriate without changing the semantics of the relevant fields. --- schema/address.json | 2 +- schema/location.json | 2 +- schema/schedule.json | 4 ++-- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/schema/address.json b/schema/address.json index 872b61b..ba0d945 100644 --- a/schema/address.json +++ b/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 }, diff --git a/schema/location.json b/schema/location.json index 9d4814f..06e86e4 100644 --- a/schema/location.json +++ b/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 }, diff --git a/schema/schedule.json b/schema/schedule.json index 71d4a29..b4f2afa 100644 --- a/schema/schedule.json +++ b/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 }, From 69ad74d9f29ba5e03e32808f8c73b7f92fb478ef Mon Sep 17 00:00:00 2001 From: Matt Marshall Date: Tue, 6 Aug 2024 11:05:33 +0100 Subject: [PATCH 2/2] Docs: updated changelog Added details of this change to the changelog for 3.1 --- docs/hsds/changelog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/hsds/changelog.md b/docs/hsds/changelog.md index d429afd..7bea3ae 100644 --- a/docs/hsds/changelog.md +++ b/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)