Add documention for parameters field (#6)

* Add undocumented field argument * Remove the PR template
huntresslabs · Jul 1, 2024 · f0f2288 · f0f2288
1 parent 5ec39e0
commit f0f2288
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 14 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
diff --git a/schemas/README.md b/schemas/README.md
@@ -170,6 +170,7 @@ Supported keys to describe fields
 - 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 notices should not have newlines.
+- parameters (optional): An object of arbitrary parameters to include in the field settings.
 
 Supported keys to describe expected values for a field