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.

Sign up for GitHub

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

Jump to bottom

[Actions][Docs] Actions and Connectors API Docs #90974

Merged
merged 12 commits into from
Feb 17, 2021
Merged

[Actions][Docs] Actions and Connectors API Docs #90974

merged 12 commits into from
Feb 17, 2021

Conversation

ymao1
Copy link
Contributor

@ymao1 ymao1 commented Feb 10, 2021 •
edited
Loading

Resolves #49705

Summary

Added API documentation for the actions API. For the create and execute APIs, I linked to existing documentation about each action and alert type because the config, secrets and params schema definitions differ per alert type and I thought it would be more maintainable to have a link vs reproducing. Open to feedback though.

Docs preview: https://kibana_90974.docs-preview.app.elstc.co/guide/en/kibana/master/actions-and-connectors-api.html

@ymao1 ymao1 self-assigned this Feb 10, 2021
@ymao1 ymao1 changed the title [Docs] Actions and Connectors API Docs [Actions][Docs] Actions and Connectors API Docs Feb 10, 2021
@ymao1 ymao1 added Feature:Actions release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.12.0 v8.0.0 labels Feb 10, 2021
@ymao1 ymao1 marked this pull request as ready for review February 10, 2021 17:47
@ymao1 ymao1 requested a review from a team as a code owner February 10, 2021 17:47
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@ymao1 ymao1 requested a review from gchaps February 10, 2021 17:47
@ymao1 ymao1 linked an issue Feb 10, 2021 that may be closed by this pull request
Alerting GA - Connectors documentation #89995
Closed
2 tasks
pmuellr
pmuellr approved these changes Feb 17, 2021
View reviewed changes
Copy link
Member

@pmuellr pmuellr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - so nice seeing our APIs in the docs!

I think we should remove the docs in the README.md file, maybe open an issue for a quick discussion and to track doing that?

YulNaumenko
YulNaumenko approved these changes Feb 17, 2021
View reviewed changes
Copy link
Contributor

@YulNaumenko YulNaumenko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@YulNaumenko
Copy link
Contributor

LGTM - so nice seeing our APIs in the docs!

I think we should remove the docs in the README.md file, maybe open an issue for a quick discussion and to track doing that?

README.md cleanup for Connectors is the next sub issue, so we are good :-)

KOTungseth
KOTungseth reviewed Feb 17, 2021
View reviewed changes
Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for this great addition to our API docs! I made some recommendations around documenting content in multiple locations, minor clean up, and formatting. If you have any questions, let me know!

docs/api/actions-and-connectors.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors/update.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors/update.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors/update.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors/update.asciidoc Outdated Show resolved Hide resolved
docs/api/actions-and-connectors/update.asciidoc Outdated Show resolved Hide resolved
@ymao1
Copy link
Contributor Author

ymao1 commented Feb 17, 2021

@KOTungseth Thank you for the review! I've addressed all of your comments except this one where I left a question.

@ymao1 ymao1 added the auto-backport Deprecated - use backport:version if exact versions are needed label Feb 17, 2021
@ymao1 ymao1 merged commit 88ac3bf into elastic:master Feb 17, 2021
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 17, 2021
@ymao1 @kibanamachine
[Actions][Docs] Actions and Connectors API Docs (elastic#90974)
88559fd 
* Stubbing out asciidocs

* wip

* Finishing connector API docs

* Cleanup

* Removing experimental label

* PR fixes

* PR fixes

* PR fixes
@kibanamachine kibanamachine mentioned this pull request Feb 17, 2021
Merged
@kibanamachine
Copy link
Contributor

💚 Backport successful

✅ 7.x / #91724

Successful backport PRs will be merged automatically after passing CI.

kibanamachine added a commit that referenced this pull request Feb 17, 2021
@kibanamachine @ymao1
[Actions][Docs] Actions and Connectors API Docs (#90974) (#91724)
84bfaa2 
* Stubbing out asciidocs

* wip

* Finishing connector API docs

* Cleanup

* Removing experimental label

* PR fixes

* PR fixes

* PR fixes

Co-authored-by: ymao1 <ying.mao@elastic.co>
@ymao1 ymao1 added the v7.11.0 label Feb 19, 2021
@ymao1 ymao1 mentioned this pull request Feb 19, 2021
Merged
ymao1 added a commit to ymao1/kibana that referenced this pull request Feb 19, 2021
@ymao1
[Actions][Docs] Actions and Connectors API Docs (elastic#90974)
d8cd5b5 
* Stubbing out asciidocs

* wip

* Finishing connector API docs

* Cleanup

* Removing experimental label

* PR fixes

* PR fixes

* PR fixes
ymao1 added a commit that referenced this pull request Feb 19, 2021
@ymao1
[Actions][Docs] Actions and Connectors API Docs (#90974) (#92086)
190155f 
* Stubbing out asciidocs

* wip

* Finishing connector API docs

* Cleanup

* Removing experimental label

* PR fixes

* PR fixes

* PR fixes
@ymao1 ymao1 deleted the actions/docs branch March 25, 2021 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@YulNaumenko YulNaumenko YulNaumenko approved these changes

@KOTungseth KOTungseth KOTungseth approved these changes

@pmuellr pmuellr pmuellr approved these changes

@gchaps gchaps Awaiting requested review from gchaps

Assignees

@ymao1 ymao1

Labels
auto-backport Deprecated - use backport:version if exact versions are needed Feature:Actions release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.11.0 v7.12.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Alerting GA - Connectors documentation API documentation for alerting and actions (asciidoc)
6 participants
@ymao1 @elasticmachine @YulNaumenko @kibanamachine @pmuellr @KOTungseth