diff --git a/README.md b/README.md index cb122493..094197fc 100644 --- a/README.md +++ b/README.md @@ -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 | | diff --git a/src/things/abstract/thing.ts b/src/things/abstract/thing.ts index e9a04eb6..75bd3594 100644 --- a/src/things/abstract/thing.ts +++ b/src/things/abstract/thing.ts @@ -92,7 +92,7 @@ export interface SCThingWithoutReferences { * * @sortable ducet * @filterable - * @aggregatable + * @aggregatable global */ type: SCThingType; /**