@ThomasChadzelek's comments

SAP · Feb 11, 2025 · ff2ea96 · ff2ea96
1 parent e51acaa
commit ff2ea96
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 25 deletions.
diff --git a/vocabularies/Analytics.json b/vocabularies/Analytics.json
@@ -185,7 +185,7 @@
             "$Collection": true,
             "$Type": "Analytics.MultiLevelExpandLevel",
             "@Core.Description": "Collection of aggregation levels forming a leveled hierarchy",
-            "@Core.LongDescription": "Each element in the collection defines the properties that constitute one level.\n            A property must not referenced by more than one level.\n            The first element in the collection defines the property names of the coarsest level,\n            the following elements define the property names of consecutively finer-grained aggregation levels.\n            The function result is the leveled hierarchy with these levels in preorder,\n            entries on the finest-grained level cannot be expanded further.\n            All referenced properties must be groupable."
+            "@Core.LongDescription": "Each element in the collection defines the properties that constitute one level.\n            A property must not be referenced by more than one level.\n            The first element in the collection defines the property names of the coarsest level,\n            the following elements define the property names of consecutively finer-grained aggregation levels.\n            The function result is the leveled hierarchy with these levels in preorder,\n            entries on the finest-grained level cannot be expanded further.\n            All referenced properties must be groupable."
           },
           {
             "$Name": "Aggregation",
@@ -202,7 +202,8 @@
           {
             "$Name": "ShowLevels",
             "$Type": "Edm.Int64",
-            "@Core.Description": "Number of levels to be shown in the initial expansion (absent means all levels)",
+            "@Core.Description": "Number N of levels to be shown in the initial expansion",
+            "@Core.LongDescription": "The initial expansion shows the first N levels as defined in `Levels` (0 ≤ N ≤ length of `Levels`).\n            If this parameter is omitted, all levels are shown.",
             "@Core.OptionalParameter": {}
           },
           {
@@ -234,11 +235,11 @@
       "@Core.LongDescription": "`DimensionProperties` must be used to identify entries in [`ExpandEntries/Entry`](#MultiLevelExpandEntry),\n          otherwise they have the same effect as `AdditionalProperties`.",
       "DimensionProperties": {
         "$Collection": true,
-        "@Core.Description": "A non-empty set of property names that define a combination of dimension values"
+        "@Core.Description": "A non-empty list of property names that define a combination of dimension values"
       },
       "AdditionalProperties": {
         "$Collection": true,
-        "@Core.Description": "A possibly empty set of names of additional properties of the dimensions that occur in `DimensionProperties`"
+        "@Core.Description": "A possibly empty list of names of additional properties of the dimensions that occur in `DimensionProperties`"
       }
     },
     "MultiLevelExpandSiblingOrder": {
@@ -258,7 +259,7 @@
       "@Core.Description": "Expansion state of an entry in an [unnamed leveled hierarchy](#MultiLevelExpand)",
       "Entry": {
         "$Collection": true,
-        "@Core.Description": "An entry on a given [level](#MultiLevelExpandLevel) is identified by a collection of values for the `DimensionProperties` that constitute all levels up to and including the given one"
+        "@Core.Description": "An entry on a given [level](#MultiLevelExpandLevel) is identified by a list of values for the `DimensionProperties` that constitute all levels up to and including the given one"
       },
       "Levels": {
         "$Type": "Edm.Int64",

diff --git a/vocabularies/Analytics.md b/vocabularies/Analytics.md
@@ -17,7 +17,7 @@ Term|Type|Description
 [AggregatedProperties](Analytics.xml#L106) *(Deprecated)*|\[[AggregatedPropertyType](#AggregatedPropertyType)\]|<a name="AggregatedProperties"></a>Deprecated in favor of [`AggregatedProperty`](#AggregatedProperty)
 [AggregatedProperty](Analytics.xml#L124)|[AggregatedPropertyType](#AggregatedPropertyType)|<a name="AggregatedProperty"></a>Dynamic property for aggregate expression with specified aggregation method defined on the annotated entity type.
 [AnalyticalContext](Analytics.xml#L144)|\[[AnalyticalContextType](#AnalyticalContextType)\]|<a name="AnalyticalContext"></a>Collection of properties that define an analytical context
-[LevelInformation](Analytics.xml#L300) *([Experimental](Common.md#Experimental))*|[HierarchyType](Hierarchy.md#HierarchyType)|<a name="LevelInformation"></a>Information about grouping levels in the result set of a request including the [`MultiLevelExpand`](#MultiLevelExpand) transformation
+[LevelInformation](Analytics.xml#L304) *([Experimental](Common.md#Experimental))*|[HierarchyType](Hierarchy.md#HierarchyType)|<a name="LevelInformation"></a>Information about grouping levels in the result set of a request including the [`MultiLevelExpand`](#MultiLevelExpand) transformation
 
 
 ## Functions
@@ -57,13 +57,13 @@ $apply=filter(Industry in ('IT','AI'))
 Parameter|Type|Description
 :--------|:---|:----------
 **[InputSet](Analytics.xml#L213)**|\[EntityType\]|**Binding parameter:** Entity set to be processed
-[Levels](Analytics.xml#L216)|\[[MultiLevelExpandLevel](#MultiLevelExpandLevel)\]|Collection of aggregation levels forming a leveled hierarchy<br>Each element in the collection defines the properties that constitute one level. A property must not referenced by more than one level. The first element in the collection defines the property names of the coarsest level, the following elements define the property names of consecutively finer-grained aggregation levels. The function result is the leveled hierarchy with these levels in preorder, entries on the finest-grained level cannot be expanded further. All referenced properties must be groupable.
+[Levels](Analytics.xml#L216)|\[[MultiLevelExpandLevel](#MultiLevelExpandLevel)\]|Collection of aggregation levels forming a leveled hierarchy<br>Each element in the collection defines the properties that constitute one level. A property must not be referenced by more than one level. The first element in the collection defines the property names of the coarsest level, the following elements define the property names of consecutively finer-grained aggregation levels. The function result is the leveled hierarchy with these levels in preorder, entries on the finest-grained level cannot be expanded further. All referenced properties must be groupable.
 [Aggregation](Analytics.xml#L228)|\[String\]|Properties to aggregate for all result entries on all levels<br>All properties in this collection must be custom aggregates.
 [SiblingOrder](Analytics.xml#L234)|\[[MultiLevelExpandSiblingOrder](#MultiLevelExpandSiblingOrder)\]|Sort specification to apply to all direct descendants of a given entry in the resulting leveled hierarchy
-*[ShowLevels](Analytics.xml#L237)*|Int64|*Optional parameter:* Number of levels to be shown in the initial expansion (absent means all levels)
-*[ExpandEntries](Analytics.xml#L243)*|\[[MultiLevelExpandEntry](#MultiLevelExpandEntry)\]|*Optional parameter:* Entries with exceptional expansion
-*[SubtotalsAtBottom](Analytics.xml#L249)*|Bool|*Optional parameter:* Whether to duplicate the group headers so that they appear before and after their descendants<br>The entry before has [DrillState](Hierarchy.md#HierarchyType) `expanded`, the entry after has DrillState `subtotal`.
-[&rarr;](Analytics.xml#L261)|\[EntityType\]|Output set including the instance annotation [`LevelInformation`](#LevelInformation)
+*[ShowLevels](Analytics.xml#L237)*|Int64|*Optional parameter:* Number N of levels to be shown in the initial expansion<br>The initial expansion shows the first N levels as defined in `Levels` (0 ≤ N ≤ length of `Levels`). If this parameter is omitted, all levels are shown.
+*[ExpandEntries](Analytics.xml#L247)*|\[[MultiLevelExpandEntry](#MultiLevelExpandEntry)\]|*Optional parameter:* Entries with exceptional expansion
+*[SubtotalsAtBottom](Analytics.xml#L253)*|Bool|*Optional parameter:* Whether to duplicate the group headers so that they appear before and after their descendants<br>The entry before has [DrillState](Hierarchy.md#HierarchyType) `expanded`, the entry after has DrillState `subtotal`.
+[&rarr;](Analytics.xml#L265)|\[EntityType\]|Output set including the instance annotation [`LevelInformation`](#LevelInformation)
 
 
 <a name="AggregatedPropertyType"></a>
@@ -93,31 +93,31 @@ Property|Type|Description
 [AccumulativeMeasure](Analytics.xml#L168)|[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
 
 <a name="MultiLevelExpandLevel"></a>
-## [MultiLevelExpandLevel](Analytics.xml#L265) *([Experimental](Common.md#Experimental))*
+## [MultiLevelExpandLevel](Analytics.xml#L269) *([Experimental](Common.md#Experimental))*
 Property names constituting a level in an [unnamed leveled hierarchy](#MultiLevelExpand)
 
 `DimensionProperties` must be used to identify entries in [`ExpandEntries/Entry`](#MultiLevelExpandEntry),
           otherwise they have the same effect as `AdditionalProperties`.
 
 Property|Type|Description
 :-------|:---|:----------
-[DimensionProperties](Analytics.xml#L272)|\[String\]|A non-empty set of property names that define a combination of dimension values
-[AdditionalProperties](Analytics.xml#L275)|\[String\]|A possibly empty set of names of additional properties of the dimensions that occur in `DimensionProperties`
+[DimensionProperties](Analytics.xml#L276)|\[String\]|A non-empty list of property names that define a combination of dimension values
+[AdditionalProperties](Analytics.xml#L279)|\[String\]|A possibly empty list of names of additional properties of the dimensions that occur in `DimensionProperties`
 
 <a name="MultiLevelExpandSiblingOrder"></a>
-## [MultiLevelExpandSiblingOrder](Analytics.xml#L279) *([Experimental](Common.md#Experimental))*
+## [MultiLevelExpandSiblingOrder](Analytics.xml#L283) *([Experimental](Common.md#Experimental))*
 Sibling order in an [unnamed leveled hierarchy](#MultiLevelExpand)
 
 Property|Type|Description
 :-------|:---|:----------
-[Property](Analytics.xml#L282)|String|Property by which to sort
-[Descending](Analytics.xml#L285)|Boolean?|Sort direction, ascending if not specified otherwise
+[Property](Analytics.xml#L286)|String|Property by which to sort
+[Descending](Analytics.xml#L289)|Boolean?|Sort direction, ascending if not specified otherwise
 
 <a name="MultiLevelExpandEntry"></a>
-## [MultiLevelExpandEntry](Analytics.xml#L289) *([Experimental](Common.md#Experimental))*
+## [MultiLevelExpandEntry](Analytics.xml#L293) *([Experimental](Common.md#Experimental))*
 Expansion state of an entry in an [unnamed leveled hierarchy](#MultiLevelExpand)
 
 Property|Type|Description
 :-------|:---|:----------
-[Entry](Analytics.xml#L292)|\[String\]|An entry on a given [level](#MultiLevelExpandLevel) is identified by a collection of values for the `DimensionProperties` that constitute all levels up to and including the given one
-[Levels](Analytics.xml#L295)|Int64?|Number of levels to be expanded, null means all levels, 0 means collapsed
+[Entry](Analytics.xml#L296)|\[String\]|An entry on a given [level](#MultiLevelExpandLevel) is identified by a list of values for the `DimensionProperties` that constitute all levels up to and including the given one
+[Levels](Analytics.xml#L299)|Int64?|Number of levels to be expanded, null means all levels, 0 means collapsed
diff --git a/vocabularies/Analytics.xml b/vocabularies/Analytics.xml
@@ -217,7 +217,7 @@ $apply=filter(Industry in ('IT','AI'))
           <Annotation Term="Core.Description" String="Collection of aggregation levels forming a leveled hierarchy" />
           <Annotation Term="Core.LongDescription">
             <String>Each element in the collection defines the properties that constitute one level.
-            A property must not referenced by more than one level.
+            A property must not be referenced by more than one level.
             The first element in the collection defines the property names of the coarsest level,
             the following elements define the property names of consecutively finer-grained aggregation levels.
             The function result is the leveled hierarchy with these levels in preorder,
@@ -235,7 +235,11 @@ $apply=filter(Industry in ('IT','AI'))
           <Annotation Term="Core.Description" String="Sort specification to apply to all direct descendants of a given entry in the resulting leveled hierarchy" />
         </Parameter>
         <Parameter Name="ShowLevels" Type="Edm.Int64" Nullable="false">
-          <Annotation Term="Core.Description" String="Number of levels to be shown in the initial expansion (absent means all levels)" />
+          <Annotation Term="Core.Description" String="Number N of levels to be shown in the initial expansion" />
+          <Annotation Term="Core.LongDescription">
+            <String>The initial expansion shows the first N levels as defined in `Levels` (0 ≤ N ≤ length of `Levels`).
+            If this parameter is omitted, all levels are shown.</String>
+          </Annotation>
           <Annotation Term="Core.OptionalParameter">
             <Record/>
           </Annotation>
@@ -270,10 +274,10 @@ $apply=filter(Industry in ('IT','AI'))
           otherwise they have the same effect as `AdditionalProperties`.</String>
         </Annotation>
         <Property Name="DimensionProperties" Type="Collection(Edm.String)" Nullable="false">
-          <Annotation Term="Core.Description" String="A non-empty set of property names that define a combination of dimension values" />
+          <Annotation Term="Core.Description" String="A non-empty list of property names that define a combination of dimension values" />
         </Property>
         <Property Name="AdditionalProperties" Type="Collection(Edm.String)" Nullable="false">
-          <Annotation Term="Core.Description" String="A possibly empty set of names of additional properties of the dimensions that occur in `DimensionProperties`" />
+          <Annotation Term="Core.Description" String="A possibly empty list of names of additional properties of the dimensions that occur in `DimensionProperties`" />
         </Property>
       </ComplexType>
       <ComplexType Name="MultiLevelExpandSiblingOrder">
@@ -290,7 +294,7 @@ $apply=filter(Industry in ('IT','AI'))
         <Annotation Term="Common.Experimental" />
         <Annotation Term="Core.Description" String="Expansion state of an entry in an [unnamed leveled hierarchy](#MultiLevelExpand)" />
         <Property Name="Entry" Type="Collection(Edm.String)" Nullable="false">
-          <Annotation Term="Core.Description" String="An entry on a given [level](#MultiLevelExpandLevel) is identified by a collection of values for the `DimensionProperties` that constitute all levels up to and including the given one" />
+          <Annotation Term="Core.Description" String="An entry on a given [level](#MultiLevelExpandLevel) is identified by a list of values for the `DimensionProperties` that constitute all levels up to and including the given one" />
         </Property>
         <Property Name="Levels" Type="Edm.Int64" Nullable="true">
           <Annotation Term="Core.Description" String="Number of levels to be expanded, null means all levels, 0 means collapsed" />