Make role descriptors optional when creating API keys #43481
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit changes the `role_descriptors` field from required to optional when creating API key. The default behavior in .NET ES client is to omit properties with `null` value requiring additional workarounds. The behavior for the API does not change. Field names (`id`, `name`) in the invalidate api keys API documentation have been corrected where they were wrong. Closes elastic#42053
bizybot
added
>docs
|
Pinging @elastic/es-docs |
|
Pinging @elastic/es-security |
albertzaharovits
approved these changes
Jun 24, 2019
| @@ -49,7 +49,7 @@ public CreateApiKeyRequest(String name, List<RoleDescriptor> roleDescriptors, @N | |||
| } else { | |||
| throw new IllegalArgumentException("name must not be null or empty"); | |||
| } | |||
| this.roleDescriptors = Objects.requireNonNull(roleDescriptors, "role descriptors may not be null"); | |||
| this.roleDescriptors = (roleDescriptors == null) ? List.of() : roleDescriptors; | |||
There was a problem hiding this comment.
This parameter can be annotated with @Nullable.
| @@ -86,7 +86,7 @@ public void setExpiration(TimeValue expiration) { | |||
| } | |||
|
|
|||
| public void setRoleDescriptors(List<RoleDescriptor> roleDescriptors) { | |||
| this.roleDescriptors = Collections.unmodifiableList(Objects.requireNonNull(roleDescriptors, "role descriptors may not be null")); | |||
| this.roleDescriptors = (roleDescriptors == null) ? List.of() : Collections.unmodifiableList(roleDescriptors); | |||
There was a problem hiding this comment.
If you are going to use List.of then Collections.unmodifiableList( should also be replaced by List.copyOf .
But, we don't have a general guidance, so I would go with the "surroundings", and raise a bigger refactoring issue for all requests? Maybe worth raising a discussion in the team's meeting.
There was a problem hiding this comment.
here I think we should be using List.copyOf so it is unmodifiable not not just unmodifiable view of the source. Updated here, Thank you.
bizybot
added a commit
to bizybot/elasticsearch
that referenced
this pull request
Jun 26, 2019
This commit changes the `role_descriptors` field from required to optional when creating API key. The default behavior in .NET ES client is to omit properties with `null` value requiring additional workarounds. The behavior for the API does not change. Field names (`id`, `name`) in the invalidate api keys API documentation have been corrected where they were wrong. Closes elastic#42053
bizybot
added a commit
to bizybot/elasticsearch
that referenced
this pull request
Jun 26, 2019
This commit changes the `role_descriptors` field from required to optional when creating API key. The default behavior in .NET ES client is to omit properties with `null` value requiring additional workarounds. The behavior for the API does not change. Field names (`id`, `name`) in the invalidate api keys API documentation have been corrected where they were wrong. Closes elastic#42053
bizybot
added a commit
that referenced
this pull request
Jun 26, 2019
This commit changes the `role_descriptors` field from required to optional when creating API key. The default behavior in .NET ES client is to omit properties with `null` value requiring additional workarounds. The behavior for the API does not change. Field names (`id`, `name`) in the invalidate api keys API documentation have been corrected where they were wrong. Closes #42053
bizybot
added a commit
that referenced
this pull request
Jun 26, 2019
This commit changes the `role_descriptors` field from required to optional when creating API key. The default behavior in .NET ES client is to omit properties with `null` value requiring additional workarounds. The behavior for the API does not change. Field names (`id`, `name`) in the invalidate api keys API documentation have been corrected where they were wrong. Closes #42053
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit changes the
role_descriptorsfield from requiredto optional when creating an API key. The default behavior in .NET ES
client is to omit properties with
nullvalue requiring additionalworkarounds. The behavior for the API does not change.
Field names (
id,name) in the invalidate api keys API documentation have beencorrected where they were wrong.
Closes #42053