You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/manuals/orion-api.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -455,7 +455,7 @@ There are some exception cases in which the above restrictions do not apply. In
455
455
* HTTP and Kafka custom header values allow the `'` and `"` quote characters to support quoted string literals in JEXL expressions
456
456
* Within `ngsi` (i.e. `id`, `type` and attribute values) in [NGSI Payload patching](#ngsi-payload-patching) (to support characters used in the [JEXL support in custom notifications](#jexl-support-in-custom-notifications))
457
457
* Whichever attribute value which uses `TextUnrestricted` as attribute type (see [Special Attribute Types](#special-attribute-types) section)
458
-
* Whichever attribute value which has a boolean metadata named `TextUnrestricted` with value `true` (see [Special Attribute Types](#special-attribute-types) section)
458
+
* Whichever attribute value which has a boolean metadata named `TextUnrestricted` with value `true` (see [Special Metadata Types](#special-metadata-types) section)
459
459
460
460
## Identifiers syntax restrictions
461
461
@@ -704,23 +704,6 @@ meaning:
704
704
}
705
705
```
706
706
707
-
Alternatively, syntax checks can be skipped by using a metadata named `TextUnrestricted` with value `true` of type `Boolean` (leaving the attribute type free for other custom types). For instance:
708
-
709
-
```json
710
-
{
711
-
"funnyAttr": {
712
-
"type": "FunnyType",
713
-
"value": "Value with <forbidden> characters (like = or ;)",
714
-
"metadata": {
715
-
"TextUnrestricted": {
716
-
"value": true,
717
-
"type": "Boolean"
718
-
}
719
-
}
720
-
}
721
-
}
722
-
```
723
-
724
707
## Builtin Attributes
725
708
726
709
There are entity properties that are not directly modifiable by clients, but that can be
@@ -780,6 +763,23 @@ type has an special semantic for Orion:
780
763
781
764
*`evalPriority`: used by expression evaluation. Have a look to [this specific section](#evaluation-priority) for details.
782
765
766
+
*`TextUnrestricted`: when a boolean metadata named `TextUnrestricted` with value `true` is added to an attribute, Orion will skip [syntax restrictions](#general-syntax-restrictions) checkings on the attribute value. This leaves the attribute type free for other custom types. For instance:
767
+
768
+
```json
769
+
{
770
+
"funnyAttr": {
771
+
"type": "FunnyType",
772
+
"value": "Value with <forbidden> characters (like = or ;)",
773
+
"metadata": {
774
+
"TextUnrestricted": {
775
+
"value": true,
776
+
"type": "Boolean"
777
+
}
778
+
}
779
+
}
780
+
}
781
+
```
782
+
783
783
At the present moment `ignoreType` is supported only for geo-location types, this way allowing a
784
784
mechanism to overcome the limit of only one geo-location per entity (more details
785
785
in [Geospatial properties of entities](#geospatial-properties-of-entities) section). Support
0 commit comments