@sap/cds-dk

{ "$Version": "4.0", "$Reference": { "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Core.V1.json": { "$Include": [ { "$Namespace": "Org.OData.Core.V1", "$Alias": "Core" } ] } }, "Org.OData.Aggregation.V1": { "$Alias": "Aggregation", "@Core.Description": "Terms to describe which data in a given entity model can be aggregated, and how.", "@Core.Links": [ { "rel": "alternate", "href": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.xml" }, { "rel": "latest-version", "href": "https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.json" }, { "rel": "describedby", "href": "https://github.com/oasis-tcs/odata-vocabularies/blob/master/vocabularies/Org.OData.Aggregation.V1.md" } ], "ApplySupported": { "$Kind": "Term", "$Type": "Aggregation.ApplySupportedType", "$Nullable": true, "$AppliesTo": [ "EntityType", "ComplexType", "EntityContainer" ], "@Core.Description": "This structured type or entity container supports the $apply system query option" }, "ApplySupportedType": { "$Kind": "ComplexType", "Transformations": { "$Collection": true, "@Core.Description": "Transformations that can be used in $apply" }, "CustomAggregationMethods": { "$Collection": true, "@Core.Description": "Qualified names of custom aggregation methods that can be used in aggregate(...with...)" }, "Rollup": { "$Type": "Aggregation.RollupType", "$DefaultValue": "MultipleHierarchies", "@Core.Description": "The service supports rollup hierarchies in a groupby transformation" }, "PropertyRestrictions": { "$Type": "Edm.Boolean", "$DefaultValue": false, "@Core.Description": "Only properties tagged as Groupable can be used in the groupby transformation, and only those tagged as Aggregatable can be used in the aggregate transformation" } }, "RollupType": { "$Kind": "EnumType", "@Core.Description": "The number of rollup operators allowed in a groupby transformation", "None": 0, "None@Core.Description": "No rollup support", "SingleHierarchy": 1, "SingleHierarchy@Core.Description": "Only one rollup operator per groupby", "MultipleHierarchies": 2, "MultipleHierarchies@Core.Description": "Full rollup support" }, "Groupable": { "$Kind": "Term", "$Type": "Core.Tag", "$Nullable": true, "$DefaultValue": true, "$AppliesTo": [ "Property", "NavigationProperty" ], "@Core.Description": "This property can be used in the groupby transformation" }, "Aggregatable": { "$Kind": "Term", "$Type": "Core.Tag", "$Nullable": true, "$DefaultValue": true, "$AppliesTo": [ "Property", "NavigationProperty" ], "@Core.Description": "This property can be used in the aggregate transformation" }, "CustomAggregate": { "$Kind": "Term", "$Nullable": true, "$AppliesTo": [ "EntityType", "ComplexType", "EntityContainer" ], "@Core.Description": "Dynamic property that can be used in the aggregate transformation", "@Core.LongDescription": "This term MUST be applied with a Qualifier, the Qualifier value is the name of the dynamic property. The value of the annotation MUST be the qualified name of a primitive type. The aggregated values will be of that type." }, "ContextDefiningProperties": { "$Kind": "Term", "$Collection": true, "$Type": "Edm.PropertyPath", "$AppliesTo": [ "Property", "Annotation" ], "@Core.Description": "The annotated property or custom aggregate is only well-defined in the context of these properties", "@Core.LongDescription": "The context-defining properties need either be part of the result entities, or be restricted to a single value by a pre-filter operation. Examples are postal codes within a country, or monetary amounts whose context is the unit of currency." }, "LeveledHierarchy": { "$Kind": "Term", "$Collection": true, "$Type": "Edm.PropertyPath", "$AppliesTo": [ "EntityType", "ComplexType" ], "@Core.Description": "Defines a leveled hierarchy by defining an ordered list of properties in the hierarchy" }, "RecursiveHierarchy": { "$Kind": "Term", "$Type": "Aggregation.RecursiveHierarchyType", "$Nullable": true, "$AppliesTo": [ "EntityType", "ComplexType" ], "@Core.Description": "Defines a recursive hierarchy." }, "RecursiveHierarchyType": { "$Kind": "ComplexType", "NodeProperty": { "$Type": "Edm.PropertyPath", "@Core.Description": "Property holding the hierarchy node value" }, "ParentNavigationProperty": { "$Type": "Edm.NavigationPropertyPath", "@Core.Description": "Property for navigating to the parent node" }, "DistanceFromRootProperty": { "$Type": "Edm.PropertyPath", "$Nullable": true, "@Core.Description": "Property holding the number of edges between the node and the root node" }, "IsLeafProperty": { "$Type": "Edm.PropertyPath", "$Nullable": true, "@Core.RequiresType": "Edm.Boolean", "@Core.Description": "Property indicating whether the node is a leaf of the hierarchy" } }, "isroot": [ { "$Kind": "Function", "$IsBound": true, "@Core.Description": "Returns true, if and only if the value of the node property of the specified hierarchy is the root of the hierarchy", "$Parameter": [ { "$Name": "Entity", "$Type": "Edm.EntityType" }, { "$Name": "Hierarchy" } ], "$ReturnType": { "$Type": "Edm.Boolean" } } ], "isdescendant": [ { "$Kind": "Function", "$IsBound": true, "@Core.Description": "Returns true, if and only if the value of the node property of the specified hierarchy is a descendant of the given parent node with a distance of less than or equal to the optionally specified maximum distance", "$Parameter": [ { "$Name": "Entity", "$Type": "Edm.EntityType" }, { "$Name": "Hierarchy" }, { "$Name": "Node", "$Type": "Edm.PrimitiveType" }, { "$Name": "MaxDistance", "$Type": "Edm.Int16", "$Nullable": true } ], "$ReturnType": { "$Type": "Edm.Boolean" } } ], "isancestor": [ { "$Kind": "Function", "$IsBound": true, "@Core.Description": "Returns true, if and only if the value of the node property of the specified hierarchy is an ancestor of the given child node with a distance of less than or equal to the optionally specified maximum distance", "$Parameter": [ { "$Name": "Entity", "$Type": "Edm.EntityType" }, { "$Name": "Hierarchy" }, { "$Name": "Node", "$Type": "Edm.PrimitiveType" }, { "$Name": "MaxDistance", "$Type": "Edm.Int16", "$Nullable": true } ], "$ReturnType": { "$Type": "Edm.Boolean" } } ], "issibling": [ { "$Kind": "Function", "$IsBound": true, "@Core.Description": "Returns true, if and only if the value of the node property of the specified hierarchy has the same parent node as the specified node", "$Parameter": [ { "$Name": "Entity", "$Type": "Edm.EntityType" }, { "$Name": "Hierarchy" }, { "$Name": "Node", "$Type": "Edm.PrimitiveType" } ], "$ReturnType": { "$Type": "Edm.Boolean" } } ], "isleaf": [ { "$Kind": "Function", "$IsBound": true, "@Core.Description": "Returns true, if and only if the value of the node property of the specified hierarchy has no descendants", "$Parameter": [ { "$Name": "Entity", "$Type": "Edm.EntityType" }, { "$Name": "Hierarchy" } ], "$ReturnType": { "$Type": "Edm.Boolean" } } ], "AvailableOnAggregates": { "$Kind": "Term", "$Type": "Aggregation.AvailableOnAggregatesType", "$Nullable": true, "$AppliesTo": [ "Action", "Function" ], "@Core.Description": "This action or function is available on aggregated entities if the RequiredProperties are still defined" }, "AvailableOnAggregatesType": { "$Kind": "ComplexType", "RequiredProperties": { "$Collection": true, "$Type": "Edm.PropertyPath", "@Core.Description": "Properties required to apply this action or function" } } } }