punkish / zenodeo

`nodejs` interface to Zenodo/BLR community
https://zenodeo.org
Creative Commons Zero v1.0 Universal
6 stars 1 forks source link

proposal to change the name of an attribute #36

Open punkish opened 4 years ago

punkish commented 4 years ago

I was subject to some important misunderstanding that cleared up a couple of days ago in a long conversation with @myrmoteras. The short of it is, I refer to the name of the author of the article as author and the name of the author of the treatment as authorityName. I am thinking of changing the former to articleAuthor just to make the difference crystal clear, and also in line with the related articleTitle attribute which immediately makes it clear as compared to the treatmentTitle. Fwiw, this value is taken out from the mods tag with roleTerm=author.

The one drawback is that it will be a breaking change so I will have to update the API version to 3, and that is really not what I want to do. On the other hand, I could cheat – since the only users of the API right now are just us (Ocellus and the BLR website), I could bump up just the minor version (the y in x.y.z)

Please let me know if you have any objections to this proposed change.

cc @tcatapano @gsautter

PS: my personal, uninformed but fairly reasonable thought is that authorityName should really be called treatmentAuthor so everything is consistent, but let's leave that for now