CredentialEngine / Registry_Assistant

Web service API for formatting and publishing to the Credential Registry
Apache License 2.0
1 stars 1 forks source link

Document all data quality constraints #4

Open siuc-nate opened 2 years ago

siuc-nate commented 2 years ago

For each field, we need to document:

These are currently scattered across our policy page, bulk upload page, handbook(s), and API error messages. It should be possible to find all of this information in one spot. Perhaps this is something that could be programmatically controlled/generated, so it's always up to date?

siuc-nate commented 2 years ago

This would also play into our (eventual) shex/shacl implementation, and likely also be used on our policy page. So if it can be done programmatically, that would be good.

mparsons-ce commented 2 years ago

The minimum data policy should handle the documentation of required properties. Each section includes a link to the related section under under minimum data. We don't want to start duplicating sections. In the API input classes, a region is used to group required properties. image

I will add a section to the API handbook regarding data quality/reasonability checks, including