From 4dad0482ac8d4fbd840f9a1d0fc91c3d453f8ef8 Mon Sep 17 00:00:00 2001 From: Jaime Soriano Pastor Date: Thu, 15 Sep 2022 17:09:10 +0200 Subject: [PATCH 1/3] Add docs about how to migrate invalid properties in fields definitions --- docs/howto/update_major_package_spec.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/howto/update_major_package_spec.md b/docs/howto/update_major_package_spec.md index de9f8fdcfd..9320a422e0 100644 --- a/docs/howto/update_major_package_spec.md +++ b/docs/howto/update_major_package_spec.md @@ -22,6 +22,17 @@ 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+) + ### field ... is not normalized as expected: expected array, found ... ECS fields can indicate normalization rules. `elastic-package` checks that they From 83de1259455a733d73329dc74ca872d82139d8b3 Mon Sep 17 00:00:00 2001 From: Jaime Soriano Pastor Date: Thu, 15 Sep 2022 17:13:45 +0200 Subject: [PATCH 2/3] Add clarification --- docs/howto/update_major_package_spec.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/howto/update_major_package_spec.md b/docs/howto/update_major_package_spec.md index 9320a422e0..a304d5825f 100644 --- a/docs/howto/update_major_package_spec.md +++ b/docs/howto/update_major_package_spec.md @@ -33,6 +33,9 @@ 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 From d65758ca40d06fec39d9c75dc9a9189312c63407 Mon Sep 17 00:00:00 2001 From: Jaime Soriano Pastor Date: Tue, 20 Sep 2022 13:08:54 +0200 Subject: [PATCH 3/3] Update docs/howto/update_major_package_spec.md Co-authored-by: Mario Rodriguez Molins --- docs/howto/update_major_package_spec.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/howto/update_major_package_spec.md b/docs/howto/update_major_package_spec.md index a304d5825f..5e1c5e98fe 100644 --- a/docs/howto/update_major_package_spec.md +++ b/docs/howto/update_major_package_spec.md @@ -28,9 +28,8 @@ 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 +- 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