diff --git a/package-lock.json b/package-lock.json index 97731fa3..5b49a5de 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1394,7 +1394,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#14647cd43105a7d01af98776efe2cc30ee062689", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#257c94de412b687e0fde157d035719e5c94ca986", "dependencies": { "colors": "^1.4.0", "odata-csdl": "^0.9.5", diff --git a/vocabularies/Analytics.md b/vocabularies/Analytics.md index 757ca5b5..ffa0ab80 100644 --- a/vocabularies/Analytics.md +++ b/vocabularies/Analytics.md @@ -39,7 +39,7 @@ Exactly one of `Property` and `DynamicProperty` must be present Property|Type|Description :-------|:---|:---------- [Property](Analytics.xml#L147)|PropertyPath?|Property that is part of the analytical context -[DynamicProperty](Analytics.xml#L150)|AnnotationPath?|Dynamic property introduced by annotations that is part of the analytical context
Allowed terms: +[DynamicProperty](Analytics.xml#L150)|AnnotationPath?|Dynamic property introduced by annotations that is part of the analytical context
Allowed Terms: [Dimension](Analytics.xml#L159)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The property holds the key of a dimension [Measure](Analytics.xml#L162)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The property holds the numeric value of a measure [AccumulativeMeasure](Analytics.xml#L165)|[Tag](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Tag)|The measure has non-negative and additive values; it can be used in whole-part charts, e.g. the Donut diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 01529047..15fe7c60 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -450,7 +450,7 @@ Exactly one of `Property`, `DynamicProperty` and `Expression` must be present Property|Type|Description :-------|:---|:---------- [Property](Common.xml#L1343)|PropertyPath?|Sort property -[DynamicProperty](Common.xml#L1355)|AnnotationPath?|Dynamic property introduced by an annotation and used as sort property
If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being sorted according to the [`UI.PresentationVariant`](UI.md#PresentationVariant) or `Common.SortOrder` annotation, this instance of `UI.PresentationVariant/SortOrder` or `Common.SortOrder` MUST be silently ignored.
Allowed terms: +[DynamicProperty](Common.xml#L1355)|AnnotationPath?|Dynamic property introduced by an annotation and used as sort property
If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being sorted according to the [`UI.PresentationVariant`](UI.md#PresentationVariant) or `Common.SortOrder` annotation, this instance of `UI.PresentationVariant/SortOrder` or `Common.SortOrder` MUST be silently ignored.
Allowed Terms: [Expression](Common.xml#L1369) *([Experimental](Common.md#Experimental))*|PrimitiveType?|Dynamic expression whose primitive result value is used to sort the instances [Descending](Common.xml#L1373)|Boolean?|Sort direction, ascending if not specified otherwise diff --git a/vocabularies/UI.json b/vocabularies/UI.json index b26a07f8..d71797a6 100644 --- a/vocabularies/UI.json +++ b/vocabularies/UI.json @@ -650,7 +650,7 @@ "$Collection": true, "$Type": "UI.DataFieldAbstract", "@Core.Description": "Available actions and action groups", - "@Validation.DerivedTypeConstraint": ["UI.DataFieldForActionAbstract", "UI.DataFieldForActionGroup>"] + "@Validation.DerivedTypeConstraint": ["UI.DataFieldForActionAbstract", "UI.DataFieldForActionGroup"] } }, "ChartType": { diff --git a/vocabularies/UI.md b/vocabularies/UI.md index a302398e..86e9b985 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -29,7 +29,7 @@ Term|Type|Description [ConnectedFields](UI.xml#L171)|[ConnectedFieldsType](#ConnectedFieldsType)|Group of semantically connected fields with a representation template and an optional label ([Example](UI.xml#L173)) [GeoLocations](UI.xml#L236)|\[[GeoLocationType](#GeoLocationType)\]|Collection of geographic locations [GeoLocation](UI.xml#L240)|[GeoLocationType](#GeoLocationType)|Geographic location -[Contacts](UI.xml#L260)|\[AnnotationPath\]|Collection of contacts
Each collection item MUST reference an annotation of a Communication.Contact
Allowed terms: +[Contacts](UI.xml#L260)|\[AnnotationPath\]|Collection of contacts
Each collection item MUST reference an annotation of a Communication.Contact
Allowed Terms: [MediaResource](UI.xml#L271)|[MediaResourceType](#MediaResourceType)|Properties that describe a media resource
Either `Url` or `Stream` MUST be present, and never both. [DataPoint](UI.xml#L351)|[DataPointType](#DataPointType)|Visualization of a single point of data, typically a number; may also be textual, e.g. a status value [KPI](UI.xml#L659)|[KPIType](#KPIType)|A Key Performance Indicator (KPI) bundles a SelectionVariant and a DataPoint, and provides details for progressive disclosure @@ -88,8 +88,8 @@ Property|Type|Description :-------|:---|:---------- [TypeName](UI.xml#L69)|String|Name of the main entity type [TypeNamePlural](UI.xml#L73)|String|Plural form of the name of the main entity type -[Title](UI.xml#L77)|[DataFieldAbstract?](#DataFieldAbstract)|Title, e.g. for overview pages
This can be a [DataField](#DataField) and any of its children, or a [DataFieldForAnnotation](#DataFieldForAnnotation) targeting [ConnectedFields](#ConnectedFields). -[Description](UI.xml#L87)|[DataFieldAbstract?](#DataFieldAbstract)|Description, e.g. for overview pages
This can be a [DataField](#DataField) and any of its children, or a [DataFieldForAnnotation](#DataFieldForAnnotation) targeting [ConnectedFields](#ConnectedFields). +[Title](UI.xml#L77)|[DataFieldAbstract?](#DataFieldAbstract)
Allowed Derived Types:|Title, e.g. for overview pages
This can be a [DataField](#DataField) and any of its children, or a [DataFieldForAnnotation](#DataFieldForAnnotation) targeting [ConnectedFields](#ConnectedFields). +[Description](UI.xml#L87)|[DataFieldAbstract?](#DataFieldAbstract)
Allowed Derived Types:|Description, e.g. for overview pages
This can be a [DataField](#DataField) and any of its children, or a [DataFieldForAnnotation](#DataFieldForAnnotation) targeting [ConnectedFields](#ConnectedFields). [Image](UI.xml#L97) *([Experimental](Common.md#Experimental))*|Stream?|Image for an instance of the entity type. If the property has a valid value, it can be used for the visualization of the instance. If it is not available or not valid the value of the property `ImageUrl` can be used instead. [ImageUrl](UI.xml#L101)|URL?|Image URL for an instance of the entity type. If the property has a valid value, it can be used for the visualization of the instance. If it is not available or not valid the value of the property `TypeImageUrl` can be used instead. [TypeImageUrl](UI.xml#L105)|URL?|Image URL for the entity type @@ -185,7 +185,7 @@ Property|Type|Description [SampleSize](UI.xml#L398)|PrimitiveType?|Sample size used for the determination of the data point; should contain just integer value as Edm.Byte, Edm.SByte, Edm.Intxx, and Edm.Decimal with scale 0. [ReferencePeriod](UI.xml#L405)|[ReferencePeriod?](#ReferencePeriod)|Reference period [Criticality](UI.xml#L408)|[CriticalityType?](#CriticalityType)|Service-calculated criticality, alternative to CriticalityCalculation -[CriticalityLabels](UI.xml#L411)|AnnotationPath?|Custom labels for the criticality legend. Annotation path MUST end in UI.CriticalityLabels
Allowed terms: +[CriticalityLabels](UI.xml#L411)|AnnotationPath?|Custom labels for the criticality legend. Annotation path MUST end in UI.CriticalityLabels
Allowed Terms: [CriticalityRepresentation](UI.xml#L419) *([Experimental](Common.md#Experimental))*|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon [CriticalityCalculation](UI.xml#L423)|[CriticalityCalculationType?](#CriticalityCalculationType)|Parameters for client-calculated criticality, alternative to Criticality [Trend](UI.xml#L426)|[TrendType?](#TrendType)|Service-calculated trend, alternative to TrendCalculation @@ -399,11 +399,11 @@ Property|Type|Description [ChartType](UI.xml#L718)|[ChartType](#ChartType)|Chart type [AxisScaling](UI.xml#L721)|[ChartAxisScalingType?](#ChartAxisScalingType)|Describes the scale of the chart value axes [Measures](UI.xml#L724)|\[PropertyPath\]|Measures of the chart, e.g. size and color in a bubble chart -[DynamicMeasures](UI.xml#L728)|\[AnnotationPath\]|Dynamic properties introduced by annotations and used as measures of the chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed terms: +[DynamicMeasures](UI.xml#L728)|\[AnnotationPath\]|Dynamic properties introduced by annotations and used as measures of the chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed Terms: [MeasureAttributes](UI.xml#L741)|\[[ChartMeasureAttributeType](#ChartMeasureAttributeType)\]|Describes Attributes for Measures. All Measures used in this collection must also be part of the Measures Property. [Dimensions](UI.xml#L746)|\[PropertyPath\]|Dimensions of the chart, e.g. x- and y-axis of a bubble chart [DimensionAttributes](UI.xml#L749)|\[[ChartDimensionAttributeType](#ChartDimensionAttributeType)\]|Describes Attributes for Dimensions. All Dimensions used in this collection must also be part of the Dimensions Property. -[Actions](UI.xml#L754)|\[[DataFieldAbstract](#DataFieldAbstract)\]|Available actions and action groups +[Actions](UI.xml#L754)|\[[DataFieldAbstract](#DataFieldAbstract)\]
Allowed Derived Types:|Available actions and action groups ## [ChartType](UI.xml#L765) @@ -517,9 +517,9 @@ Exactly one of `Measure` and `DynamicMeasure` must be present Property|Type|Description :-------|:---|:---------- [Measure](UI.xml#L885)|PropertyPath?| -[DynamicMeasure](UI.xml#L888)|AnnotationPath?|Dynamic property introduced by an annotation and used as a measure in a chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed terms: +[DynamicMeasure](UI.xml#L888)|AnnotationPath?|Dynamic property introduced by an annotation and used as a measure in a chart
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being visualized according to the `UI.Chart` annotation, the annotation path MUST be silently ignored.
Allowed Terms: [Role](UI.xml#L901)|[ChartMeasureRoleType?](#ChartMeasureRoleType)| -[DataPoint](UI.xml#L902)|AnnotationPath?|Annotation path MUST end in @UI.DataPoint and the data point's Value MUST be the same property as in Measure
Allowed terms: +[DataPoint](UI.xml#L902)|AnnotationPath?|Annotation path MUST end in @UI.DataPoint and the data point's Value MUST be the same property as in Measure
Allowed Terms: [UseSequentialColorLevels](UI.xml#L910) *([Experimental](Common.md#Experimental))*|Boolean|All measures for which this setting is true should be assigned to levels of the same color. @@ -611,7 +611,7 @@ Property|Type|Description :-------|:---|:---------- [*Label*](UI.xml#L1004)|String?|Facet label [*ID*](UI.xml#L1008)|String?|Unique identifier of a facet. ID should be stable, as long as the perceived semantics of the facet is unchanged. -[Target](UI.xml#L1020)|AnnotationPath|Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge
Allowed terms: +[Target](UI.xml#L1020)|AnnotationPath|Referenced information: Communication.Contact, Communication.Address, or a term that is tagged with UI.ThingPerspective, e.g. UI.StatusInfo, UI.LineItem, UI.Identification, UI.FieldGroup, UI.Badge
Allowed Terms: **Applicable Annotation Terms:** @@ -658,10 +658,10 @@ Property|Type|Description [GroupBy](UI.xml#L1109)|\[PropertyPath\]|Sequence of groupable properties p1, p2, ... defining how the result is composed of instances representing groups, one for each combination of value properties in the queried collection. The sequence specifies a certain level of aggregation for the queried collection, and every group instance will provide aggregated values for properties that are aggregatable. Moreover, the series of sub-sequences (p1), (p1, p2), ... forms a leveled hierarchy, which may become relevant in combination with `InitialExpansionLevel`. [TotalBy](UI.xml#L1118)|\[PropertyPath\]|Sub-sequence q1, q2, ... of properties p1, p2, ... specified in GroupBy. With this, additional levels of aggregation are requested in addition to the most granular level defined by GroupBy: Every element in the series of sub-sequences (q1), (q1, q2), ... introduces an additional aggregation level included in the result. [Total](UI.xml#L1125)|\[PropertyPath\]|Aggregatable properties for which aggregated values should be provided for the additional aggregation levels specified in TotalBy. -[DynamicTotal](UI.xml#L1131)|\[AnnotationPath\]|Dynamic properties introduced by annotations for which aggregated values should be provided for the additional aggregation levels specified in TotalBy
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being presented according to the `UI.PresentationVariant` annotation, the annotation path MUST be silently ignored.
Allowed terms: +[DynamicTotal](UI.xml#L1131)|\[AnnotationPath\]|Dynamic properties introduced by annotations for which aggregated values should be provided for the additional aggregation levels specified in TotalBy
If the annotation referenced by an annotation path does not apply to the same collection of entities as the one being presented according to the `UI.PresentationVariant` annotation, the annotation path MUST be silently ignored.
Allowed Terms: [IncludeGrandTotal](UI.xml#L1144)|Boolean|Result should include a grand total for the properties specified in Total [InitialExpansionLevel](UI.xml#L1147)|Int32|Level up to which the hierarchy defined for the queried collection should be expanded initially. The hierarchy may be implicitly imposed by the sequence of the GroupBy, or by an explicit hierarchy annotation. -[Visualizations](UI.xml#L1153)|\[AnnotationPath\]|Lists available visualization types. Currently supported types are `UI.LineItem`, `UI.Chart`, and `UI.DataPoint`. For each type, no more than a single annotation is meaningful. Multiple instances of the same visualization type shall be modeled with different presentation variants. A reference to `UI.Lineitem` should always be part of the collection (least common denominator for renderers). The first entry of the collection is the default visualization.
Allowed terms: +[Visualizations](UI.xml#L1153)|\[AnnotationPath\]|Lists available visualization types. Currently supported types are `UI.LineItem`, `UI.Chart`, and `UI.DataPoint`. For each type, no more than a single annotation is meaningful. Multiple instances of the same visualization type shall be modeled with different presentation variants. A reference to `UI.Lineitem` should always be part of the collection (least common denominator for renderers). The first entry of the collection is the default visualization.
Allowed Terms: [RecursiveHierarchyQualifier](UI.xml#L1170) *([Experimental](Common.md#Experimental))*|[HierarchyQualifier?](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#HierarchyQualifier)|Qualifier of the recursive hierarchy that should be applied to the Visualization [RequestAtLeast](UI.xml#L1174)|\[PropertyPath\]|Properties that should always be included in the result of the queried collection
Properties in `RequestAtLeast` must occur either in the `$select` clause of an OData request or among the grouping properties in an `$apply=groupby((grouping properties),...)` clause of an aggregating OData request. [SelectionFields](UI.xml#L1197) *([Experimental](Common.md#Experimental))*|\[PropertyPath\]|Properties that should be presented for filtering a collection of entities. Can be provided inline or as a reference to a `UI.SelectionFields` annotation via Path. @@ -715,7 +715,7 @@ Exactly one of `PropertyName` and `DynamicPropertyName` must be present Property|Type|Description :-------|:---|:---------- [PropertyName](UI.xml#L1267)|PropertyPath?|Path to the property -[DynamicPropertyName](UI.xml#L1279)|AnnotationPath?|Dynamic property introduced by annotations for which value ranges are specified
If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being filtered according to the `UI.SelectionVariant` annotation, this instance of `UI.SelectionVariant/SelectOptions` MUST be silently ignored. For an example, see the `UI.SelectionVariant` annotation in the [example](../examples/DynamicProperties-sample.xml).
Allowed terms: +[DynamicPropertyName](UI.xml#L1279)|AnnotationPath?|Dynamic property introduced by annotations for which value ranges are specified
If the annotation referenced by the annotation path does not apply to the same collection of entities as the one being filtered according to the `UI.SelectionVariant` annotation, this instance of `UI.SelectionVariant/SelectOptions` MUST be silently ignored. For an example, see the `UI.SelectionVariant` annotation in the [example](../examples/DynamicProperties-sample.xml).
Allowed Terms: [Ranges](UI.xml#L1293)|\[[SelectionRangeType](#SelectionRangeType)\]|List of value ranges @@ -863,7 +863,7 @@ Property|Type|Description [*Criticality*](UI.xml#L1650)|[CriticalityType?](#CriticalityType)|Criticality of the data field value [*CriticalityRepresentation*](UI.xml#L1653)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon [*IconUrl*](UI.xml#L1656)|URL?|Optional icon -[Target](UI.xml#L1677)|AnnotationPath|Target MUST reference an annotation of terms Communication.Contact, Communication.Address, UI.DataPoint, UI.Chart, UI.FieldGroup, or UI.ConnectedFields
Allowed terms: +[Target](UI.xml#L1677)|AnnotationPath|Target MUST reference an annotation of terms Communication.Contact, Communication.Address, UI.DataPoint, UI.Chart, UI.FieldGroup, or UI.ConnectedFields
Allowed Terms: **Applicable Annotation Terms:** @@ -1004,7 +1004,7 @@ Property|Type|Description [*Criticality*](UI.xml#L1650)|[CriticalityType?](#CriticalityType)|Criticality of the data field value [*CriticalityRepresentation*](UI.xml#L1653)|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon [*IconUrl*](UI.xml#L1656)|URL?|Optional icon -[Value](UI.xml#L1755)|Untyped|The data field's value +[Value](UI.xml#L1755)|Untyped
Allowed Derived Types:|The data field's value **Applicable Annotation Terms:** diff --git a/vocabularies/UI.xml b/vocabularies/UI.xml index c0c27b40..1c660c3d 100644 --- a/vocabularies/UI.xml +++ b/vocabularies/UI.xml @@ -756,7 +756,7 @@ The trend is UI.DataFieldForActionAbstract - UI.DataFieldForActionGroup> + UI.DataFieldForActionGroup