Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate opendistro in API requests and responses #5098

Open
shikharj05 opened this issue Feb 7, 2025 · 1 comment
Open

Deprecate opendistro in API requests and responses #5098

shikharj05 opened this issue Feb 7, 2025 · 1 comment
Labels
enhancement New feature or request triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable.

Comments

@shikharj05
Copy link
Contributor

shikharj05 commented Feb 7, 2025

Is your feature request related to a problem?
#5092
The security repo has lingering usages of the legacy terms like opendistro_security is API requests and responses, these should be replaced with opensearch_security, however legacy API contracts are not explicitly marked as deprecated. This task is to track marking opendistro API request/responses as deprecated.

What solution would you like?
Mark opendistro API requests/responses as deprecated, removal in a next major version. Replace with opensearch - for e.g. opendistro_security_roles in Create User - https://opensearch.org/docs/latest/security/access-control/api/#create-user

APIs impacted-

https://opensearch.org/docs/latest/security/access-control/api/#create-user

PUT _plugins/_security/api/internalusers/<username>
{
  "password": "kirkpass",
  "opendistro_security_roles": ["maintenance_staff", "database_manager"],
  "backend_roles": ["role 1", "role 2"],
  "attributes": {
    "attribute1": "value1",
    "attribute2": "value2"
  }
}

https://opensearch.org/docs/latest/security/access-control/api/#patch-user

PATCH _plugins/_security/api/internalusers/<username>
[
  {
    "op": "replace", "path": "/backend_roles", "value": ["klingons"]
  },
  {
    "op": "replace", "path": "/opendistro_security_roles", "value": ["ship_manager"]
  },
  {
    "op": "replace", "path": "/attributes", "value": { "newattribute": "newvalue" }
  }
]
@shikharj05 shikharj05 added enhancement New feature or request untriaged Require the attention of the repository maintainers and may need to be prioritized labels Feb 7, 2025
@cwperks cwperks added triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable. and removed untriaged Require the attention of the repository maintainers and may need to be prioritized labels Feb 10, 2025
@cwperks
Copy link
Member

cwperks commented Feb 10, 2025

[Triage] Thank you for filing this issue Shikhar. Can we add the APIs that would be affected by the change and the names of the fields to the PR description?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triaged Issues labeled as 'Triaged' have been reviewed and are deemed actionable.
Projects
None yet
Development

No branches or pull requests

2 participants