dfe-analytical-services / analysts-guide

A static website to hold guidance, helpful links and code examples for analysts working in DfE.
https://dfe-analytical-services.github.io/analysts-guide/
MIT License
5 stars 3 forks source link

Adding first draft of the API data standards #93

Closed rmbielby closed 2 months ago

rmbielby commented 2 months ago

Overview of changes

I've added a page summarising (and signposting) standards that will be a requirement (above and beyond the base EES standards) for data sets being uploaded for use with the API.

Why are these changes being made?

We want a much more coherent data ecosystem when it comes to the API and we'll be manually checking data files against this. So we need a framework laying out clearly both for analysts intending to make data their data available via the API, and for us when reviewing a data set for acceptance on to the system.

Detailed description of changes

I've added a specific API data standards page which is linked from the statistics production menu.

This covers four key elements:

Issue ticket number/s and link

Checklist before requesting a review

rmbielby commented 2 months ago

Analysts Guide: add a section on data standards for publishing via a public API