Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-07 14:02:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add @inheritTags documentation

Browse Source
This commit is contained in:
Wieland Schöbl
2020-11-11 11:40:36 +01:00
parent d34e66fbbc
commit 8641bfc877
1 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -36,7 +36,7 @@ Annotations are used to add additional informations to fields, which are used to
External dependencies can not be covered by the annotations. Documentation about some of the annotations can be found in: [typedoc](https://typedoc.org/guides/doccomments/)
| annotation | description | parameters |
|-------------------|-------------------------------------------|---------------|
|-------------------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|
| `@aggregatable` | used for generating of aggregations of the field if the core schema is used to put data into a database/key-value store | whether the property is being used on the top type or across all types: `global` |
| `@float` | number field is interpreted as float | |
| `@indexable` | marks the type as indexable if the core schema is used to put data into a database/key-value store | |
@@ -46,5 +46,6 @@ External dependencies can not be covered by the annotations. Documentation about
| `@text` | string field is interpreted as text | |
| `@validatable` | marks the type as validatable if the core schema is used to put data into a database/key-value store | |
| `@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]` |
*Note: tags ignore casing, but for consistency they should use the variants proposed here.*