Skip to content

Commit d4e7b70

Browse files
author
Matt Marshall
committed
Docs: Fix example and add changelog
1 parent 5fbccaf commit d4e7b70

File tree

2 files changed

+42
-3
lines changed

2 files changed

+42
-3
lines changed

docs/hsds/changelog.md

+41-2
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,50 @@ This page provides the list of changes that have been made to the HSDS schema.
55

66
## [v3.1](TODO)
77

8-
TODO: update link to this
8+
The header link to the 3.1 release will be added when this release has been approved.
9+
10+
### New schemas
11+
12+
* `url`
13+
* `service_capacity`
14+
* `unit`
915

1016
### Backwards compatible schema changes
1117

12-
* Descriptions for `address.address_type`, `location.location_type`, `schedule.wkst`, and `schedule.freq` have been updated to include their enum values.
18+
* For `address`
19+
* Updated description of `address_type` to include enum values
20+
* For `attribute`
21+
* added `label`
22+
* For `location`
23+
* Updated description of `location_type` to include enum values
24+
* For `organization`
25+
* Added `additional_websites`
26+
* For `schedule`
27+
* Updated description of `wkst` to include enum values
28+
* Updated description of `freq` to include enum values
29+
* For `service`
30+
* Added `capacities`
31+
* Added `additional_urls`
32+
* For `service_at_location`:
33+
* Added `service_areas`
34+
* For `taxonomy_term`
35+
* modified description of `language` to permit ISO 693-3 codes
36+
37+
38+
### Backwards compatible API changes
39+
40+
* For `components/parameters/taxonomy_term_id`
41+
* Modified description to make it generic to all record types
42+
* For `components/parameters/taxonomy_id`
43+
* Modified description to make it generic to all record types
44+
* For `GET /organizations`
45+
* Added `taxonomy_term_id` parameter
46+
* Added `taxonomy_id` parameter
47+
* Added `POST /services`
48+
* Added `POST /taxonomies`
49+
* Added `POST /taxonomy_terms`
50+
* Added `POST /organizations`
51+
* Added `POST /service_at_locations`
1352

1453
## [v3.0](https://github.com/openreferral/specification/milestone/7)
1554

docs/hsds/schema_reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ Each `service` object has the following fields:
7373

7474
:::{tab-item} Fields
7575
```{jsonschema} ../../schema/compiled/service_with_definitions.json
76-
:collapse: phones,schedules,service_areas,service_at_locations,languages,organization,funding,cost_options,program,required_documents,contacts,attributes,metadata,additional_urls
76+
:collapse: phones,schedules,service_areas,service_at_locations,languages,organization,funding,cost_options,program,required_documents,contacts,attributes,metadata,additional_urls,capacities
7777
```
7878
:::
7979

0 commit comments

Comments
 (0)