expected_values in field definitions#1952
Conversation
|
Hi @ebeahan Have you looked into using the same structure as The fact that Assuming inviability of renaming |
I haven't thought of using a list of objects over a list.
Are there other keys/attributes to set underneath |
|
The relationship between
I agree the simplicity of having the values in an array would be aesthetically preferable, but I'm uncomfortable with doing I agree that the description may be redundant for |
|
Discussed offline @ebeahan let's go ahead with the list |
|
LGTM |
* render expected_values in field details j2 template * add check of examples against expected_values * document expected_values attr * incorporate cell formatting option * note --strict validation of example against expected_values * escape unintended copyright text replacements (cherry picked from commit 4a3ec76) # Conflicts: # experimental/generated/csv/fields.csv # generated/csv/fields.csv
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
* render expected_values in field details j2 template * add check of examples against expected_values * document expected_values attr * incorporate cell formatting option * note --strict validation of example against expected_values * escape unintended copyright text replacements (cherry picked from commit 4a3ec76)
* render expected_values in field details j2 template * add check of examples against expected_values * document expected_values attr * incorporate cell formatting option * note --strict validation of example against expected_values * escape unintended copyright text replacements
Adds support for an
expected_valuesattribute in schema field definitions.Specific ECS fields include lists of expected values, and
expected_valuesprovides a consistent location to capture those values.Example definition
Fields define an
expected_valuesarray. Additionally, the--strictflag now compares the value(s) inexampleagainst theexpected_values.Example field rendering
The Jinja2 template now consistently renders the
expected_values. Unordered lists are now also generated with formatting.Additional field-details.asciidoc formatting change
Asciidoc supports additional formatting options in a table cell using the
a|operator. This change opens up a better formatting experience for ECS field descriptions.The
field-details.j2template now usesa|for each field description.Addresses #1951