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

feat: add aggregatable tag for type field

Browse Source
This commit is contained in:
Wieland Schöbl
2019-11-05 13:39:06 +01:00
parent 5561b36a34
commit 443cb748fb
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -37,12 +37,12 @@ External dependencies can not be covered by the annotations. Documentation about
| 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 | |
| `@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| |
| `@integer` | number field is interpreted as integer | |
| `@keyword` | string field is interpreted as keyword | |
| `@sortable` | field is sortable if the core schema is used to put data into a database/key-value store | sort method to be used: ducet, price, distance |
| `@sortable` | field is sortable if the core schema is used to put data into a database/key-value store | sort method to be used: `ducet`, `price`, `distance` |
| `@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 | |

2
src/things/abstract/thing.ts
View File

@@ -92,7 +92,7 @@ export interface SCThingWithoutReferences {
*
* @sortable ducet
* @filterable
* @aggregatable
* @aggregatable global
*/
type: SCThingType;
/**