From f4f372b9ad915ef45e21d52e2fbd6478aa324cd2 Mon Sep 17 00:00:00 2001 From: Rainer Killinger Date: Wed, 14 Jul 2021 11:16:23 +0200 Subject: [PATCH] docs: adjust @validatable documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e7a304a..ff5b0b95 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ External dependencies can not be covered by the annotations. Documentation about | `@sortable` | field is sortable if the core schema is used to put data into a database/key-value store. Fields are always sortable through generic sort, even without annotation. | sort method to be used: `ducet`, `price`, `distance` | | `@text` | string field is interpreted as text | | | `@date` | string field is interpreted as a date field | | -| `@validatable` | marks the type as validatable if the core schema is used to put data into a database/key-value store | | +| `@validatable` | Marks the type for json schema generation, which can be checked at runtime. Any top-level type that is put into a database should always be marked as validatable. | | | `@filterable` | non-object/nested field is filterable if the core schema is used to put data into a database/key-value store | | | `@inheritTags` | inherit all tags from another field | `[SCThingType]::[field]` |