| Action | Goal |
|---|---|
| perform a full validation of my API endpoint | ensure my API feed is publishing data that is compliant with the HSDS API. |
| to receive a JSON schema that specifies pass/fail per-field | be alerted to fields that need to be reformatted in order to be compliant |
| to receive machine-readable feedback that includes details about which fields have failed and why | understand what i need to fix in my schema (or dataset?) in order to be compliant. |
| receive human-readable feedback that includes details about which fields have failed and why |
These are the most important first steps from my point of view. There is some overlap here, but my main use case would be to send integration partners to the validator (and they will send me there too!) to confirm whether APIs are in-spec and available to use with our existing connectors/parsers. If not, we want helpful feedback as to what needs to be mended in order to work together.