Representing recommended fields in the JSON schema

[ekoner]

As part of the State of the Data reporting, Katherine needs to know which sections and fields are being used in the 360Giving standard. Not all sections and fields are equally important, so at the moment, we have two possibilities in the schema: Optional and Required.

From our work on the data quality tool and ongoing support, we know that some sections or fields are Recommended, for example Last Modified and Data Source. These aren't represented in the schema.

How can we represent Recommended sections and fields in the JSON Schema?

This would ensure that:

• Once agreed with the stewardship committee, they are SSOT.
• They can be re-used on the website and in the data quality tool.
• We could look at this as part of the project to improve the documentation around 360Giving.

[timgdavies]

This is really interesting issue - and something I think that might cut across all the standards we work on with JSON schema.

To bring in learning from OCDS (at fear of complicating things a bit) there might be a concept of 'recommended for'. I.e. 'This field is recommended if you are targeting basic publication, or recommended if you want to be included in GrantNav.

I've had a quick scan to see if JSON Schema (or forthcoming version) provides any such properties but I don't believe it does.

If we do mint something new here, then we might want to start maintaining our own set of patches to the JSON Schema meta-schema, so we have a way of clearly documenting the extensions we're making to it.

[stevieflow]

@robredpath I think there's been some work on this recently?