elastic / elastic/package-spec

[Change Proposal] Provide human-readable name to integration inputs

Open
#385 2 comments 0 reactions 0 assignees View on GitHub
discuss Team:Ecosystem
Dominant language
Go
Stars
20
Forks
93
Avg merge
15h 10m
Merged PRs (30d)
12

Description

Proposal coming from the discussion in https://github.com/elastic/kibana/issues/132263

Creating an integration (package-policy) with Fleet API requires specifying input types, and its meaning is not obvious for users.

Could we extend package-spec with a new field in inputs, that would be a human-readable value?
This would make it easier for users to create integrations.

Current API:
```
POST http://elastic:changeme@localhost:5601/julia/api/fleet/package_policies
kbn-xsrf: kibana

{
"name":"apache-5",
"inputs": [
{"type":"logfile","enabled":true},
{"type":"apache/metrics","enabled":false}
],
"package": {
"name":"apache",
"version":"0.3.3"
}
}
```

Proposed change:
```
"inputs": [
{"id":"apache_logs","enabled":true},
{"id":"apache_metrics","enabled":false}
],
```

The proposed change would require updating all packages' inputs with unique id values.

cc @joshdover

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.