[DOCS] Create open API specification for create/update connector #148691
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lcawl
added
Team:ResponseOps
|
Documentation preview: |
|
Pinging @elastic/response-ops (Team:ResponseOps) |
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Jan 17, 2023
…stic#148691) (cherry picked from commit 4f6d0df)
💚 All backports created successfully
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 17, 2023
#148691) (#149063) # Backport This will backport the following commits from `main` to `8.6`: - [[DOCS] Create open API specification for create/update connector (#148691)](#148691) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-01-17T17:31:48Z","message":"[DOCS] Create open API specification for create/update connector (#148691)","sha":"4f6d0dff28221d449cc7f1631794bd7a619d8033","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":148691,"url":"https://github.com/elastic/kibana/pull/148691","mergeCommit":{"message":"[DOCS] Create open API specification for create/update connector (#148691)","sha":"4f6d0dff28221d449cc7f1631794bd7a619d8033"}},"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/148691","number":148691,"mergeCommit":{"message":"[DOCS] Create open API specification for create/update connector (#148691)","sha":"4f6d0dff28221d449cc7f1631794bd7a619d8033"}}]}] BACKPORT--> Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Relates to #137240
This PR creates the open API specification for:
create connector
update connector
At this point, the spec does not cover every type of connector. It covers only the connectors that were already in the API documentation (IBM resilient, index, Jira, Opsgenie, ServiceNow, Swimlane, server log, Webhook - Case Management); the rest contain an open-ended "additionalProperties:true" for now. Due to this and the fact that the update connector endpoint doesn't contain a discriminator (e.g. connector type) to differentiate the valid options, the example validation failed until I commented out the incomplete connectors.