6915-feature-builtin-users-sendEmailNotification-new-optionalParameter #7033
Conversation
…arameter to create(...) and internalSave(...)
|
@RightInTwo, moving this back to Community Dev. I saw your note about it not being ready yet, but it looks like you already have one review suggestion! :) |
…Users.java and native-api.rst
There was a problem hiding this comment.
I think there's some confusion over path parameter vs query parameter but I'm not sure. @RightInTwo can you please look at my comment?
| */ | ||
| @POST | ||
| @Path("{password}/{key}/{sendEmailNotification}") | ||
| public Response create(BuiltinUser user, @PathParam("password") String password, @PathParam("key") String key, @PathParam("sendEmailNotification") Boolean sendEmailNotification) { |
There was a problem hiding this comment.
sendEmailNotification appears to be a path parameter rather than a query parameter, as documented above. @RightInTwo can you provide a full curl example?
There was a problem hiding this comment.
Hi @pdurbin, we added both ways (query and path), just as the create() function is implemented for both currently. The docs at http://guides.dataverse.org/en/latest/api/native-api.html#assign-default-role-to-user-creating-a-dataset-in-a-dataverse seem to omit the path variant completely, which is why we left it out as well.
There was a problem hiding this comment.
Oh, I get it. The query parameter version is called "save". Thanks.
There was a problem hiding this comment.
There's a slight mismatch of the docs vs the code but I'm moving this to QA. The docs say to use a query parameter. In truth, both the query parameter and the path parameter should work but I haven't tested the code myself.
I'm not sure how popular this feature will be but it seems to solve a problem for @RightInTwo.
| */ | ||
| @POST | ||
| @Path("{password}/{key}/{sendEmailNotification}") | ||
| public Response create(BuiltinUser user, @PathParam("password") String password, @PathParam("key") String key, @PathParam("sendEmailNotification") Boolean sendEmailNotification) { |
There was a problem hiding this comment.
Oh, I get it. The query parameter version is called "save". Thanks.
|
What this PR does / why we need it:
Allow to disable sending an email for confirmation after creating a user.
Which issue(s) this PR closes:
Closes none, but solves part of #6915
Special notes for your reviewer:
We don't have a dev server, so there was no local testing yet.
Suggestions on how to test this:
Create and edit users with the builtin-users API with and without explicitly submitting PathParam with
@post
@path("{password}/{key}/{sendEmailNotification}")
and as QueryParam with
@post
...and &sendEmailNotification=...
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
NO
Is there a release notes update needed for this change?:
could be a new small feature to mention
Additional documentation:
see doc/sphinx-guides/source/api/native-api.rst