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 configuration details to connector APIs #133689

Closed
33 of 35 tasks
lcawl opened this issue Jun 6, 2022 · 3 comments
Closed
33 of 35 tasks

[DOCS] Add configuration details to connector APIs #133689

lcawl opened this issue Jun 6, 2022 · 3 comments
Assignees
Labels
docs Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX Team:Docs

Comments

@lcawl
Copy link
Contributor

lcawl commented Jun 6, 2022

The Action and connector APIs currently do not contain the details necessary to fill in the config and params objects. Instead, they link to Connectors docs.

Rather than expecting users to patch together that information, however, there seems to be no reason why we can't move that level of detail into the API pages.

In particular, we'd want to augment the create connector API, update connector API, and run connector API with details for all of the following connectors:

The params that you can specify when you run a connector likewise might be incomplete: _execute.yaml

@lcawl lcawl added Team:Docs docs Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX labels Jun 6, 2022
@lcawl lcawl self-assigned this Jun 6, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl
Copy link
Contributor Author

lcawl commented Sep 29, 2023

Per discussion with @shanisagiv1 the most important connectors to get fully documented are email, slack, and server log. I believe the only pieces left to do in the specification are the execution actions. If a good publishing method for the API specifications is not imminent, those would be the connectors to consider manually adding to the old API docs as well.

@lcawl
Copy link
Contributor Author

lcawl commented Oct 3, 2023

Since the configuration details are now complete, I've created #167931 to follow up on the missing run connector API details.

@lcawl lcawl closed this as completed Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Feature:Actions/ConnectorsManagement Issues related to Connectors Management UX Team:Docs
Projects
None yet
Development

No branches or pull requests

2 participants