Action -> Function

SAP · Aug 8, 2023 · 66a9c92 · 66a9c92
1 parent 2013a73
commit 66a9c92
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 21 deletions.
diff --git a/examples/Analytics.AggregateEntity-sample.json b/examples/Analytics.AggregateEntity-sample.json
@@ -50,7 +50,7 @@
     ],
     "RetrieveAggregateSales": [
       {
-        "$Kind": "Action",
+        "$Kind": "Function",
         "@Core.Description": "Retrieves an aggregate entity of type `SalesModel.Sale`",
         "$Parameter": [
           { "$Name": "Aggregate", "@Core.Description": "String identifying the aggregate entity to be retrieved" }

diff --git a/examples/Analytics.AggregateEntity-sample.xml b/examples/Analytics.AggregateEntity-sample.xml
@@ -47,13 +47,13 @@
           <Annotation Term="Core.Description" String="Aggregate entity with updates applied" />
         </ReturnType>
       </Action>
-      <Action Name="RetrieveAggregateSales">
+      <Function Name="RetrieveAggregateSales">
         <Annotation Term="Core.Description" String="Retrieves an aggregate entity of type `SalesModel.Sale`" />
         <Parameter Name="Aggregate" Type="Edm.String" Nullable="false">
           <Annotation Term="Core.Description" String="String identifying the aggregate entity to be retrieved" />
         </Parameter>
         <ReturnType Type="SalesModel.Sale" Nullable="false" />
-      </Action>
+      </Function>
       <EntityContainer Name="container">
         <EntitySet Name="Sales" EntityType="SalesModel.Sale">
           <Annotation Term="Aggregation.CustomAggregate" Qualifier="Amount" String="Edm.Decimal" />

diff --git a/vocabularies/Analytics.json b/vocabularies/Analytics.json
@@ -163,7 +163,7 @@
       "@Common.Experimental": true,
       "@Common.IsInstanceAnnotation": true,
       "@Core.Description": "Function and action for retrieving and updating an aggregate entity",
-      "@Core.LongDescription": "Transient entities that result from the application of a transformation sequence represent an\n          aggregate of persistent entities (for example, aggregate sales per country and product, as in [OData-Aggr], first example in simple grouping section).\n          Such a transient entity may be annotated with this term to describe<br>\n          - a service-defined function that can be used to retrieve the transient entity in order to `$expand` additional properties<br>\n          - a service-defined action that can be used to update the transient entity. This effectively means updating the persistent entities whose aggregate\n          the transient entity represents, how this dis-aggregation happens is defined by the service.",
+      "@Core.LongDescription": "Transient entities that result from the application of a transformation sequence represent an\n          aggregate of persistent entities (for example, aggregate sales per country and product, as in [OData-Data-Agg-v4.0], first example in simple grouping section).\n          Such a transient entity may be annotated with this term to describe<br>\n          - a service-defined function import that can be used to retrieve the transient entity in order to `$expand` additional properties<br>\n          - a service-defined action import that can be used to update the transient entity. This effectively means updating the persistent entities whose aggregate\n          the transient entity represents, how this dis-aggregation happens is defined by the service.",
       "@Core.Example": {
         "@odata.type": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.xml#Core.ExternalExampleValue",
         "Description": "Based on the [example model](../examples/Analytics.AggregateEntity-sample.xml).\n              The format of the `Aggregate` parameter allows the server to re-create the transient entity\n              without storing an identifier, based solely on the parameter value.",
@@ -175,7 +175,7 @@
       "@Common.Experimental": true,
       "Aggregate": {
         "@Core.Description": "Value that the first parameter of the function or action invocation must have",
-        "@Core.LongDescription": "String value of the first parameter, which identifies the aggregate that the transient entity represents.\n            This value MUST be treated as opaque by the client."
+        "@Core.LongDescription": "This string value identifies the aggregate that the transient entity represents.\n            This value MUST be treated as opaque by the client."
       },
       "RetrieveFunctionImport": {
         "$Type": "Core.SimpleIdentifier",

diff --git a/vocabularies/Analytics.md b/vocabularies/Analytics.md
@@ -17,7 +17,7 @@ Term|Type|Description
 [AggregatedProperties](./Analytics.xml#L103:~:text=<Term%20Name="-,AggregatedProperties,-") *(Deprecated)*|\[[AggregatedPropertyType](#AggregatedPropertyType)\]|<a name="AggregatedProperties"></a>Deprecated in favor of [`AggregatedProperty`](#AggregatedProperty)
 [AggregatedProperty](./Analytics.xml#L121:~:text=<Term%20Name="-,AggregatedProperty,-")|[AggregatedPropertyType](#AggregatedPropertyType)|<a name="AggregatedProperty"></a>Dynamic property for aggregate expression with specified aggregation method defined on the annotated entity type.
 [AnalyticalContext](./Analytics.xml#L141:~:text=<Term%20Name="-,AnalyticalContext,-")|\[[AnalyticalContextType](#AnalyticalContextType)\]|<a name="AnalyticalContext"></a>Collection of properties that define an analytical context
-[AggregateEntity](./Analytics.xml#L170:~:text=<Term%20Name="-,AggregateEntity,-") *([Experimental](Common.md#Experimental))*|[AggregateEntityType](#AggregateEntityType)|<a name="AggregateEntity"></a>Function and action for retrieving and updating an aggregate entity ([Example](./Analytics.xml#L182))<br>Transient entities that result from the application of a transformation sequence represent an aggregate of persistent entities (for example, aggregate sales per country and product, as in [OData-Aggr], first example in simple grouping section). Such a transient entity may be annotated with this term to describe<br> - a service-defined function that can be used to retrieve the transient entity in order to `$expand` additional properties<br> - a service-defined action that can be used to update the transient entity. This effectively means updating the persistent entities whose aggregate the transient entity represents, how this dis-aggregation happens is defined by the service.
+[AggregateEntity](./Analytics.xml#L170:~:text=<Term%20Name="-,AggregateEntity,-") *([Experimental](Common.md#Experimental))*|[AggregateEntityType](#AggregateEntityType)|<a name="AggregateEntity"></a>Function and action for retrieving and updating an aggregate entity ([Example](./Analytics.xml#L182))<br>Transient entities that result from the application of a transformation sequence represent an aggregate of persistent entities (for example, aggregate sales per country and product, as in [OData-Data-Agg-v4.0], first example in simple grouping section). Such a transient entity may be annotated with this term to describe<br> - a service-defined function import that can be used to retrieve the transient entity in order to `$expand` additional properties<br> - a service-defined action import that can be used to update the transient entity. This effectively means updating the persistent entities whose aggregate the transient entity represents, how this dis-aggregation happens is defined by the service.
 
 <a name="AggregatedPropertyType"></a>
 ## [AggregatedPropertyType](./Analytics.xml#L124:~:text=<ComplexType%20Name="-,AggregatedPropertyType,-")
@@ -51,7 +51,7 @@ Property|Type|Description
 
 Property|Type|Description
 :-------|:---|:----------
-[Aggregate](./Analytics.xml#L195:~:text=<ComplexType%20Name="-,AggregateEntityType,-")|String|Value that the first parameter of the function or action invocation must have<br>String value of the first parameter, which identifies the aggregate that the transient entity represents. This value MUST be treated as opaque by the client.
+[Aggregate](./Analytics.xml#L195:~:text=<ComplexType%20Name="-,AggregateEntityType,-")|String|Value that the first parameter of the function or action invocation must have<br>This string value identifies the aggregate that the transient entity represents. This value MUST be treated as opaque by the client.
 [RetrieveFunctionImport](./Analytics.xml#L202:~:text=<ComplexType%20Name="-,AggregateEntityType,-")|[SimpleIdentifier?](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)|Name of a function import<br>The function has only one parameter.
 [UpdateActionImport](./Analytics.xml#L208:~:text=<ComplexType%20Name="-,AggregateEntityType,-")|[SimpleIdentifier?](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)|Name of an action import<br>Action parameters after the first define how the identified aggregate entity is updated, they are explained in the action definition in the service metadata.
 [ExpandableProperties](./Analytics.xml#L215:~:text=<ComplexType%20Name="-,AggregateEntityType,-")|\[NavigationPropertyPath\]|Declared navigation properties of the aggregate entity that can be expanded

diff --git a/vocabularies/Analytics.xml b/vocabularies/Analytics.xml
@@ -173,10 +173,10 @@
         <Annotation Term="Core.Description" String="Function and action for retrieving and updating an aggregate entity" />
         <Annotation Term="Core.LongDescription">
           <String>Transient entities that result from the application of a transformation sequence represent an
-          aggregate of persistent entities (for example, aggregate sales per country and product, as in [OData-Aggr], first example in simple grouping section).
+          aggregate of persistent entities (for example, aggregate sales per country and product, as in [OData-Data-Agg-v4.0], first example in simple grouping section).
           Such a transient entity may be annotated with this term to describe&lt;br&gt;
-          - a service-defined function that can be used to retrieve the transient entity in order to `$expand` additional properties&lt;br&gt;
-          - a service-defined action that can be used to update the transient entity. This effectively means updating the persistent entities whose aggregate
+          - a service-defined function import that can be used to retrieve the transient entity in order to `$expand` additional properties&lt;br&gt;
+          - a service-defined action import that can be used to update the transient entity. This effectively means updating the persistent entities whose aggregate
           the transient entity represents, how this dis-aggregation happens is defined by the service.</String>
         </Annotation>
         <Annotation Term="Core.Example">
@@ -195,7 +195,7 @@
         <Property Name="Aggregate" Type="Edm.String" Nullable="false">
           <Annotation Term="Core.Description" String="Value that the first parameter of the function or action invocation must have" />
           <Annotation Term="Core.LongDescription">
-            <String>String value of the first parameter, which identifies the aggregate that the transient entity represents.
+            <String>This string value identifies the aggregate that the transient entity represents.
             This value MUST be treated as opaque by the client.</String>
           </Annotation>
         </Property>

diff --git a/vocabularies/UI.md b/vocabularies/UI.md
@@ -971,8 +971,7 @@ Property|Type|Description
 [*Criticality*](./UI.xml#L1474:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityType?](#CriticalityType)|Criticality of the data field value
 [*CriticalityRepresentation*](./UI.xml#L1477:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon
 [*IconUrl*](./UI.xml#L1480:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|URL?|Optional icon
-[*Value*](./UI.xml#L1579:~:text=<ComplexType%20Name="-,DataField,-")|Untyped|The data field's value
-[Value](./UI.xml#L1609:~:text=<ComplexType%20Name="-,DataFieldWithAction,-")|PrimitiveType|
+[Value](./UI.xml#L1609:~:text=<ComplexType%20Name="-,DataFieldWithAction,-")|PrimitiveType|The data field's value
 [Action](./UI.xml#L1610:~:text=<ComplexType%20Name="-,DataFieldWithAction,-")|[QualifiedName](Common.md#QualifiedName)|Qualified name of an Action, Function, ActionImport or FunctionImport in scope
 
 **Applicable Annotation Terms:**
@@ -997,8 +996,7 @@ Property|Type|Description
 [*Criticality*](./UI.xml#L1474:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityType?](#CriticalityType)|Criticality of the data field value
 [*CriticalityRepresentation*](./UI.xml#L1477:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon
 [*IconUrl*](./UI.xml#L1480:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|URL?|Optional icon
-[*Value*](./UI.xml#L1579:~:text=<ComplexType%20Name="-,DataField,-")|Untyped|The data field's value
-[Value](./UI.xml#L1623:~:text=<ComplexType%20Name="-,DataFieldWithIntentBasedNavigation,-")|PrimitiveType|
+[Value](./UI.xml#L1623:~:text=<ComplexType%20Name="-,DataFieldWithIntentBasedNavigation,-")|PrimitiveType|The data field's value
 [SemanticObject](./UI.xml#L1624:~:text=<ComplexType%20Name="-,DataFieldWithIntentBasedNavigation,-")|String|Name of the Semantic Object
 [Action](./UI.xml#L1627:~:text=<ComplexType%20Name="-,DataFieldWithIntentBasedNavigation,-")|String?|Name of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger.
 [Mapping](./UI.xml#L1630:~:text=<ComplexType%20Name="-,DataFieldWithIntentBasedNavigation,-")|\[[SemanticObjectMappingType](Common.md#SemanticObjectMappingType)\]|Maps properties of the annotated entity type to properties of the Semantic Object
@@ -1022,8 +1020,7 @@ Property|Type|Description
 [*Criticality*](./UI.xml#L1474:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityType?](#CriticalityType)|Criticality of the data field value
 [*CriticalityRepresentation*](./UI.xml#L1477:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon
 [*IconUrl*](./UI.xml#L1480:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|URL?|Optional icon
-[*Value*](./UI.xml#L1579:~:text=<ComplexType%20Name="-,DataField,-")|Untyped|The data field's value
-[Value](./UI.xml#L1638:~:text=<ComplexType%20Name="-,DataFieldWithNavigationPath,-")|PrimitiveType|
+[Value](./UI.xml#L1638:~:text=<ComplexType%20Name="-,DataFieldWithNavigationPath,-")|PrimitiveType|The data field's value
 [Target](./UI.xml#L1639:~:text=<ComplexType%20Name="-,DataFieldWithNavigationPath,-")|NavigationPropertyPath|Contains either a navigation property or a term cast, where term is of type Edm.EntityType or a concrete entity type or a collection of these types
 
 **Applicable Annotation Terms:**
@@ -1045,8 +1042,7 @@ Property|Type|Description
 [*Criticality*](./UI.xml#L1474:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityType?](#CriticalityType)|Criticality of the data field value
 [*CriticalityRepresentation*](./UI.xml#L1477:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon
 [*IconUrl*](./UI.xml#L1480:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|URL?|Optional icon
-[*Value*](./UI.xml#L1579:~:text=<ComplexType%20Name="-,DataField,-")|Untyped|The data field's value
-[Value](./UI.xml#L1649:~:text=<ComplexType%20Name="-,DataFieldWithUrl,-")|PrimitiveType|
+[Value](./UI.xml#L1649:~:text=<ComplexType%20Name="-,DataFieldWithUrl,-")|PrimitiveType|The data field's value
 [Url](./UI.xml#L1650:~:text=<ComplexType%20Name="-,DataFieldWithUrl,-")|URL|Target of the hyperlink
 [UrlContentType](./UI.xml#L1654:~:text=<ComplexType%20Name="-,DataFieldWithUrl,-")|MediaType?|Media type of the hyperlink target, e.g. `video/mp4`
 
@@ -1067,8 +1063,7 @@ Property|Type|Description
 [*Criticality*](./UI.xml#L1474:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityType?](#CriticalityType)|Criticality of the data field value
 [*CriticalityRepresentation*](./UI.xml#L1477:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|[CriticalityRepresentationType?](#CriticalityRepresentationType)|Decides if criticality is visualized in addition by means of an icon
 [*IconUrl*](./UI.xml#L1480:~:text=<ComplexType%20Name="-,DataFieldAbstract,-")|URL?|Optional icon
-[*Value*](./UI.xml#L1579:~:text=<ComplexType%20Name="-,DataField,-")|Untyped|The data field's value
-[Value](./UI.xml#L1663:~:text=<ComplexType%20Name="-,DataFieldWithActionGroup,-")|PrimitiveType|
+[Value](./UI.xml#L1663:~:text=<ComplexType%20Name="-,DataFieldWithActionGroup,-")|PrimitiveType|The data field's value
 [Actions](./UI.xml#L1664:~:text=<ComplexType%20Name="-,DataFieldWithActionGroup,-")|\[[DataField](#DataField)\]|Collection of data fields that are either [DataFieldWithAction](#DataFieldWithAction), [DataFieldWithIntentBasedNavigation](#DataFieldWithIntentBasedNavigation), [DataFieldWithNavigationPath](#DataFieldWithNavigationPath), or [DataFieldWithUrl](#DataFieldWithUrl)
 
 **Applicable Annotation Terms:**