search

HUD-Data-Lab / Data.Exchange.and.Interoperability

Repository for Homeless Management Information System (HMIS) development and management of products to support data exchange and interoperability
GNU General Public License v3.0
2 stars 6 forks source link

Minimum requirements #18

Open eanders opened 3 months ago

eanders commented 3 months ago

I'm not sure how to phrase this question, but I'd like to propose that the API that is described be broken into two parts:

  1. Minimum parts that are required in every implementation
  2. Optional parts

Perhaps a simple client lookup functionality fits into the required section, while the ability to update coordinated entry assessments would be optional.

Since this is a version 1, it seems like setting our bar really low for what would be required (say in the first year) might be a good way to confirm expectations and validate the utility of the feature.

Leaving this here as a place to discuss this bifurcation.

Grant-ICF commented 1 week ago

Similar to the response to #4 ADR 0006 proposes the concept of having foundational resources of the API Reference. This approach narrows the focus of the API Reference to be a 1:1 adaptation of the CSV specifications. This was our approach to avoid the potential scenario where there could be a potentially unlimited number of endpoints defined to address all the various use cases CoCs may want.

Leaving this comment thread open for additional discussion around the minimum requirements of the HMIS API Reference.