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

[DOCS] Add Dev Tools warning to Security App API subpages or code samples #646

Closed
peluja1012 opened this issue Apr 23, 2021 · 3 comments
Closed
Assignees

Comments

@peluja1012
Copy link
Contributor

Description

When referring to our API docs, our users frequently falsely assume that our APIs can be used in the Kibana Dev Tools Console. This issue was previously reported and we added a warning to the main Security API docs page, as a result, explaining that the APIs can't be executed from Kibana Dev Tools. However, we need to go one step further and find more ways to communicate this to users. Maybe we need to add a warning or information icon above the code samples. Or maybe we need to add the warning to API docs subpages as well. Open to suggestions!

https://www.elastic.co/guide/en/security/current/security-apis.html

image

@jmikell821
Copy link
Contributor

Hi @peluja1012 thanks for raising this issue. We can start by adding a warning to the API subdoc pages, then we'll see if we need to add this warning elsewhere. We'll be sure to add this warning if we create new API code samples.

@nastasha-solomon
Copy link
Contributor

I inserted the note into all API docs except for the following because they weren’t referenced in this top-level topic.

@peluja1012, if the Kibana Dev Tools Console doesn't support these APIs either, I can insert the note into these topics as well.

@nastasha-solomon
Copy link
Contributor

@peluja1012, I verified with @XavierM that the Kibana Dev Console does not support the Action APIs that push cases to external cases. Updating those last four topics now and will push the changes to the PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants