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 update connector API #133692

Merged
merged 2 commits into from
Jun 7, 2022
Merged

[DOCS] Add Jira and index connector details to update connector API #133692

merged 2 commits into from
Jun 7, 2022

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jun 6, 2022 •
edited
Loading

Summary

Relates to #133347 and #133689

This PR edits the update 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.

Since these details are identical to what appears in the "create connector" API, content re-use is implemented via tagged regions. Thus we don't have to maintain these details in two places.

It also sorts the existing API parameters alphabetically.

Preview

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

@lcawl lcawl mentioned this pull request Jun 6, 2022
Closed
35 tasks
@lcawl lcawl added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX 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 6, 2022
@lcawl lcawl marked this pull request as ready for review June 7, 2022 00:19
@elasticmachine
Copy link
Contributor

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

@lcawl lcawl requested a review from a team June 7, 2022 00:19
ymao1
ymao1 approved these changes Jun 7, 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! Asciidoc magic!

@lcawl lcawl merged commit ca6e1ff into elastic:main Jun 7, 2022
@lcawl lcawl deleted the update-connector branch June 7, 2022 15:04
kibanamachine pushed a commit that referenced this pull request Jun 7, 2022
@lcawl
[DOCS] Add Jira and index connector details to update connector API (#…
0610d05 
…133692)

(cherry picked from commit ca6e1ff)
@kibanamachine kibanamachine mentioned this pull request Jun 7, 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

kibanamachine added a commit that referenced this pull request Jun 7, 2022
@kibanamachine @lcawl
[DOCS] Add Jira and index connector details to update connector API (#…
6eef702 
…133692) (#133779)

(cherry picked from commit ca6e1ff)

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
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/ConnectorsManagement Issues related to Connectors Management UX 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
None yet
Milestone
No milestone
Development

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