Skip to content

Add docs about how to migrate invalid properties in fields definitions #978

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Sep 20, 2022
Merged

Add docs about how to migrate invalid properties in fields definitions #978

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4dad048
Add docs about how to migrate invalid properties in fields definitions
jsoriano Sep 15, 2022
83de125
Add clarification
jsoriano Sep 15, 2022
d65758c
Update docs/howto/update_major_package_spec.md
jsoriano Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/howto/update_major_package_spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,19 @@ conditions:
elastic.subscription: basic
```

### field ...: Additional property ... is not allowed

Validation of properties on fields definitions is stricter now. If you see any
error about properties not allowed in fields definitions, this probably means
one of these two things:

- There is a typo, please check that this is the property you wanted to use.
- The property is not supported, then you should probably remove it. If you think
that the property should be supported, please [open an issue](https://github.com/elastic/package-spec/issues/new?assignees=&labels=discuss&template=Change_Proposal.md&title=%5BChange+Proposal%5D+)

Some of the non-supported commonly used properties are `required`, `release` or
`overwrite`.

### field ... is not normalized as expected: expected array, found ...

ECS fields can indicate normalization rules. `elastic-package` checks that they
Expand Down