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] Add specifications for deprecated connector APIs #149637

Merged
merged 5 commits into from
Feb 2, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 26, 2023

Summary

Relates to #137240

This PR creates open API specifications that match the existing documentation in https://www.elastic.co/guide/en/kibana/master/actions-and-connectors-legacy-apis.html

It also addresses the following linting issues found by running https://github.com/wework/speccy:

Specification schema is invalid.

#/components/schemas/config_properties_servicenow/properties/isOAuth
expected 'string' to be 'boolean'

#/components/schemas/config_properties_servicenow
expected Object {
  schema: Object { type: 'string' },
  in: 'header',
  name: 'kbn-xsrf',
  required: true
} to have property description
...

@github-actions
Copy link
Contributor

Documentation preview:

@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.7.0 backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) release_note:skip Skip the PR/issue when compiling release notes labels Jan 26, 2023
@lcawl lcawl marked this pull request as ready for review January 27, 2023 02:21
@lcawl lcawl requested a review from a team as a code owner January 27, 2023 02:21
@elasticmachine
Copy link
Contributor

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

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

@lcawl lcawl merged commit 83c382b into elastic:main Feb 2, 2023
@lcawl lcawl deleted the lint-connectors branch February 2, 2023 15:22
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Feb 2, 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 Feb 2, 2023
… (#150189)

# Backport

This will backport the following commits from `main` to `8.6`:
- [[DOCS] Add specifications for deprecated connector APIs
(#149637)](#149637)

<!--- 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-02-02T15:22:32Z","message":"[DOCS]
Add specifications for deprecated connector APIs
(#149637)","sha":"83c382b0887754376840131a2b8e8208d93f855d","branchLabelMapping":{"^v8.7.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorTypes","backport:prev-minor","v8.7.0"],"number":149637,"url":"https://github.com/elastic/kibana/pull/149637","mergeCommit":{"message":"[DOCS]
Add specifications for deprecated connector APIs
(#149637)","sha":"83c382b0887754376840131a2b8e8208d93f855d"}},"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/149637","number":149637,"mergeCommit":{"message":"[DOCS]
Add specifications for deprecated connector APIs
(#149637)","sha":"83c382b0887754376840131a2b8e8208d93f855d"}}]}]
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
Labels
backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) 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.6.2 v8.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants