openreferral / specification

The Human Services Data Specification - a data exchange format developed by the Open Referral Initiative
https://openreferral.org
Other
117 stars 49 forks source link

Add introductory copy to Swagger Page #424

Closed dan-odsc closed 1 year ago

dan-odsc commented 1 year ago

Context here - https://forum.openreferral.org/t/3-0-for-review-and-comment/364/12?u=dan-ods

SwaggerUI - https://docs.openreferral.org/en/latest/openapi.html

Copy

Open Referral develops data standards and open source tools that make it easier to share, find and use information about health, human, and social services i.e. community resource directory data. Our Human Service Data Specification (HSDS, AKA ‘the Open Referral format’) is a data exchange format that enables resource directory data to be shared among heterogeneous information systems.

We provide an OpenAPI specification that can be used as a blueprint for the design or adaptation of API platforms to provide read or read/write access to information on organizations, services, locations and the details about them. The API protocol provides most of the functionality needed for simple access and exchange of data.

This Swagger UI will aid the development of API's that will validate against the Open API specification.

For further info please see:

dan-odsc commented 1 year ago

-

kindly commented 1 year ago

Updated this here http://docs.openreferral.org/en/3.0/openapi.html

dan-odsc commented 1 year ago

Thanks David! Will let Devin know and close this issue. Dan

dan-odsc commented 1 year ago

Devin updated on forum