Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding first draft of the API data standards #93

Merged
merged 21 commits into from
Sep 13, 2024
Merged

Conversation

rmbielby
Copy link
Contributor

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:

  • tidy data
  • standardised filter names and items
  • standardised indicator names
  • character constraints on column names, labels and filter items

Issue ticket number/s and link

Checklist before requesting a review

  • I have checked the contributing guidelines
  • I have checked for and linked any relevant issues that this may resolve
  • I have checked that these changes build locally
  • I understand that if merged into main, these changes will be publicly available

@rmbielby rmbielby self-assigned this Sep 12, 2024
@cjrace cjrace self-requested a review September 12, 2024 12:47
Copy link
Contributor

@cjrace cjrace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, left some initial comments and now wondering about how we can start building up a reference table of all indicators, filters and filter options under them as new data sets come into the API

statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
_quarto.yml Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
@rmbielby rmbielby requested a review from cjrace September 13, 2024 09:36
@rmbielby
Copy link
Contributor Author

statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Show resolved Hide resolved
statistics-production/api-data-standards.qmd Show resolved Hide resolved
Copy link
Contributor

@cjrace cjrace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Few minor things left (including one older comment above I think you've missed?)

statistics-production/api-data-standards.qmd Outdated Show resolved Hide resolved
statistics-production/api-data-standards.qmd Show resolved Hide resolved
statistics-production/api-data-standards.qmd Show resolved Hide resolved
@rmbielby rmbielby merged commit d0af62c into main Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants