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

[DOCS] Add Jira and index connector details to create connector API #133347

Merged
merged 5 commits into from
Jun 6, 2022
Merged

[DOCS] Add Jira and index connector details to create connector API #133347

merged 5 commits into from
Jun 6, 2022

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 1, 2022 •
edited
Loading

Summary

This PR updates the create connector API documentation so that it includes the properties necessary to configure a Jira connector or an index connector. Thus users don't have to go to the Jira connector and action or Index connector and action pages to hunt for this information.

It also sorts the existing API parameters alphabetically.

If this change is approved, we will add similar details for the other connector types.

Preview

https://kibana_133347.docs-preview.app.elstc.co/guide/en/kibana/master/create-connector-api.html

@lcawl lcawl added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework v8.4.0 v8.3.1 release_note:skip Skip the PR/issue when compiling release notes auto-backport Deprecated - use backport:version if exact versions are needed labels Jun 1, 2022
@lcawl lcawl changed the title [DOCS] Add Jira connector details to create connector API [DOCS] Add Jira and index connector details to create connector API Jun 1, 2022
@lcawl lcawl marked this pull request as ready for review June 2, 2022 15:43
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@lcawl lcawl requested a review from a team June 2, 2022 15:43
@nastasha-solomon nastasha-solomon mentioned this pull request Jun 6, 2022
Closed
ymao1
ymao1 approved these changes Jun 6, 2022
View reviewed changes
Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl merged commit 36aab8f into elastic:main Jun 6, 2022
@lcawl lcawl deleted the create-connector branch June 6, 2022 22:21
kibanamachine pushed a commit that referenced this pull request Jun 6, 2022
@lcawl
[DOCS] Add Jira and index connector details to create connector API (#…
31cfd9e 
…133347)

(cherry picked from commit 36aab8f)
@kibanamachine kibanamachine mentioned this pull request Jun 6, 2022
Merged
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.3

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@lcawl lcawl mentioned this pull request Jun 6, 2022
Closed
35 tasks
kibanamachine added a commit that referenced this pull request Jun 6, 2022
@kibanamachine @lcawl
[DOCS] Add Jira and index connector details to create connector API (#…
d7fe5bc 
…133347) (#133687)

(cherry picked from commit 36aab8f)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@lcawl lcawl mentioned this pull request Jun 6, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ymao1 ymao1 ymao1 approved these changes

Assignees
No one assigned
Labels
auto-backport Deprecated - use backport:version if exact versions are needed docs Feature:Actions/ConnectorTypes Issues related to specific Connector Types on the Actions Framework release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.3.1 v8.4.0
Projects
No open projects
AppEx: ResponseOps - Execution & Connectors
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lcawl @elasticmachine @kibanamachine @ymao1