Skip to content

Commit

Permalink
beta should not have newlines
Browse files Browse the repository at this point in the history
  • Loading branch information
ebeahan committed Nov 18, 2020
1 parent f46c3e4 commit 598fc05
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions schemas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Optional field set attributes:
- reusable (optional): Used to identify which field sets are expected to be reused in multiple places.
See "Field set reuse" for details.
- beta: Adds a beta marker for the entire fieldset. The text provided in this attribute is used as content of the beta marker in the documentation.
Beta should not have newlines.

### Field set reuse

Expand Down Expand Up @@ -106,15 +107,15 @@ The above defines all process fields in both places:
```

The `beta` marker can optionally be used along with `at` and `as` to include a beta marker in the field reuses section, marking specific reuse locations as beta.
Beta should not have newlines.

```
reusable:
top_level: true
expected:
- at: user
as: target
beta: >
Reusing these fields in this location is currently considered beta.
beta: Reusing these fields in this location is currently considered beta.
```
### List of fields
Expand Down Expand Up @@ -146,7 +147,7 @@ Supported keys to describe fields
- format: Field format that can be used in a Kibana index template.
- normalize: Normalization steps that should be applied at ingestion time. Supported values:
- array: the content of the field should be an array (even when there's only one value).
- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta.
- beta (optional): Adds a beta marker for the field to the description. The text provided in this attribute is used as content of the beta marker in the documentation. Note that when a whole field set is marked as beta, it is not necessary nor recommended to mark all fields in the field set as beta. Beta should not have newlines.

Supported keys to describe expected values for a field

Expand Down

0 comments on commit 598fc05

Please sign in to comment.