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

[DOC] Security Analytics Get Mappings API documentation is incorrect. Mandatory param missing #5652

Closed
1 of 4 tasks
eirsep opened this issue Nov 22, 2023 · 2 comments · Fixed by #5670
Closed
1 of 4 tasks
Assignees
Labels
2 - In progress Issue/PR: The issue or PR is in progress. security-analytics

Comments

@eirsep
Copy link
Member

eirsep commented Nov 22, 2023

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

Get mappings API in security analytics plugin has a mandatory request parameter called index_name which is not mentioned in API documentation

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
https://opensearch.org/docs/latest/security-analytics/api-tools/mappings-api/#get-mappings

@eirsep
Copy link
Member Author

eirsep commented Nov 22, 2023

Plz edit get mappings API and add the following table

Field Type Description
index_name String The name of the index used for log ingestion.

@hdhalter hdhalter added 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. and removed untriaged labels Nov 22, 2023
@hdhalter
Copy link
Contributor

@Naarcha-AWS - please update. Thanks!

@Naarcha-AWS Naarcha-AWS added security-analytics 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DOC Doc writer assigned to issue responsible for creating PR. labels Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. security-analytics
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants