search

openreferral / api-specification

This is the working repository for Open Referral's Human Services Data API protocols.
https://openreferral.readthedocs.io/en/latest/hsda/
Other
29 stars 13 forks source link

Naming of single and plural objects in query responses #104

Closed MikeThacker1 closed 3 years ago

MikeThacker1 commented 4 years ago

The HSDS query response format for /services/complete/{service_id}/ has a mixture of singular and plural naming for parameters that can have multiple values, eg "contacts" (plural) and "service_area" (singular).

We use a plural form, even where grammatically incorrect, eg in the response to /services/id we use "contacts", "service_areas" and "service_taxonomys".

Although it would be a breaking change, there is merit in taking a mechanistic approach to always pluralise such items in a consistent way.

kinlane commented 3 years ago

Definitely the time to audit and review as part of migration to v2.0. Thanks!

kinlane commented 3 years ago

This method has been removed from v2.0, and we'll be auditing plurality use across all existing methods as part of release.