Human Services Data API (HSDA) - Utility v1.0

This is the OpenAPI definition for the Human Services Data API (HSDA) v1.2. This is a set of API paths, organized as a separate service, for any utility APIs associated with operating any HSDA inmplementation. It is available as this HTML list or YAML OpenAPI definition, with an accompanying demo site, and link to current Github Issues for support.

Services
Services /services/ GET
Reponse Body:
id (string) Each entry must have a unique identifier.
name (string) The service name.
path (string) The path name.
verb (string) The verb.
Schema Build /schema/build/ GET
Reponse Body:
service (string) The service of the schema
definition (string) The definition of the schema.
file (string) The file name being created.
Validate
Validate HSDA Response /validate/hsda/definition/ POST
Request Parameters:
name: The name of the service which is being validated.
path: The path which is being validated.
verb: The verb which is being validated.
Request Body:
body The HSDA definition to validate.
Reponse Body:
id (string) Each validation has a unique id.
service (string) The service that is being validated.
path (string) The path that is being validated.
verb (string) The verb that is being validated.
valid (boolean) Whether or not the schema was valid.
message (string) A message describing the validation.
Validate HSDA OpenAPI /validate/hsda/openapi/ POST
Request Body:
body The HSDA OpenAPI to validate.
Reponse Body:
id (string) Each validation has a unique id.
service (string) The service that is being validated.
valid (boolean) Whether or not the schema was valid.
message (string) A message describing the validation.