diff --git a/examples/Analytics.AggregateEntity-sample.json b/examples/Analytics.AggregateEntity-sample.json index 72a6d6fa..8f66b31f 100644 --- 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 index cc81bf71..2f4660a1 100644 --- a/examples/Analytics.AggregateEntity-sample.xml +++ b/examples/Analytics.AggregateEntity-sample.xml @@ -47,13 +47,13 @@ - + - + diff --git a/vocabularies/Analytics.json b/vocabularies/Analytics.json index c2db42f4..01390f1e 100644 --- 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
\n - a service-defined function that can be used to retrieve the transient entity in order to `$expand` additional properties
\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
\n - a service-defined function import that can be used to retrieve the transient entity in order to `$expand` additional properties
\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 index faa1e55e..fc8a4132 100644 --- a/vocabularies/Analytics.md +++ b/vocabularies/Analytics.md @@ -17,7 +17,7 @@ Term|Type|Description [AggregatedProperties](./Analytics.xml#L103:~:text=Deprecated in favor of [`AggregatedProperty`](#AggregatedProperty) [AggregatedProperty](./Analytics.xml#L121:~:text=Dynamic property for aggregate expression with specified aggregation method defined on the annotated entity type. [AnalyticalContext](./Analytics.xml#L141:~:text=Collection of properties that define an analytical context -[AggregateEntity](./Analytics.xml#L170:~:text=Function and action for retrieving and updating an aggregate entity ([Example](./Analytics.xml#L182))
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
- a service-defined function that can be used to retrieve the transient entity in order to `$expand` additional properties
- 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=Function and action for retrieving and updating an aggregate entity ([Example](./Analytics.xml#L182))
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
- a service-defined function import that can be used to retrieve the transient entity in order to `$expand` additional properties
- 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. ## [AggregatedPropertyType](./Analytics.xml#L124:~:text=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=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=The function has only one parameter. [UpdateActionImport](./Analytics.xml#L208:~:text=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= 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<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 + - 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. @@ -195,7 +195,7 @@ - String value of the first parameter, which identifies the aggregate that the transient entity represents. + This string value identifies the aggregate that the transient entity represents. This value MUST be treated as opaque by the client. diff --git a/vocabularies/UI.md b/vocabularies/UI.md index a455d053..f59ed245 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -971,8 +971,7 @@ Property|Type|Description [*Criticality*](./UI.xml#L1474:~:text=