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] Create open API specification for run connector #149274

Merged
merged 14 commits into from
Jan 26, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 20, 2023

Summary

Relates to #137240

This PR creates an open API specification for the run connector API.

NOTE:

  • The specification currently covers only index, Jira, Opsgenie and server log, ServiceNow, and Swimlane connectors.

When I try to group the possible actions by connector, I receive warnings during linting, seemingly because the same action type (e.g. pushToService or getChoices) can be used for multiple connector types with differing subActionParams and there is no associated connector type parameter to distinguish which are valid together.
The linting warnings looked like this:

[9] bundled.json:4305:21 at #/components/examples/run_servicenow_itom_connector_request/value/params

Example value must conform to the schema: `params` property must match exactly one schema in oneOf.

4303 |   "summary": "Run a ServiceNow ITOM connector to retrieve the list of choices.",
4304 |   "value": {
4305 |     "params": {
4306 |       "subAction": "getChoices",
   … |       < 6 more lines >
4313 |     }
4314 |   }
4315 | },

Therefore, I have grouped the options by subAction type instead.

@lcawl lcawl added docs Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX v8.7.0 backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) labels Jan 20, 2023
@lcawl lcawl marked this pull request as ready for review January 26, 2023 00:17
@lcawl lcawl requested review from a team as code owners January 26, 2023 00:17
@elasticmachine
Copy link
Contributor

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

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #34 / cases security and spaces enabled: trial push_case incident recorder server should map the fields and add the backlink to Kibana correctly

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@szabosteve szabosteve 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 f78236a into elastic:main Jan 26, 2023
@lcawl lcawl deleted the run-connector branch January 26, 2023 16:53
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jan 26, 2023
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.6

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Jan 26, 2023
#149614)

# Backport

This will backport the following commits from `main` to `8.6`:
- [[DOCS] Create open API specification for run connector
(#149274)](#149274)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-01-26T16:53:47Z","message":"[DOCS]
Create open API specification for run connector
(#149274)","sha":"f78236a2e4c1532a9a135444bea95a0f89d1047e","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:enhancement","Team:ResponseOps","docs","Feature:Actions/ConnectorsManagement","backport:prev-minor","v8.7.0"],"number":149274,"url":"https://github.com/elastic/kibana/pull/149274","mergeCommit":{"message":"[DOCS]
Create open API specification for run connector
(#149274)","sha":"f78236a2e4c1532a9a135444bea95a0f89d1047e"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.7.0","labelRegex":"^v8.7.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/149274","number":149274,"mergeCommit":{"message":"[DOCS]
Create open API specification for run connector
(#149274)","sha":"f78236a2e4c1532a9a135444bea95a0f89d1047e"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
kqualters-elastic pushed a commit to kqualters-elastic/kibana that referenced this pull request Feb 6, 2023
darnautov pushed a commit to darnautov/kibana that referenced this pull request Feb 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX release_note:enhancement Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.6.1 v8.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants