372 search by orcid

[OrigamiBurger]

Allow users to search by ORCID #372
I tested this by directly inserting a row into provider_authorizations and was able to get a successful return when I provided the entire orcid (provider_uid) to the search endpoint
Added integrations tests as well

[kueda]

This looks like it should work, but I'm not sure we want to support ORCID search via the q param. An orcid param seems clearer to me. Thoughts on that, @pleary?

One thing that definitely needs to happen here is v2 implementation.

[OrigamiBurger]

This looks like it should work, but I'm not sure we want to support ORCID search via the q param. An orcid param seems clearer to me. Thoughts on that, @pleary?

One thing that definitely needs to happen here is v2 implementation.

For the implementation, I was going off the GET request example posted in the linked community post here https://forum.inaturalist.org/t/search-users-by-orcid/37362
I can see how a new parameter of orcid will make the usage/implementation more clear but would require updates in the website and/or mobile apps to implement. With this implementation I was able to do a search with an orcid on the website without an update since the search query is sent in the q parameter.
@kueda @pleary let know what you think. If you would like it to be a separate parameter, I can make that update by adding the orcid parameter and conditionally add the orcid elastic filter on whether it's present or not.

[pleary]

I'm OK with having the /search endpoint query against orcid with q (orcid is a keyword field so the full orcid is needed so searches like q=0 wont start returning a lot of extra results), but I agree it would be good to have it as its own parameter, probably in the V2 /users endpoint. I think that would make the most sense for people going to the API documentation looking to search for users by orcid - they may go to the users endpoint and look for an orcid parameter. Would it be possible to add this as a separate parameter for the V2 /users endpoint in addition to what you have here?

Let me know if you're having trouble navigating the V2 configuration which involves more code than V1, but also generates its own documentation along the way. The endpoint is described in the V2 path, implemented in the V2 controller, and parameters defined in the openapi request schema. Thanks!

[OrigamiBurger]

@pleary Thanks for the review! Yeah I can update the v2 users endpoint as well

[OrigamiBurger]

@pleary @kueda updated the V2 users endpoint to accept in orcid as a separate GET parameter and added a corresponding test

[pleary]

This looks good to me. Thanks!

[pleary]

For future reference, we have an .eslintrc file in the project root, and I'd recommend getting your text editor working with an automatic linter so you can see if any code formatting violated any of the rules in the config. There were a few spacing issues here that I fixed in a follow-up commit. I also added a pattern validator for the V2 orcid parameter since we know that the orcid will have to have a very particular format to work.

[OrigamiBurger]

@pleary that is good to know and will add the ESLint validation as a set to my future development. TBH I code in vim and don't have any ESLint plugins installed.
That's a good idea on the regex piece. I didn't know if the orcid was in the format of just numbers or was allowed to have letters present
Thanks for taking a look at my update!

[dshorthouse]

Comment on @pleary's commit should it be of use here: ed4f0c8#commitcomment-125768601