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

Document field description format #340

Closed
skh opened this issue Apr 14, 2020 · 3 comments
Closed

Document field description format #340

skh opened this issue Apr 14, 2020 · 3 comments

Comments

@skh
Copy link
Contributor

skh commented Apr 14, 2020

Packages may contain fields definitions in YAML files in dataset/DATASETNAME/fields/ directories. These files are used by EPM to generate elasticsearch index templates and kibana index patterns. The format of these files comes from the beats project, but has never been documented.

This task is to document this format in this repository.

@mtojek
Copy link
Contributor

mtojek commented Apr 14, 2020

I know that it's not a fully defined schema, but I've recently defined a structure for a single field (for serialization purposes): https://github.com/elastic/package-registry/blob/master/dev/import-beats/fields.go#L21

@ruflin
Copy link
Contributor

ruflin commented Apr 20, 2020

@skh You might be able to copy some parts from here: elastic/beats#12505

@mtojek
Copy link
Contributor

mtojek commented Nov 19, 2021

We have the package-spec now and these files are also covered. Resolving.

@mtojek mtojek closed this as completed Nov 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants