Codecov Report

Merging #217 (4969ea3) into main (7f9cc08) will increase coverage by 1.22%.
The diff coverage is 70.27%.

@@            Coverage Diff             @@
##             main     #217      +/-   ##
==========================================
+ Coverage   70.94%   72.17%   +1.22%     
==========================================
  Files          94      103       +9     
  Lines        4712     5099     +387     
  Branches      377      405      +28     
==========================================
+ Hits         3343     3680     +337     
- Misses       1352     1401      +49     
- Partials       17       18       +1     

... and 121 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@cguedes one question on this and another thing to note:

1. For nulling out fields, what do you think about just passing in an empty string, which I can then set to None on my end? It feels like if a user is entirely deleting a metadata value in the UI, we should interpret that to null.
2. One thing to note here is that the client will need to pass all the metadata to update a nested object like authors.

For example, if we have the following Reference:

Reference(source_filename='abc.pdf', authors=[Author(full_name='Greg Reda'), Author(full_name='Carlos')])

and we want to update the full_name for only one author, we'll need to include all author details in the update, even ones that are not changing:

$ poetry run python main.py update --data \
    '{"source_filename": "abc.pdf", "patch": {"authors": [{"full_name": "Greg Reda"}, {"full_name": "Carlos Guedes"}]}}'

For 1, I think it makes sense to interpret empty strings as null. I don't have any strong opinion on whether it is the frontend's job to send null instead of an empty string or if the backend should convert empty strings to null as you suggested.

And for 2, I think it's actually easier for the frontend too to send the whole array of authors to the backend rather than keeping track of what indexes have been updated

1. I'm ok with sending empty strings, bc most times that's what the UI can do/detect for when a field is cleared (one just remove all the text).
2. That's ok.