Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Schema: Added enum values to field descriptions #509

Merged
merged 4 commits into from
Sep 5, 2024
Merged

Schema: Added enum values to field descriptions #509

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
baf323d
Schema: Added enum values to field descriptions
Aug 6, 2024
6fea9fe
Merge branch '3.1-dev' of github.com:openreferral/specification into …
Aug 6, 2024
69ad74d
Docs: updated changelog
Aug 6, 2024
c000d1e
Merge branch '3.1-dev' into PATCH-add-enums-to-field-descriptions
mrshll1001 Sep 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/hsds/changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion schema/address.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand Down
2 changes: 1 addition & 1 deletion schema/location.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand Down
4 changes: 2 additions & 2 deletions schema/schedule.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand All @@ -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
},
Expand Down
Loading