Use discriminated unions to provide more helpful error messages

[mvandenburgh]

Fixes #244

This change allows Pydantic to generate more useful validation errors by making use of discriminated unions where possible.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.74%. Comparing base (e135307) to head (abccf00).

Additional details and impacted files

@@             Coverage Diff             @@
##           master     #245       +/-   ##
===========================================
+ Coverage   87.42%   97.74%   +10.31%     
===========================================
  Files          16       16               
  Lines        1726     1727        +1     
===========================================
+ Hits         1509     1688      +179     
+ Misses        217       39      -178     

Flag	Coverage Δ
unittests	97.74% <100.00%> (+10.31%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[mvandenburgh]

There's some test failures happening here that I have to look into, marking this as draft for now.

[candleindark]

The changes look good to me.

The JSON schemas have changed though mostly because of the inclusion of the discriminator object as mentioned in the discriminated union docs. We may need to increase the JSON schema version, but I don't expect much perceivable difference for the end users.

@yarikoptic @satra Should me up the JSON schema version for this one? We didn't up the JSON schema version for #236, so the changes in JSON schemas from that PR are yet to be included in the latest published schemas.

[yarikoptic]

my personal take is that for any change upon release we should up the json version, otherwise it all becomes ambiguous and possibly hard to troubleshoot later on. "explicit better than implicit"!

[mvandenburgh]

Is there something I need to add to the PR to bump the schema version?

[satra]

just added labels so we can release with this. see the consts.py file. that's where the schema version will need to be incremented for the test to pass.

[mvandenburgh]

just added labels so we can release with this. see the consts.py file. that's where the schema version will need to be incremented for the test to pass.

Thanks, I bumped the version in consts.py.

[satra]

@candleindark - could you please provide your feedback if any or approve this PR?

[candleindark]

Everything looks fine to me.

[candleindark]

Any idea about these tests? I can't locate them in the github workflow files. The only place we use macos-latest is in test-dandi-cli.yml, these tests don't seem to be defined by that file.

[satra]

@candleindark - fixed the branch merge requirements. merging.

[satra]

thanks @mvandenburgh for this PR. will you update the server to this release schema and python library?