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

[Schema] Minor and structural updates #94

Closed
8 tasks done
odscrachel opened this issue Jun 14, 2023 · 5 comments · Fixed by #137
Closed
8 tasks done

[Schema] Minor and structural updates #94

odscrachel opened this issue Jun 14, 2023 · 5 comments · Fixed by #137
Assignees

Comments

@odscrachel
Copy link
Contributor

odscrachel commented Jun 14, 2023

There are a number of updates that need to be made to the schema to make it valid and to capture the minor changes in the spreadsheet. These minor changes will be captured in the changelog.

Changes include, but are not limited to:

  • Changing definitions to $defs to match current JSON schema version
  • Add missing definitions to fix errors
  • Update field names and descriptions where indicated in the spreadsheet
  • Update codelists
  • Update which fields are 'required'
  • Check integers are replaced with supported number type
  • Remove defs that are no longer referenced
  • Capital formatting in defs
@duncandewhurst
Copy link
Contributor

duncandewhurst commented Jun 19, 2023

  • Add missing definitions to fix errors

#109 adds empty definitions in order to make the schema valid.

@duncandewhurst
Copy link
Contributor

duncandewhurst commented Jun 19, 2023

  • Update field names and descriptions where indicated in the spreadsheet

#109 adds a test to make sure that definitions and properties have titles and descriptions. Presently, many titles and descriptions are missing so the test is commented out. We should enable the test when we go through add titles and descriptions from the spreadsheet to make sure that we don't miss any.

@odscjen
Copy link
Contributor

odscjen commented Jun 23, 2023

Also include

@odscjen
Copy link
Contributor

odscjen commented Jun 23, 2023

I've updated the fields and descriptions spreadsheet to note which issues relate to which fields in the original schema. This should hopefully help us ensure we're covering everything that should be covered by this minor changes update

@duncandewhurst
Copy link
Contributor

  • Update field names and descriptions where indicated in the spreadsheet

#109 adds a test to make sure that definitions and properties have titles and descriptions. Presently, many titles and descriptions are missing so the test is commented out. We should enable the test when we go through add titles and descriptions from the spreadsheet to make sure that we don't miss any.

I've created a (draft) PR to enable the test: #128

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 a pull request may close this issue.

3 participants