Updated Security Client APIs

[saimedhi]

Description

Updated Security Client APIs

Issues Resolved

Related to #435,

Relevant PRs

#399, #442

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov]

Codecov Report

Merging #450 (c5d05a1) into main (58217d9) will decrease coverage by 0.51%.
Report is 6 commits behind head on main.
The diff coverage is 15.87%.

@@            Coverage Diff             @@
##             main     #450      +/-   ##
==========================================
- Coverage   71.42%   70.91%   -0.51%     
==========================================
  Files          81       81              
  Lines        7668     7730      +62     
==========================================
+ Hits         5477     5482       +5     
- Misses       2191     2248      +57     

Files Changed	Coverage Δ
opensearchpy/_async/client/security.py	43.72% <15.87%> (-7.37%)	⬇️
opensearchpy/client/security.py	43.72% <15.87%> (-7.37%)	⬇️

... and 1 file with indirect coverage changes

[saimedhi]

Renamed the following APIs:

1. “put_user” to “create_user”.
2. “put_role” to“create_role”.
3. “delete_role_mappings” to “delete_role_mapping”.
4. “put_role_mappings” to “create_role_mapping”.
5. “put_tenant” to “create_tenant”.
6. “put_audit_configuration” to “update_audit_config”.
7. "put_action_group" to "create_action_group"
8. "put_configuration" to "update_configuration"
9. "put_distinguished_names" to "update_distinguished_names"

And also made few other changes to the APIs to maintain uniformity.

[saimedhi]

Hello @florianvazelle, I request you to take a look at these changes. Please let me know if you notice anything wrong.

[saimedhi]

@VachaShah, please review and merge this PR. It needs to be done before upcoming python release. Thank you :)

[dblock]

Should I be concerned by the amount of changes and so few in tests?

[saimedhi]

Should I be concerned by the amount of changes and so few in tests?

I made changes with utmost care. But, it is true that Test coverage is less

[VachaShah]

Lets add a working sample as @dblock mentioned?

[florianvazelle]

Hello @florianvazelle, I request you to take a look at these changes. Please let me know if you notice anything wrong.

LGTM 🙂

But I find that renaming to create_ is a bit confusing, because it makes a creates or replaces.
So on the first call, endpoints return status: CREATED and the second one, something like :

{
	"status": "OK",
	"message": "'...' updated."
}

[nhtruong]

@florianvazelle The naming follows the documentation: For example, it's create_user instead of put_user because we call it create user on OS website: https://opensearch.org/docs/latest/security/access-control/api/#create-user

The moving of security plugin endpoints to security namespace (i.e. client.security.create_user for example) along with renaming is to keep the PY client consistent with our API spec. For example, this is the spec for the PUT _plugins/_security/api/internalusers/ endpoint.

The API generator for PY that @saimedhi has been working on will also generate code for all security endpoints based off of that spec. So we're making sure that these endpoints will have the same names and same location in the PY client as they will soon be replaced by generated code.

Hope that's answered your question.

[saimedhi]

@VachaShah, @dblock Please let me know if any further changes needed. I added working sample and few tests as suggested.

[dblock]

Merged, thanks.