From b1c51316b8d37e3111e7a132672c89dd40c17c4b Mon Sep 17 00:00:00 2001 From: D024504 Date: Wed, 10 Apr 2024 15:17:57 +0200 Subject: [PATCH 01/22] Prepare switch to pandoc --- .github/workflows/gh-pages.yml | 54 ++++++++++++++++++++ _layouts/default.html | 33 ------------ assets/template.html | 91 ++++++++++++++++++++++++++++++++++ package.json | 3 +- 4 files changed, 147 insertions(+), 34 deletions(-) create mode 100644 .github/workflows/gh-pages.yml delete mode 100644 _layouts/default.html create mode 100644 assets/template.html diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 00000000..1c98d6e5 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,54 @@ +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Build GitHub Pages using pandoc + +on: + # Runs on pushes targeting the default branch + push: + branches: ["main"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Setup pandoc + uses: nikeee/setup-pandoc@v1 + with: + pandoc-version: 3.1.12.2 + - name: Build with pandoc + run: | + npm ci + npm run pages "OData @ SAP" + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/_layouts/default.html b/_layouts/default.html deleted file mode 100644 index fd27e960..00000000 --- a/_layouts/default.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - -{% seo %} - - - -
-

{{ site.title | default: site.github.repository_name }}

- - {{ content }} - -
- - - diff --git a/assets/template.html b/assets/template.html new file mode 100644 index 00000000..cdc00f89 --- /dev/null +++ b/assets/template.html @@ -0,0 +1,91 @@ + + + + + + +$for(author-meta)$ + +$endfor$ +$if(date-meta)$ + +$endif$ +$if(keywords)$ + +$endif$ +$if(description-meta)$ + +$endif$ + $if(title-prefix)$$title-prefix$ – $endif$$pagetitle$ + +$for(css)$ + +$endfor$ +$for(header-includes)$ + $header-includes$ +$endfor$ +$if(math)$ +$if(mathjax)$ + +$endif$ + $math$ +$endif$ + + +$for(include-before)$ +$include-before$ +$endfor$ +
+$if(title)$ +
+

$title$

+$if(subtitle)$ +

$subtitle$

+$endif$ +$for(author)$ +

$author$

+$endfor$ +$if(date)$ +

$date$

+$endif$ +$if(abstract)$ +
+
$abstract-title$
+$abstract$ +
+$endif$ +
+$endif$ +$if(toc)$ + +$endif$ +$body$ + +
+$for(include-after)$ +$include-after$ +$endfor$ +$for(include-script)$ +$include-script$ +$endfor$ + + diff --git a/package.json b/package.json index 7447c977..3ac3c1f9 100644 --- a/package.json +++ b/package.json @@ -21,7 +21,8 @@ "prettier": "^3.2.5" }, "scripts": { - "build": "node lib/transform.js" + "build": "node lib/transform.js", + "pages": "node -r odata-vocabularies/pages -e \"\"" }, "author": "", "license": "" From 8d23c147f1e6ed34b7e9a4e81a60f01371f64135 Mon Sep 17 00:00:00 2001 From: D024504 Date: Wed, 10 Apr 2024 17:59:38 +0200 Subject: [PATCH 02/22] Rebuild Markdown --- package-lock.json | 2 +- vocabularies/Analytics.md | 2 +- vocabularies/Common.md | 6 +++--- vocabularies/UI.md | 38 +++++++++++++++++++------------------- 4 files changed, 24 insertions(+), 24 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3667b548..5acfa444 100644 --- a/package-lock.json +++ b/package-lock.json @@ -839,7 +839,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#d278339e63ace609db8dfab11c7dabf1213ae329", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#5c7162b6dbd79eefbf244447bfc605894a782c78", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "colors": "^1.4.0", diff --git a/vocabularies/Analytics.md b/vocabularies/Analytics.md index 20e2df5a..8feeec7d 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:~:text=Allowed terms:
- [AggregatedProperty](#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[DynamicProperty](./Analytics.xml#L150:~:text=Allowed terms:
  • [AggregatedProperty](#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
[Dimension](./Analytics.xml#L159:~:text=A short, human-readable text suitable for labels and captions in UIs [Heading](./Common.xml#L67:~:text=A short, human-readable text suitable for column headings in UIs [QuickInfo](./Common.xml#L72:~:text=A short, human-readable text suitable for tool tips in UIs -[Text](./Common.xml#L77:~:text=A descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.
Can be annotated with:
- [TextArrangement](UI.md#TextArrangement) +[Text](./Common.xml#L77:~:text=A descriptive text for values of the annotated property. Value MUST be a dynamic expression when used as metadata annotation.
Can be annotated with:
  • [TextArrangement](UI.md#TextArrangement)
[TextFor](./Common.xml#L87:~:text=The annotated property contains a descriptive text for values of the referenced property. [ExternalID](./Common.xml#L93:~:text=A human readable identifier for values of the annotated property or parameter. Value MUST be a dynamic expression when used as metadata annotation.
If the annotated property is (part of) a foreign key of a resource, the external id is a human readable (part of an) identifier of this resource. There is a one-to-one relationship between each possible value of the annotated property and the corresponding external id. The annotation of a parameter refers to a property of the operation binding parameter. [IsLanguageIdentifier](./Common.xml#L111:~:text=An identifier to distinguish multiple texts in different languages for the same entity @@ -62,7 +62,7 @@ Term|Type|Description [IsNaturalPerson](./Common.xml#L630:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person [ValueList](./Common.xml#L636:~:text=Specifies how to get a list of acceptable values for a property or parameter
The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. [ValueListRelevantQualifiers](./Common.xml#L710:~:text=List of qualifiers of relevant ValueList annotations
The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. -[ValueListWithFixedValues](./Common.xml#L715:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
Can be annotated with:
- [ValueListShowValuesImmediately](#ValueListShowValuesImmediately) +[ValueListWithFixedValues](./Common.xml#L715:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
Can be annotated with:
  • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
[ValueListShowValuesImmediately](./Common.xml#L724:~:text=A value list with a very small number of fixed values, can decide to show all values immediately [ValueListForValidation](./Common.xml#L729:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
An empty string identifies the ValueList or ValueListMapping without a qualifier. [ValueListReferences](./Common.xml#L734:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property @@ -428,7 +428,7 @@ Exactly one of `Property` and `DynamicProperty` must be present Property|Type|Description :-------|:---|:---------- [Property](./Common.xml#L1330:~:text=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:
- [AggregatedProperty](Analytics.md#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[DynamicProperty](./Common.xml#L1342:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
[Descending](./Common.xml#L1356:~:text= diff --git a/vocabularies/UI.md b/vocabularies/UI.md index ffe65aac..03e9bab6 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -29,7 +29,7 @@ Term|Type|Description [ConnectedFields](./UI.xml#L171:~:text=Group of semantically connected fields with a representation template and an optional label ([Example](./UI.xml#L173)) [GeoLocations](./UI.xml#L236:~:text=Collection of geographic locations [GeoLocation](./UI.xml#L240:~:text=Geographic location -[Contacts](./UI.xml#L260:~:text=Collection of contacts
Each collection item MUST reference an annotation of a Communication.Contact
Allowed terms:
- [Contact](Communication.md#Contact) +[Contacts](./UI.xml#L260:~:text=Collection of contacts
Each collection item MUST reference an annotation of a Communication.Contact
Allowed terms:
  • [Contact](Communication.md#Contact)
[MediaResource](./UI.xml#L271:~:text=Properties that describe a media resource
Either `Url` or `Stream` MUST be present, and never both. [DataPoint](./UI.xml#L351:~:text=Visualization of a single point of data, typically a number; may also be textual, e.g. a status value [KPI](./UI.xml#L659:~:text=A Key Performance Indicator (KPI) bundles a SelectionVariant and a DataPoint, and provides details for progressive disclosure @@ -50,8 +50,8 @@ Term|Type|Description [PartOfPreview](./UI.xml#L1360:~:text=This record and all included structural elements are part of the Thing preview
This term can be applied e.g. to UI.Facet and UI.DataField [Map](./UI.xml#L1364:~:text=Target MUST reference a UI.GeoLocation, Communication.Address or a collection of these [Gallery](./UI.xml#L1368:~:text=Target MUST reference a UI.MediaResource -[IsImageURL](./UI.xml#L1373:~:text=Properties and terms annotated with this term MUST contain a valid URL referencing an resource with a MIME type image
Can be annotated with:
- [IsNaturalPerson](Common.md#IsNaturalPerson) -[IsImage](./UI.xml#L1383:~:text=Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
Can be annotated with:
- [IsNaturalPerson](Common.md#IsNaturalPerson) +[IsImageURL](./UI.xml#L1373:~:text=Properties and terms annotated with this term MUST contain a valid URL referencing an resource with a MIME type image
Can be annotated with:
  • [IsNaturalPerson](Common.md#IsNaturalPerson)
+[IsImage](./UI.xml#L1383:~:text=Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
Can be annotated with:
  • [IsNaturalPerson](Common.md#IsNaturalPerson)
[MultiLineText](./UI.xml#L1394:~:text=Properties and parameters annotated with this annotation should be rendered as multi-line text (e.g. text area) [Placeholder](./UI.xml#L1399:~:text=A short, human-readable text that gives a hint or an example to help the user with data entry [TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text
This term annotates one of the following:
(1) a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text
(2) an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type. @@ -140,8 +140,8 @@ Property|Type|Description Property|Type|Description :-------|:---|:---------- -[Url](./UI.xml#L277:~:text=Can be annotated with:
- [LinkTarget](HTML5.md#LinkTarget) -[Stream](./UI.xml#L286:~:text=Can be annotated with:
- [LinkTarget](HTML5.md#LinkTarget) +[Url](./UI.xml#L277:~:text=Can be annotated with:
  • [LinkTarget](HTML5.md#LinkTarget)
+[Stream](./UI.xml#L286:~:text=Can be annotated with:
  • [LinkTarget](HTML5.md#LinkTarget)
[ContentType](./UI.xml#L295:~:text=Can be annotated with:
- [LinkTarget](HTML5.md#LinkTarget) +[Stream](./UI.xml#L322:~:text=Can be annotated with:
  • [LinkTarget](HTML5.md#LinkTarget)
[Width](./UI.xml#L331:~:text=Allowed terms:
- [CriticalityLabels](#CriticalityLabels) +[CriticalityLabels](./UI.xml#L411:~:text=Allowed terms:
  • [CriticalityLabels](#CriticalityLabels)
[CriticalityRepresentation](./UI.xml#L419:~:text=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:
- [AggregatedProperty](Analytics.md#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[DynamicMeasures](./UI.xml#L728:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
[MeasureAttributes](./UI.xml#L741:~:text=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:
- [AggregatedProperty](Analytics.md#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[DynamicMeasure](./UI.xml#L882:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
[Role](./UI.xml#L895:~:text=Allowed terms:
- [DataPoint](#DataPoint) +[DataPoint](./UI.xml#L896:~:text=Allowed terms:
  • [DataPoint](#DataPoint)
[UseSequentialColorLevels](./UI.xml#L904:~:text= @@ -607,7 +607,7 @@ Property|Type|Description :-------|:---|:---------- [*Label*](./UI.xml#L999:~:text=Allowed terms:
- [Address](Communication.md#Address)
- [Contact](Communication.md#Contact)
- [Badge](#Badge)
- [Chart](#Chart)
- [Contacts](#Contacts)
- [DataPoint](#DataPoint)
- [FieldGroup](#FieldGroup)
- [GeoLocation](#GeoLocation)
- [GeoLocations](#GeoLocations)
- [HeaderInfo](#HeaderInfo)
- [Identification](#Identification)
- [KPI](#KPI)
- [LineItem](#LineItem)
- [MediaResource](#MediaResource)
- [Note](#Note)
- [PresentationVariant](#PresentationVariant)
- [SelectionFields](#SelectionFields)
- [SelectionPresentationVariant](#SelectionPresentationVariant)
- [StatusInfo](#StatusInfo) +[Target](./UI.xml#L1015:~:text=Allowed terms:
  • [Address](Communication.md#Address)
  • [Contact](Communication.md#Contact)
  • [Badge](#Badge)
  • [Chart](#Chart)
  • [Contacts](#Contacts)
  • [DataPoint](#DataPoint)
  • [FieldGroup](#FieldGroup)
  • [GeoLocation](#GeoLocation)
  • [GeoLocations](#GeoLocations)
  • [HeaderInfo](#HeaderInfo)
  • [Identification](#Identification)
  • [KPI](#KPI)
  • [LineItem](#LineItem)
  • [MediaResource](#MediaResource)
  • [Note](#Note)
  • [PresentationVariant](#PresentationVariant)
  • [SelectionFields](#SelectionFields)
  • [SelectionPresentationVariant](#SelectionPresentationVariant)
  • [StatusInfo](#StatusInfo)
**Applicable Annotation Terms:** @@ -622,7 +622,7 @@ Property|Type|Description :-------|:---|:---------- [*Label*](./UI.xml#L999:~:text=Can be annotated with:
- [LinkTarget](HTML5.md#LinkTarget) +[Url](./UI.xml#L1044:~:text=Can be annotated with:
  • [LinkTarget](HTML5.md#LinkTarget)
[UrlContentType](./UI.xml#L1053:~:text=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:
- [AggregatedProperty](Analytics.md#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[DynamicTotal](./UI.xml#L1126:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
[IncludeGrandTotal](./UI.xml#L1139:~:text=Allowed terms:
- [Chart](#Chart)
- [DataPoint](#DataPoint)
- [LineItem](#LineItem) +[Visualizations](./UI.xml#L1148:~:text=Allowed terms:
  • [Chart](#Chart)
  • [DataPoint](#DataPoint)
  • [LineItem](#LineItem)
[RequestAtLeast](./UI.xml#L1165:~:text=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#L1188:~:text=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:
- [AggregatedProperty](Analytics.md#AggregatedProperty)
- [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate) +[DynamicPropertyName](./UI.xml#L1270:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
[Ranges](./UI.xml#L1284:~:text= @@ -767,8 +767,8 @@ Member|Value|Description Property|Type|Description :-------|:---|:---------- -[Title](./UI.xml#L1441:~:text=The title of a note is hidden with an annotation `@UI.Note/Title/@UI.Hidden`, not with an annotation on the property targeted by `@UI.Note/Title`.
Can be annotated with:
- [Hidden](#Hidden) -[Content](./UI.xml#L1453:~:text=The property targeted by `@UI.Note/Content` must be annotated with `Core.MediaType` and may be annotated with `Common.SAPObjectNodeTypeReference`. When it is tagged with `Core.IsLanguageDependent`, another property of the same entity type that is tagged with [`Common.IsLanguageIdentifier`](Common.md#IsLanguageIdentifier) determines the language of the note.
Can be annotated with:
- [MediaType](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#MediaType)
- [IsLanguageDependent](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent)
- [SAPObjectNodeTypeReference](Common.md#SAPObjectNodeTypeReference) +[Title](./UI.xml#L1441:~:text=The title of a note is hidden with an annotation `@UI.Note/Title/@UI.Hidden`, not with an annotation on the property targeted by `@UI.Note/Title`.
Can be annotated with:
  • [Hidden](#Hidden)
+[Content](./UI.xml#L1453:~:text=The property targeted by `@UI.Note/Content` must be annotated with `Core.MediaType` and may be annotated with `Common.SAPObjectNodeTypeReference`. When it is tagged with `Core.IsLanguageDependent`, another property of the same entity type that is tagged with [`Common.IsLanguageIdentifier`](Common.md#IsLanguageIdentifier) determines the language of the note.
Can be annotated with:
  • [MediaType](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#MediaType)
  • [IsLanguageDependent](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#IsLanguageDependent)
  • [SAPObjectNodeTypeReference](Common.md#SAPObjectNodeTypeReference)
[Type](./UI.xml#L1469:~:text=Allowed terms:
- [Address](Communication.md#Address)
- [Contact](Communication.md#Contact)
- [Chart](#Chart)
- [ConnectedFields](#ConnectedFields)
- [DataPoint](#DataPoint)
- [FieldGroup](#FieldGroup) +[Target](./UI.xml#L1596:~:text=Allowed terms:
  • [Address](Communication.md#Address)
  • [Contact](Communication.md#Contact)
  • [Chart](#Chart)
  • [ConnectedFields](#ConnectedFields)
  • [DataPoint](#DataPoint)
  • [FieldGroup](#FieldGroup)
**Applicable Annotation Terms:** @@ -1071,7 +1071,7 @@ Property|Type|Description [*CriticalityRepresentation*](./UI.xml#L1572:~:text=Can be annotated with:
- [LinkTarget](HTML5.md#LinkTarget) +[Url](./UI.xml#L1745:~:text=Can be annotated with:
  • [LinkTarget](HTML5.md#LinkTarget)
[UrlContentType](./UI.xml#L1754:~:text= Date: Thu, 11 Apr 2024 09:33:59 +0200 Subject: [PATCH 03/22] oasis-tcs/odata-vocabularies as dependency --- assets/template.html | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/assets/template.html b/assets/template.html index cdc00f89..2688ebe6 100644 --- a/assets/template.html +++ b/assets/template.html @@ -67,6 +67,7 @@

$toc-title$

$endif$ $body$ +

@@ -80,7 +81,6 @@

$toc-title$

- $for(include-after)$ $include-after$ $endfor$ diff --git a/package.json b/package.json index 3ac3c1f9..3b26cdc6 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ }, "scripts": { "build": "node lib/transform.js", - "pages": "node -r odata-vocabularies/pages -e \"\"" + "pages": "node -r odata-vocabularies/pages -e \"\" \"OData @ SAP\"" }, "author": "", "license": "" From d803f995067f23863f7eb387acc9b6fc00817b1e Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 09:41:25 +0200 Subject: [PATCH 04/22] Remove stale image link --- README.md | 2 -- package.json | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 6c714988..4d23c801 100644 --- a/README.md +++ b/README.md @@ -75,5 +75,3 @@ See [CONTRIBUTING.md](CONTRIBUTING.md). ## Licensing Please see our [LICENSE](./LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/odata-vocabularies). - -[![REUSE status](https://api.reuse.software/badge/github.com/SAP/odata-vocabularies)](https://api.reuse.software/info/github.com/SAP/odata-vocabularies) diff --git a/package.json b/package.json index 3b26cdc6..82fd9c8c 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,7 @@ }, "scripts": { "build": "node lib/transform.js", - "pages": "node -r odata-vocabularies/pages -e \"\" \"OData @ SAP\"" + "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"" }, "author": "", "license": "" From f4c518fdfc7db0b306f9f8ce03630d22db12133b Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 10:00:54 +0200 Subject: [PATCH 05/22] Bump dependency --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 5acfa444..27998bac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -839,7 +839,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#5c7162b6dbd79eefbf244447bfc605894a782c78", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#2ac78a7a1c1cbe917e21b968c05683d5cf2e93b0", "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "colors": "^1.4.0", From c3b7a8b032e58226c30a664073bbd3a038fff55c Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 10:47:15 +0200 Subject: [PATCH 06/22] include pandoc-filter in package-lock.json --- package-lock.json | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 27998bac..52f89459 100644 --- a/package-lock.json +++ b/package-lock.json @@ -580,6 +580,14 @@ "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", "dev": true }, + "node_modules/get-stdin": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-7.0.0.tgz", + "integrity": "sha512-zRKcywvrXlXsA0v0i9Io4KDRaAw7+a1ZpjRwl9Wox8PFlVCCHra7E9c4kqXCoCM9nR5tBkaTTZRBoCm60bFqTQ==", + "engines": { + "node": ">=8" + } + }, "node_modules/glob": { "version": "7.2.3", "resolved": "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz", @@ -840,10 +848,10 @@ "node_modules/odata-vocabularies": { "version": "0.5.2", "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#2ac78a7a1c1cbe917e21b968c05683d5cf2e93b0", - "license": "SEE LICENSE IN LICENSE.md", "dependencies": { "colors": "^1.4.0", - "odata-csdl": "^0.9.5" + "odata-csdl": "^0.9.5", + "pandoc-filter": "^2.2.0" }, "bin": { "odata-vocab2md": "lib/cli.js" @@ -905,6 +913,17 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/pandoc-filter": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/pandoc-filter/-/pandoc-filter-2.2.0.tgz", + "integrity": "sha512-mtjZfaiyONjN8HigU1XCoGDcadMmBwYtjAL2ol0vaY4qiOWmtCaVGJIa1gglKk7VSwYgAEfuE+5nvj/G3jLRBg==", + "dependencies": { + "get-stdin": "~7.0.0" + }, + "engines": { + "node": ">=7.6.0" + } + }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", From 587f2f942db9c22efd9d885aaf563822986c59a8 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 11:03:09 +0200 Subject: [PATCH 07/22] Reinsert broken link --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4d23c801..6c714988 100644 --- a/README.md +++ b/README.md @@ -75,3 +75,5 @@ See [CONTRIBUTING.md](CONTRIBUTING.md). ## Licensing Please see our [LICENSE](./LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the [REUSE tool](https://api.reuse.software/info/github.com/SAP/odata-vocabularies). + +[![REUSE status](https://api.reuse.software/badge/github.com/SAP/odata-vocabularies)](https://api.reuse.software/info/github.com/SAP/odata-vocabularies) From 8ee02b99fb25c2d0758211ec3f8895c2053b4ba0 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 11:30:41 +0200 Subject: [PATCH 08/22] Link to GitHub --- assets/template.html | 1 + 1 file changed, 1 insertion(+) diff --git a/assets/template.html b/assets/template.html index 2688ebe6..24b81e15 100644 --- a/assets/template.html +++ b/assets/template.html @@ -74,6 +74,7 @@

$toc-title$

© Copyright 2016–2024, SAP SE and odata-vocabularies Contributors. Legal Disclosure. Terms of Use. + View On GitHub.

This site is hosted by GitHub Pages. From 2450e31173acf4f27f6b3236baf2d8e5a3f97261 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 12:15:14 +0200 Subject: [PATCH 09/22] No params in workflows --- .github/workflows/gh-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 1c98d6e5..3346eda6 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -37,7 +37,7 @@ jobs: - name: Build with pandoc run: | npm ci - npm run pages "OData @ SAP" + npm run pages - name: Upload artifact uses: actions/upload-pages-artifact@v3 From d67815ed78dc393333d9ba2b74ee2bdbf20f5bd0 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 12:16:18 +0200 Subject: [PATCH 10/22] Bump dependency --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 52f89459..8395fea7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -847,7 +847,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#2ac78a7a1c1cbe917e21b968c05683d5cf2e93b0", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#d431c2f2abb2078f83b56f0ef1d42d3b75731306", "dependencies": { "colors": "^1.4.0", "odata-csdl": "^0.9.5", From 2132027f2897ee5f05cfc833fee65a9a9e7c3252 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 14:55:56 +0200 Subject: [PATCH 11/22] typographics --- _site/.gitignore | 2 + package-lock.json | 2 +- package.json | 3 +- vocabularies/Common.json | 2 +- vocabularies/Common.md | 304 ++++++++++++++++----------------- vocabularies/Common.xml | 21 +-- vocabularies/DirectEdit.json | 2 +- vocabularies/DirectEdit.md | 2 +- vocabularies/DirectEdit.xml | 27 ++- vocabularies/PersonalData.json | 2 +- vocabularies/PersonalData.md | 2 +- vocabularies/PersonalData.xml | 12 +- vocabularies/Session.json | 8 +- vocabularies/Session.md | 10 +- vocabularies/Session.xml | 49 ++---- 15 files changed, 208 insertions(+), 240 deletions(-) create mode 100644 _site/.gitignore diff --git a/_site/.gitignore b/_site/.gitignore new file mode 100644 index 00000000..d6b7ef32 --- /dev/null +++ b/_site/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore diff --git a/package-lock.json b/package-lock.json index 8395fea7..c2a9b4d2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -847,7 +847,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#d431c2f2abb2078f83b56f0ef1d42d3b75731306", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#1887311d443c40067a3285f3e00ef077ae21c117", "dependencies": { "colors": "^1.4.0", "odata-csdl": "^0.9.5", diff --git a/package.json b/package.json index 82fd9c8c..7262f85f 100644 --- a/package.json +++ b/package.json @@ -22,7 +22,8 @@ }, "scripts": { "build": "node lib/transform.js", - "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"" + "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"", + "serve-pages": "node -e \"require('odata-vocabularies/serve-pages')\"" }, "author": "", "license": "" diff --git a/vocabularies/Common.json b/vocabularies/Common.json index f0834322..bbf8c119 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -376,7 +376,7 @@ "$Collection": true, "$Type": "Edm.ComplexType", "@Core.Description": "Collection of end-user messages", - "@Core.LongDescription": "The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.\n\nThe minimum structure is\n\n- `code: Edm.String`\n\n- `message: Edm.String`\n\n- `target: Edm.String nullable`\n\n- `additionalTargets: Collection(Edm.String)`\n\n- `transition: Edm.Boolean`\n\n- `numericSeverity: Edm.Byte`\n\n- `longtextUrl: Edm.String nullable`\n " + "@Core.LongDescription": "The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.\n\nThe minimum structure is\n

  • `code: Edm.String`
    • \n
  • `message: Edm.String`
    • \n
  • `target: Edm.String nullable`
    • \n
  • `additionalTargets: Collection(Edm.String)`
    • \n
  • `transition: Edm.Boolean`
    • \n
  • `numericSeverity: Edm.Byte`
    • \n
  • `longtextUrl: Edm.String nullable`
\n " }, "additionalTargets": { "$Kind": "Term", diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 7501b9d5..8cdfa1dc 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -46,71 +46,71 @@ Term|Type|Description [Timestamp](./Common.xml#L457:~:text=... [TransactionId](./Common.xml#L462:~:text=... [ErrorResolution](./Common.xml#L467:~:text=Hints for resolving this error -[Messages](./Common.xml#L485:~:text=Collection of end-user messages
The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
The minimum structure is
- `code: Edm.String`
- `message: Edm.String`
- `target: Edm.String nullable`
- `additionalTargets: Collection(Edm.String)`
- `transition: Edm.Boolean`
- `numericSeverity: Edm.Byte`
- `longtextUrl: Edm.String nullable` -[additionalTargets](./Common.xml#L508:~:text=Additional targets for the message
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[longtextUrl](./Common.xml#L514:~:text=Location of the message long text
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[numericSeverity](./Common.xml#L520:~:text=Classifies an end-user message as info, success, warning, or error
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[MaximumNumericMessageSeverity](./Common.xml#L525:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) -[IsActionCritical](./Common.xml#L554:~:text=Criticality of the function or action to enforce a warning or similar before it's executed -[Attributes](./Common.xml#L558:~:text=Attributes related to this property, which may occur in denormalized entity types -[RelatedRecursiveHierarchy](./Common.xml#L562:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. -[Interval](./Common.xml#L566:~:text=An interval with lower and upper boundaries described by two properties -[ResultContext](./Common.xml#L589:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. -[SAPObjectNodeType](./Common.xml#L597:~:text=The SAP Object Node Type represented by the annotated entity type
SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. -[Composition](./Common.xml#L613:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. -[SAPObjectNodeTypeReference](./Common.xml#L622:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. -[IsNaturalPerson](./Common.xml#L630:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person -[ValueList](./Common.xml#L636:~:text=Specifies how to get a list of acceptable values for a property or parameter
The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. -[ValueListRelevantQualifiers](./Common.xml#L710:~:text=List of qualifiers of relevant ValueList annotations
The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. -[ValueListWithFixedValues](./Common.xml#L715:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
Can be annotated with:
  • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
-[ValueListShowValuesImmediately](./Common.xml#L724:~:text=A value list with a very small number of fixed values, can decide to show all values immediately -[ValueListForValidation](./Common.xml#L729:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
An empty string identifies the ValueList or ValueListMapping without a qualifier. -[ValueListReferences](./Common.xml#L734:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property -[ValueListMapping](./Common.xml#L739:~:text=Specifies the mapping between data service properties and value list properties
The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. -[IsCalendarYear](./Common.xml#L851:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) -[IsCalendarHalfyear](./Common.xml#L860:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] -[IsCalendarQuarter](./Common.xml#L869:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsCalendarMonth](./Common.xml#L878:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] -[IsCalendarWeek](./Common.xml#L887:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsDayOfCalendarMonth](./Common.xml#L896:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. -[IsDayOfCalendarYear](./Common.xml#L904:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. -[IsCalendarYearHalfyear](./Common.xml#L912:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] -[IsCalendarYearQuarter](./Common.xml#L922:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] -[IsCalendarYearMonth](./Common.xml#L932:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) -[IsCalendarYearWeek](./Common.xml#L943:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsCalendarDate](./Common.xml#L953:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. -[IsFiscalYear](./Common.xml#L970:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} -[IsFiscalPeriod](./Common.xml#L979:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} -[IsFiscalYearPeriod](./Common.xml#L988:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) -[IsFiscalQuarter](./Common.xml#L998:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsFiscalYearQuarter](./Common.xml#L1006:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] -[IsFiscalWeek](./Common.xml#L1015:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsFiscalYearWeek](./Common.xml#L1023:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsDayOfFiscalYear](./Common.xml#L1032:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. -[IsFiscalYearVariant](./Common.xml#L1039:~:text=Property encodes a fiscal year variant -[MutuallyExclusiveTerm](./Common.xml#L1047:~:text=Only one term of the group identified with the Qualifier attribute can be applied -[DraftRoot](./Common.xml#L1053:~:text=Root entities of business documents that support the draft pattern -[DraftNode](./Common.xml#L1094:~:text=Entities in this set are parts of business documents that support the draft pattern -[DraftActivationVia](./Common.xml#L1116:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets -[EditableFieldFor](./Common.xml#L1120:~:text=The annotated property is an editable field for the referenced key property -[SemanticKey](./Common.xml#L1150:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity -[SideEffects](./Common.xml#L1154:~:text=Describes side-effects of modification operations -[DefaultValuesFunction](./Common.xml#L1237:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
The default values function must have a bound overload whose binding parameter type matches the annotation target
- for an entity set: collection of entity type of entity set
- for a navigation property: identical to the type of the navigation property (single- or collection-valued)
- for a bound action/function: identical to the binding parameter type of the annotated action/function
In addition the overload can have non-binding parameters for values that the user has already entered:
- for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
- for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
- the properties of the entity to create, or
- the parameters of the action or function to call -[DerivedDefaultValue](./Common.xml#L1266:~:text=Function import to derive a default value for the property from a given context.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[FilterDefaultValue](./Common.xml#L1287:~:text=A default value for the property to be used in filter expressions. -[FilterDefaultValueHigh](./Common.xml#L1291:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. -[DerivedFilterDefaultValue](./Common.xml#L1296:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[SortOrder](./Common.xml#L1320:~:text=List of sort criteria
The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. -[RecursiveHierarchy](./Common.xml#L1376:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead -[CreatedAt](./Common.xml#L1424:~:text=Creation timestamp -[CreatedBy](./Common.xml#L1428:~:text=First editor -[ChangedAt](./Common.xml#L1432:~:text=Last modification timestamp -[ChangedBy](./Common.xml#L1436:~:text=Last editor -[OriginalProtocolVersion](./Common.xml#L1448:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` -[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1453:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ -[mediaUploadLink](./Common.xml#L1459:~:text=URL for uploading new media content to a Document Management Service
In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. -[PrimitivePropertyPath](./Common.xml#L1474:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property -[WebSocketBaseURL](./Common.xml#L1479:~:text=Base URL for WebSocket connections +[Messages](./Common.xml#L485:~:text=Collection of end-user messages
The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
The minimum structure is
  • `code: Edm.String`
  • `message: Edm.String`
  • `target: Edm.String nullable`
  • `additionalTargets: Collection(Edm.String)`
  • `transition: Edm.Boolean`
  • `numericSeverity: Edm.Byte`
  • `longtextUrl: Edm.String nullable`
+[additionalTargets](./Common.xml#L501:~:text=Additional targets for the message
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[longtextUrl](./Common.xml#L507:~:text=Location of the message long text
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[numericSeverity](./Common.xml#L513:~:text=Classifies an end-user message as info, success, warning, or error
This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[MaximumNumericMessageSeverity](./Common.xml#L518:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) +[IsActionCritical](./Common.xml#L547:~:text=Criticality of the function or action to enforce a warning or similar before it's executed +[Attributes](./Common.xml#L551:~:text=Attributes related to this property, which may occur in denormalized entity types +[RelatedRecursiveHierarchy](./Common.xml#L555:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. +[Interval](./Common.xml#L559:~:text=An interval with lower and upper boundaries described by two properties +[ResultContext](./Common.xml#L582:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. +[SAPObjectNodeType](./Common.xml#L590:~:text=The SAP Object Node Type represented by the annotated entity type
SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. +[Composition](./Common.xml#L606:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. +[SAPObjectNodeTypeReference](./Common.xml#L615:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. +[IsNaturalPerson](./Common.xml#L623:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person +[ValueList](./Common.xml#L629:~:text=Specifies how to get a list of acceptable values for a property or parameter
The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. +[ValueListRelevantQualifiers](./Common.xml#L703:~:text=List of qualifiers of relevant ValueList annotations
The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. +[ValueListWithFixedValues](./Common.xml#L708:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
Can be annotated with:
  • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
+[ValueListShowValuesImmediately](./Common.xml#L717:~:text=A value list with a very small number of fixed values, can decide to show all values immediately +[ValueListForValidation](./Common.xml#L722:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
An empty string identifies the ValueList or ValueListMapping without a qualifier. +[ValueListReferences](./Common.xml#L727:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property +[ValueListMapping](./Common.xml#L732:~:text=Specifies the mapping between data service properties and value list properties
The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. +[IsCalendarYear](./Common.xml#L844:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) +[IsCalendarHalfyear](./Common.xml#L853:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] +[IsCalendarQuarter](./Common.xml#L862:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsCalendarMonth](./Common.xml#L871:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] +[IsCalendarWeek](./Common.xml#L880:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsDayOfCalendarMonth](./Common.xml#L889:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. +[IsDayOfCalendarYear](./Common.xml#L897:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. +[IsCalendarYearHalfyear](./Common.xml#L905:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] +[IsCalendarYearQuarter](./Common.xml#L915:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] +[IsCalendarYearMonth](./Common.xml#L925:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) +[IsCalendarYearWeek](./Common.xml#L936:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsCalendarDate](./Common.xml#L946:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. +[IsFiscalYear](./Common.xml#L963:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} +[IsFiscalPeriod](./Common.xml#L972:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} +[IsFiscalYearPeriod](./Common.xml#L981:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) +[IsFiscalQuarter](./Common.xml#L991:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsFiscalYearQuarter](./Common.xml#L999:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] +[IsFiscalWeek](./Common.xml#L1008:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsFiscalYearWeek](./Common.xml#L1016:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsDayOfFiscalYear](./Common.xml#L1025:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. +[IsFiscalYearVariant](./Common.xml#L1032:~:text=Property encodes a fiscal year variant +[MutuallyExclusiveTerm](./Common.xml#L1040:~:text=Only one term of the group identified with the Qualifier attribute can be applied +[DraftRoot](./Common.xml#L1046:~:text=Root entities of business documents that support the draft pattern +[DraftNode](./Common.xml#L1087:~:text=Entities in this set are parts of business documents that support the draft pattern +[DraftActivationVia](./Common.xml#L1109:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets +[EditableFieldFor](./Common.xml#L1113:~:text=The annotated property is an editable field for the referenced key property +[SemanticKey](./Common.xml#L1143:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity +[SideEffects](./Common.xml#L1147:~:text=Describes side-effects of modification operations +[DefaultValuesFunction](./Common.xml#L1230:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
The default values function must have a bound overload whose binding parameter type matches the annotation target
- for an entity set: collection of entity type of entity set
- for a navigation property: identical to the type of the navigation property (single- or collection-valued)
- for a bound action/function: identical to the binding parameter type of the annotated action/function
In addition the overload can have non-binding parameters for values that the user has already entered:
- for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
- for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
- the properties of the entity to create, or
- the parameters of the action or function to call +[DerivedDefaultValue](./Common.xml#L1259:~:text=Function import to derive a default value for the property from a given context.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[FilterDefaultValue](./Common.xml#L1280:~:text=A default value for the property to be used in filter expressions. +[FilterDefaultValueHigh](./Common.xml#L1284:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. +[DerivedFilterDefaultValue](./Common.xml#L1289:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
Function import has two parameters of complex types:
- `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
- `properties`, a structure resembling the type of the entity set of the annotated property
The return type must be of the same type as the annotated property.
Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[SortOrder](./Common.xml#L1313:~:text=List of sort criteria
The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. +[RecursiveHierarchy](./Common.xml#L1369:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead +[CreatedAt](./Common.xml#L1417:~:text=Creation timestamp +[CreatedBy](./Common.xml#L1421:~:text=First editor +[ChangedAt](./Common.xml#L1425:~:text=Last modification timestamp +[ChangedBy](./Common.xml#L1429:~:text=Last editor +[OriginalProtocolVersion](./Common.xml#L1441:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` +[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1446:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ +[mediaUploadLink](./Common.xml#L1452:~:text=URL for uploading new media content to a Document Management Service
In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. +[PrimitivePropertyPath](./Common.xml#L1467:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property +[WebSocketBaseURL](./Common.xml#L1472:~:text=Base URL for WebSocket connections ## [TextFormatType](./Common.xml#L120:~:text= -## [NumericMessageSeverityType](./Common.xml#L530:~:text= -## [IntervalType](./Common.xml#L569:~:text= -## [SAPObjectNodeTypeType](./Common.xml#L605:~:text= -## [ValueListType](./Common.xml#L640:~:text=The value of the target property is used as the search expression instead of in $filter -[FetchValues](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath -[SelectionVariantQualifier](./Common.xml#L685:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L689:~:text=The value of the target property is used as the search expression instead of in $filter +[FetchValues](./Common.xml#L671:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath +[SelectionVariantQualifier](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L682:~:text= -## [FetchValuesType](./Common.xml#L694:~:text= -## [ValueListMappingType](./Common.xml#L743:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation -[SelectionVariantQualifier](./Common.xml#L766:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L770:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation +[SelectionVariantQualifier](./Common.xml#L759:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L763:~:text= -## [*ValueListParameter*](./Common.xml#L775:~:text= -## [ValueListParameterIn](./Common.xml#L780:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators -[InitialValueIsSignificant](./Common.xml#L785:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators +[InitialValueIsSignificant](./Common.xml#L778:~:text= -## [ValueListParameterConstant](./Common.xml#L789:~:text= -## [ValueListParameterConstants](./Common.xml#L798:~:text=An empty list means a vacuous filter condition +[*ValueListProperty*](./Common.xml#L769:~:text=An empty list means a vacuous filter condition -## [ValueListParameterInOut](./Common.xml#L807:~:text= -## [ValueListParameterOut](./Common.xml#L820:~:text= -## [ValueListParameterDisplayOnly](./Common.xml#L830:~:text= -## [ValueListParameterFilterOnly](./Common.xml#L838:~:text= -## [DraftRootType](./Common.xml#L1058:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. -[AdditionalNewActions](./Common.xml#L1073:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. -[ShareAction](./Common.xml#L1078:~:text=The action is bound to the draft document root node and has the following signature:
- `Users`: collection of structure with properties
  - `UserID` of type `String` and
  - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
It restricts access to the listed users in their specified roles. +[*PreparationAction*](./Common.xml#L1093:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. +[AdditionalNewActions](./Common.xml#L1066:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. +[ShareAction](./Common.xml#L1071:~:text=The action is bound to the draft document root node and has the following signature:
- `Users`: collection of structure with properties
  - `UserID` of type `String` and
  - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
It restricts access to the listed users in their specified roles. -## [DraftNodeType](./Common.xml#L1099:~:text= -## [SimpleIdentifier](./Common.xml#L1124:~:text= -## [QualifiedName](./Common.xml#L1136:~:text= -## [ActionOverload](./Common.xml#L1141:~:text= -## [SideEffectsType](./Common.xml#L1157:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path -[TargetEntities](./Common.xml#L1179:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. -[Discretionary](./Common.xml#L1197:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. +[SourceProperties](./Common.xml#L1162:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path +[TargetEntities](./Common.xml#L1172:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. +[Discretionary](./Common.xml#L1190:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. -## [EffectType](./Common.xml#L1203:~:text= -## [SortOrderType](./Common.xml#L1328:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
-[Descending](./Common.xml#L1356:~:text=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:
  • [AggregatedProperty](Analytics.md#AggregatedProperty)
  • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
+[Descending](./Common.xml#L1349:~:text= -## [RecursiveHierarchyType](./Common.xml#L1389:~:text= -## [UserID](./Common.xml#L1440:~:text=The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure. The minimum structure is - -- `code: Edm.String` - -- `message: Edm.String` - -- `target: Edm.String nullable` - -- `additionalTargets: Collection(Edm.String)` - -- `transition: Edm.Boolean` - -- `numericSeverity: Edm.Byte` - -- `longtextUrl: Edm.String nullable` +<ul><li>`code: Edm.String`</li> +<li>`message: Edm.String`</li> +<li>`target: Edm.String nullable`</li> +<li>`additionalTargets: Collection(Edm.String)`</li> +<li>`transition: Edm.Boolean`</li> +<li>`numericSeverity: Edm.Byte`</li> +<li>`longtextUrl: Edm.String nullable`</li></ul> diff --git a/vocabularies/DirectEdit.json b/vocabularies/DirectEdit.json index b7792c35..35651d52 100644 --- a/vocabularies/DirectEdit.json +++ b/vocabularies/DirectEdit.json @@ -38,7 +38,7 @@ }, "CalculationFunction": { "$Type": "Common.QualifiedName", - "@Core.Description": "The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:\n\n- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\n or cast-compatible: the qualifier of the `SideEffects` annotation\n\n- `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property\n\n- `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it\n\nThe **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it,\nit can be the same type as for `Data`.\n\nStructure-compatible means:\n\n- each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, \n\n- each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property\n \n- it may contain properties without a corresponding property in the entity type\n\n- it may omit properties of the entity type" + "@Core.Description": "The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:\n
  • `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\n or cast-compatible: the qualifier of the `SideEffects` annotation
    • \n
  • `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
    • \n
  • `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it
\n\nThe **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it,\nit can be the same type as for `Data`.\n\nStructure-compatible means:\n
  • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable
    • \n
  • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • \n
  • it may contain properties without a corresponding property in the entity type
    • \n
  • it may omit properties of the entity type
" } } } diff --git a/vocabularies/DirectEdit.md b/vocabularies/DirectEdit.md index 54d99cd3..97326780 100644 --- a/vocabularies/DirectEdit.md +++ b/vocabularies/DirectEdit.md @@ -19,4 +19,4 @@ After a change to a property whose path is contained in `Triggers`, the client s Property|Type|Description :-------|:---|:---------- [Triggers](./DirectEdit.xml#L48:~:text=- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) or cast-compatible: the qualifier of the `SideEffects` annotation
- `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
- `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it
The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
Structure-compatible means:
- each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
- each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - it may contain properties without a corresponding property in the entity type
- it may omit properties of the entity type +[CalculationFunction](./DirectEdit.xml#L52:~:text=
  • `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) or cast-compatible: the qualifier of the `SideEffects` annotation
  • `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
  • `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it

    • The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means:
    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • it may contain properties without a corresponding property in the entity type
    • it may omit properties of the entity type
    diff --git a/vocabularies/DirectEdit.xml b/vocabularies/DirectEdit.xml index 36a995d0..7cd3a3fd 100644 --- a/vocabularies/DirectEdit.xml +++ b/vocabularies/DirectEdit.xml @@ -50,27 +50,22 @@ - + The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters: +<ul><li>`Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) + or cast-compatible: the qualifier of the `SideEffects` annotation</li> +<li>`Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property</li> +<li>`Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it</li></ul> The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`. Structure-compatible means: - -- each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, - -- each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - -- it may contain properties without a corresponding property in the entity type - -- it may omit properties of the entity type" /> +<ul><li>each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable</li> +<li>each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property</li> +<li>it may contain properties without a corresponding property in the entity type</li> +<li>it may omit properties of the entity type</li></ul> + diff --git a/vocabularies/PersonalData.json b/vocabularies/PersonalData.json index e02d7a05..d2848d6b 100644 --- a/vocabularies/PersonalData.json +++ b/vocabularies/PersonalData.json @@ -136,7 +136,7 @@ "$DefaultValue": true, "$AppliesTo": ["Property"], "@Core.Description": "Property contains potentially sensitive personal data", - "@Core.LongDescription": "Sensitive data is a colloquial term usually including the following data:\n\n- Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation\n\n- Personal data subject to professional secrecy\n\n- Personal data relating to criminal or administrative offences\n\n- Personal data concerning bank or credit card accounts\n\nSee also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en)" + "@Core.LongDescription": "Sensitive data is a colloquial term usually including the following data:\n
    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
      • \n
    • Personal data subject to professional secrecy
      • \n
    • Personal data relating to criminal or administrative offences
      • \n
    • Personal data concerning bank or credit card accounts
    \n\nSee also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en)" } } } diff --git a/vocabularies/PersonalData.md b/vocabularies/PersonalData.md index b70c9fd6..464c08fb 100644 --- a/vocabularies/PersonalData.md +++ b/vocabularies/PersonalData.md @@ -32,7 +32,7 @@ Term|Type|Description [DataSubjectRoleDescription](./PersonalData.xml#L68:~:text=Language-dependent description of the role of the data subjects in this set (e.g. employee, customer)
    Values are application-specific. Can be a static value or a `Path` expression If the role varies per entity [FieldSemantics](./PersonalData.xml#L111:~:text=Primary meaning of the personal data contained in the annotated property
    Changes to values of annotated properties are tracked in the audit log. Use this annotation also on fields that are already marked as contact or address data. [IsPotentiallyPersonal](./PersonalData.xml#L195:~:text=Property contains potentially personal data
    Personal data is information relating to an identified or identifiable natural person (data subject).
    Note: properties annotated with [`FieldSemantics`](#FieldSemantics) need not be additionally annotated with this term.
    See also: [What is personal data?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/what-personal-data_en) -[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data:
    - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    - Personal data subject to professional secrecy
    - Personal data relating to criminal or administrative offences
    - Personal data concerning bank or credit card accounts
    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) +[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data:
    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    • Personal data subject to professional secrecy
    • Personal data relating to criminal or administrative offences
    • Personal data concerning bank or credit card accounts

    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) ## [EntitySemanticsType](./PersonalData.xml#L76:~:text= Sensitive data is a colloquial term usually including the following data: - -- Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation - -- Personal data subject to professional secrecy - -- Personal data relating to criminal or administrative offences - -- Personal data concerning bank or credit card accounts +<ul><li>Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation</li> +<li>Personal data subject to professional secrecy</li> +<li>Personal data relating to criminal or administrative offences</li> +<li>Personal data concerning bank or credit card accounts</li></ul> See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) diff --git a/vocabularies/Session.json b/vocabularies/Session.json index 61d5f12c..9be08ed8 100644 --- a/vocabularies/Session.json +++ b/vocabularies/Session.json @@ -38,7 +38,7 @@ "NewAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that initiates a sticky session for creating new entities in the targeted entity set or collection", - "@Core.LongDescription": "Signature:\n\n- Binding parameter is collection of type of annotated entity set\n\n- No non-binding parameters\n\n- No return type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n\n- On success this action initiates a sticky session.\n\n- On failure no sticky session is initiated." + "@Core.LongDescription": "Signature:\n
    • Binding parameter is collection of type of annotated entity set
      • \n
    • No non-binding parameters
      • \n
    • No return type
    \nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n
    • On success this action initiates a sticky session.
      • \n
    • On failure no sticky session is initiated.
    " }, "AdditionalNewActions": { "$Collection": true, @@ -50,17 +50,17 @@ "EditAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that initiates a sticky session for editing the targeted entity", - "@Core.LongDescription": "Signature:\n\n- Binding parameter is type of annotated entity set\n\n- No non-binding parameters\n\n- Return type is same as binding parameter type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n\n- On success this action returns the targeted entity and initiates a sticky session.\n\n- On failure no sticky session is initiated." + "@Core.LongDescription": "Signature:\n
    • Binding parameter is type of annotated entity set
      • \n
    • No non-binding parameters
      • \n
    • Return type is same as binding parameter type
    \nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n
    • On success this action returns the targeted entity and initiates a sticky session.
      • \n
    • On failure no sticky session is initiated.
    " }, "SaveAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that saves a new or edited entity", - "@Core.LongDescription": "Signature:\n\n- Binding parameter is type of annotated entity set\n\n- No non-binding parameters\n\n- Return type is same as binding parameter type \n\nOn success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. \n\nOn failure the sticky session is kept alive." + "@Core.LongDescription": "Signature:\n
    • Binding parameter is type of annotated entity set
      • \n
    • No non-binding parameters
      • \n
    • Return type is same as binding parameter type
    \nOn success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. \n\nOn failure the sticky session is kept alive." }, "DiscardAction": { "$Type": "Core.SimpleIdentifier", "@Core.Description": "Action import for an unbound action that discards all changes and terminates the sticky session", - "@Core.LongDescription": "Signature:\n\n- No parameters\n\n- No return type \n\nIf called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. \n\nIf called outside of a sticky session the action fails and does not initiate a session." + "@Core.LongDescription": "Signature:\n
    • No parameters
      • \n
    • No return type
    \nIf called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. \n\nIf called outside of a sticky session the action fails and does not initiate a session." } } } diff --git a/vocabularies/Session.md b/vocabularies/Session.md index f265822e..cdf2525d 100644 --- a/vocabularies/Session.md +++ b/vocabularies/Session.md @@ -51,8 +51,8 @@ Actions for managing data modification within a sticky session Property|Type|Description :-------|:---|:---------- -[NewAction](./Session.xml#L88:~:text=Signature:
    - Binding parameter is collection of type of annotated entity set
    - No non-binding parameters
    - No return type
    If called within a sticky session the sticky session continues.
    Otherwise:
    - On success this action initiates a sticky session.
    - On failure no sticky session is initiated. -[AdditionalNewActions](./Session.xml#L108:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters -[EditAction](./Session.xml#L113:~:text=Signature:
    - Binding parameter is type of annotated entity set
    - No non-binding parameters
    - Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise:
    - On success this action returns the targeted entity and initiates a sticky session.
    - On failure no sticky session is initiated. -[SaveAction](./Session.xml#L133:~:text=Signature:
    - Binding parameter is type of annotated entity set
    - No non-binding parameters
    - Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. -[DiscardAction](./Session.xml#L149:~:text=Signature:
    - No parameters
    - No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. +[NewAction](./Session.xml#L88:~:text=Signature:
    • Binding parameter is collection of type of annotated entity set
    • No non-binding parameters
    • No return type
    If called within a sticky session the sticky session continues.
    Otherwise:
    • On success this action initiates a sticky session.
    • On failure no sticky session is initiated.
    +[AdditionalNewActions](./Session.xml#L102:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters +[EditAction](./Session.xml#L107:~:text=Signature:
    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise:
    • On success this action returns the targeted entity and initiates a sticky session.
    • On failure no sticky session is initiated.
    +[SaveAction](./Session.xml#L121:~:text=Signature:
    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. +[DiscardAction](./Session.xml#L133:~:text=Signature:
    • No parameters
    • No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. diff --git a/vocabularies/Session.xml b/vocabularies/Session.xml index fff02d02..eae4c293 100644 --- a/vocabularies/Session.xml +++ b/vocabularies/Session.xml @@ -89,20 +89,14 @@ combined as one UI app. Signature: - -- Binding parameter is collection of type of annotated entity set - -- No non-binding parameters - -- No return type - +<ul><li>Binding parameter is collection of type of annotated entity set</li> +<li>No non-binding parameters</li> +<li>No return type </li></ul> If called within a sticky session the sticky session continues. Otherwise: - -- On success this action initiates a sticky session. - -- On failure no sticky session is initiated. +<ul><li>On success this action initiates a sticky session.</li> +<li>On failure no sticky session is initiated.</li></ul> @@ -114,33 +108,23 @@ Otherwise: Signature: - -- Binding parameter is type of annotated entity set - -- No non-binding parameters - -- Return type is same as binding parameter type - +<ul><li>Binding parameter is type of annotated entity set</li> +<li>No non-binding parameters</li> +<li>Return type is same as binding parameter type</li></ul> If called within a sticky session the sticky session continues. Otherwise: - -- On success this action returns the targeted entity and initiates a sticky session. - -- On failure no sticky session is initiated. +<ul><li>On success this action returns the targeted entity and initiates a sticky session.</li> +<li>On failure no sticky session is initiated.</li></ul> Signature: - -- Binding parameter is type of annotated entity set - -- No non-binding parameters - -- Return type is same as binding parameter type - +<ul><li>Binding parameter is type of annotated entity set</li> +<li>No non-binding parameters</li> +<li>Return type is same as binding parameter type</li></ul> On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. On failure the sticky session is kept alive. @@ -150,11 +134,8 @@ On failure the sticky session is kept alive. Signature: - -- No parameters - -- No return type - +<ul><li>No parameters</li> +<li>No return type</li></ul> If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. If called outside of a sticky session the action fails and does not initiate a session. From b43b5ceb41f4ab51ab027fcd373ab47a12e5f1cf Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Thu, 11 Apr 2024 16:02:14 +0200 Subject: [PATCH 12/22] Added express as dev dependency --- package-lock.json | 782 ++++++++++++++++++++++++++++++++++++++++++++++ package.json | 1 + 2 files changed, 783 insertions(+) diff --git a/package-lock.json b/package-lock.json index c2a9b4d2..1d9e6b06 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,6 +14,7 @@ }, "devDependencies": { "eslint": "^8.56.0", + "express": "^4.19.2", "prettier": "^3.2.5" } }, @@ -156,6 +157,19 @@ "integrity": "sha512-zuVdFrMJiuCDQUMCzQaD6KL28MjnqqN8XnAqiEq9PNm/hCPTSGfrXCOfwj1ow4LFb/tNymJPwsNbVePc1xFqrQ==", "dev": true }, + "node_modules/accepts": { + "version": "1.3.8", + "resolved": "https://registry.npmjs.org/accepts/-/accepts-1.3.8.tgz", + "integrity": "sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==", + "dev": true, + "dependencies": { + "mime-types": "~2.1.34", + "negotiator": "0.6.3" + }, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/acorn": { "version": "8.11.3", "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.11.3.tgz", @@ -223,12 +237,57 @@ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "dev": true }, + "node_modules/array-flatten": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/array-flatten/-/array-flatten-1.1.1.tgz", + "integrity": "sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==", + "dev": true + }, "node_modules/balanced-match": { "version": "1.0.2", "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz", "integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==", "dev": true }, + "node_modules/body-parser": { + "version": "1.20.2", + "resolved": "https://registry.npmjs.org/body-parser/-/body-parser-1.20.2.tgz", + "integrity": "sha512-ml9pReCu3M61kGlqoTm2umSXTlRTuGTx0bfYj+uIUKKYycG5NtSbeetV3faSU6R7ajOPw0g/J1PvK4qNy7s5bA==", + "dev": true, + "dependencies": { + "bytes": "3.1.2", + "content-type": "~1.0.5", + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "on-finished": "2.4.1", + "qs": "6.11.0", + "raw-body": "2.5.2", + "type-is": "~1.6.18", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, + "node_modules/body-parser/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/body-parser/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -239,6 +298,34 @@ "concat-map": "0.0.1" } }, + "node_modules/bytes": { + "version": "3.1.2", + "resolved": "https://registry.npmjs.org/bytes/-/bytes-3.1.2.tgz", + "integrity": "sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/call-bind": { + "version": "1.0.7", + "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", + "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", + "dev": true, + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "set-function-length": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/callsites": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", @@ -296,6 +383,42 @@ "integrity": "sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==", "dev": true }, + "node_modules/content-disposition": { + "version": "0.5.4", + "resolved": "https://registry.npmjs.org/content-disposition/-/content-disposition-0.5.4.tgz", + "integrity": "sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==", + "dev": true, + "dependencies": { + "safe-buffer": "5.2.1" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/content-type": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/content-type/-/content-type-1.0.5.tgz", + "integrity": "sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/cookie/-/cookie-0.6.0.tgz", + "integrity": "sha512-U71cyTamuh1CRNCfpGY6to28lxvNwPG4Guz/EVjgf3Jmzv0vlDp1atT9eS5dDjMYHucpHbWns6Lwf3BKz6svdw==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/cookie-signature": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/cookie-signature/-/cookie-signature-1.0.6.tgz", + "integrity": "sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==", + "dev": true + }, "node_modules/cross-spawn": { "version": "7.0.3", "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz", @@ -333,6 +456,42 @@ "integrity": "sha512-oIPzksmTg4/MriiaYGO+okXDT7ztn/w3Eptv/+gSIdMdKsJo0u4CfYNFJPy+4SKMuCqGw2wxnA+URMg3t8a/bQ==", "dev": true }, + "node_modules/define-data-property": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", + "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", + "dev": true, + "dependencies": { + "es-define-property": "^1.0.0", + "es-errors": "^1.3.0", + "gopd": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/depd": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/depd/-/depd-2.0.0.tgz", + "integrity": "sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/destroy": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/destroy/-/destroy-1.2.0.tgz", + "integrity": "sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==", + "dev": true, + "engines": { + "node": ">= 0.8", + "npm": "1.2.8000 || >= 1.4.16" + } + }, "node_modules/doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -345,6 +504,48 @@ "node": ">=6.0.0" } }, + "node_modules/ee-first": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/ee-first/-/ee-first-1.1.1.tgz", + "integrity": "sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==", + "dev": true + }, + "node_modules/encodeurl": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/encodeurl/-/encodeurl-1.0.2.tgz", + "integrity": "sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/es-define-property": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", + "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.2.4" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/es-errors": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", + "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/escape-html": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/escape-html/-/escape-html-1.0.3.tgz", + "integrity": "sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==", + "dev": true + }, "node_modules/escape-string-regexp": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz", @@ -499,6 +700,72 @@ "node": ">=0.10.0" } }, + "node_modules/etag": { + "version": "1.8.1", + "resolved": "https://registry.npmjs.org/etag/-/etag-1.8.1.tgz", + "integrity": "sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/express": { + "version": "4.19.2", + "resolved": "https://registry.npmjs.org/express/-/express-4.19.2.tgz", + "integrity": "sha512-5T6nhjsT+EOMzuck8JjBHARTHfMht0POzlA60WV2pMD3gyXw2LZnZ+ueGdNxG+0calOJcWKbpFcuzLZ91YWq9Q==", + "dev": true, + "dependencies": { + "accepts": "~1.3.8", + "array-flatten": "1.1.1", + "body-parser": "1.20.2", + "content-disposition": "0.5.4", + "content-type": "~1.0.4", + "cookie": "0.6.0", + "cookie-signature": "1.0.6", + "debug": "2.6.9", + "depd": "2.0.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "finalhandler": "1.2.0", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "merge-descriptors": "1.0.1", + "methods": "~1.1.2", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "path-to-regexp": "0.1.7", + "proxy-addr": "~2.0.7", + "qs": "6.11.0", + "range-parser": "~1.2.1", + "safe-buffer": "5.2.1", + "send": "0.18.0", + "serve-static": "1.15.0", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "type-is": "~1.6.18", + "utils-merge": "1.0.1", + "vary": "~1.1.2" + }, + "engines": { + "node": ">= 0.10.0" + } + }, + "node_modules/express/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/express/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", @@ -538,6 +805,39 @@ "node": "^10.12.0 || >=12.0.0" } }, + "node_modules/finalhandler": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-1.2.0.tgz", + "integrity": "sha512-5uXcUVftlQMFnWC9qu/svkWv3GTd2PfUhK/3PLkYNAe7FbqJMt3515HaxE6eRL74GdsriiwujiawdaB1BpEISg==", + "dev": true, + "dependencies": { + "debug": "2.6.9", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "on-finished": "2.4.1", + "parseurl": "~1.3.3", + "statuses": "2.0.1", + "unpipe": "~1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/finalhandler/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/finalhandler/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, "node_modules/find-up": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", @@ -574,12 +874,58 @@ "integrity": "sha512-36yxDn5H7OFZQla0/jFJmbIKTdZAQHngCedGxiMmpNfEZM0sdEeT+WczLQrjK6D7o2aiyLYDnkw0R3JK0Qv1RQ==", "dev": true }, + "node_modules/forwarded": { + "version": "0.2.0", + "resolved": "https://registry.npmjs.org/forwarded/-/forwarded-0.2.0.tgz", + "integrity": "sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/fresh": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/fresh/-/fresh-0.5.2.tgz", + "integrity": "sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", "integrity": "sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==", "dev": true }, + "node_modules/function-bind": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", + "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/get-intrinsic": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", + "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", + "dev": true, + "dependencies": { + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "has-proto": "^1.0.1", + "has-symbols": "^1.0.3", + "hasown": "^2.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/get-stdin": { "version": "7.0.0", "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-7.0.0.tgz", @@ -635,6 +981,18 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/gopd": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", + "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", + "dev": true, + "dependencies": { + "get-intrinsic": "^1.1.3" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/graphemer": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/graphemer/-/graphemer-1.4.0.tgz", @@ -650,6 +1008,82 @@ "node": ">=8" } }, + "node_modules/has-property-descriptors": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", + "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", + "dev": true, + "dependencies": { + "es-define-property": "^1.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-proto": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", + "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/has-symbols": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", + "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/hasown": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", + "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/http-errors": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/http-errors/-/http-errors-2.0.0.tgz", + "integrity": "sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==", + "dev": true, + "dependencies": { + "depd": "2.0.0", + "inherits": "2.0.4", + "setprototypeof": "1.2.0", + "statuses": "2.0.1", + "toidentifier": "1.0.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/iconv-lite": { + "version": "0.4.24", + "resolved": "https://registry.npmjs.org/iconv-lite/-/iconv-lite-0.4.24.tgz", + "integrity": "sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==", + "dev": true, + "dependencies": { + "safer-buffer": ">= 2.1.2 < 3" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/ignore": { "version": "5.3.1", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.3.1.tgz", @@ -700,6 +1134,15 @@ "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", "dev": true }, + "node_modules/ipaddr.js": { + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/ipaddr.js/-/ipaddr.js-1.9.1.tgz", + "integrity": "sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==", + "dev": true, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/is-extglob": { "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", @@ -809,6 +1252,63 @@ "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", "dev": true }, + "node_modules/media-typer": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz", + "integrity": "sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/merge-descriptors": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/merge-descriptors/-/merge-descriptors-1.0.1.tgz", + "integrity": "sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==", + "dev": true + }, + "node_modules/methods": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/methods/-/methods-1.1.2.tgz", + "integrity": "sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime": { + "version": "1.6.0", + "resolved": "https://registry.npmjs.org/mime/-/mime-1.6.0.tgz", + "integrity": "sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==", + "dev": true, + "bin": { + "mime": "cli.js" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/mime-db": { + "version": "1.52.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", + "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/mime-types": { + "version": "2.1.35", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", + "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", + "dev": true, + "dependencies": { + "mime-db": "1.52.0" + }, + "engines": { + "node": ">= 0.6" + } + }, "node_modules/minimatch": { "version": "3.1.2", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz", @@ -833,6 +1333,24 @@ "integrity": "sha512-OWND8ei3VtNC9h7V60qff3SVobHr996CTwgxubgyQYEpg290h9J0buyECNNJexkFm5sOajh5G116RYA1c8ZMSw==", "dev": true }, + "node_modules/negotiator": { + "version": "0.6.3", + "resolved": "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz", + "integrity": "sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/object-inspect": { + "version": "1.13.1", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.13.1.tgz", + "integrity": "sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/odata-csdl": { "version": "0.9.5", "resolved": "https://registry.npmjs.org/odata-csdl/-/odata-csdl-0.9.5.tgz", @@ -857,6 +1375,18 @@ "odata-vocab2md": "lib/cli.js" } }, + "node_modules/on-finished": { + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/on-finished/-/on-finished-2.4.1.tgz", + "integrity": "sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==", + "dev": true, + "dependencies": { + "ee-first": "1.1.1" + }, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -936,6 +1466,15 @@ "node": ">=6" } }, + "node_modules/parseurl": { + "version": "1.3.3", + "resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz", + "integrity": "sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/path-exists": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", @@ -963,6 +1502,12 @@ "node": ">=8" } }, + "node_modules/path-to-regexp": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-0.1.7.tgz", + "integrity": "sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==", + "dev": true + }, "node_modules/prelude-ls": { "version": "1.2.1", "resolved": "https://registry.npmjs.org/prelude-ls/-/prelude-ls-1.2.1.tgz", @@ -987,6 +1532,19 @@ "url": "https://github.com/prettier/prettier?sponsor=1" } }, + "node_modules/proxy-addr": { + "version": "2.0.7", + "resolved": "https://registry.npmjs.org/proxy-addr/-/proxy-addr-2.0.7.tgz", + "integrity": "sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==", + "dev": true, + "dependencies": { + "forwarded": "0.2.0", + "ipaddr.js": "1.9.1" + }, + "engines": { + "node": ">= 0.10" + } + }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", @@ -996,6 +1554,21 @@ "node": ">=6" } }, + "node_modules/qs": { + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/qs/-/qs-6.11.0.tgz", + "integrity": "sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==", + "dev": true, + "dependencies": { + "side-channel": "^1.0.4" + }, + "engines": { + "node": ">=0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/queue-microtask": { "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", @@ -1016,6 +1589,30 @@ } ] }, + "node_modules/range-parser": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/range-parser/-/range-parser-1.2.1.tgz", + "integrity": "sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==", + "dev": true, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/raw-body": { + "version": "2.5.2", + "resolved": "https://registry.npmjs.org/raw-body/-/raw-body-2.5.2.tgz", + "integrity": "sha512-8zGqypfENjCIqGhgXToC8aB2r7YrBX+AQAfIPs/Mlk+BtPTztOvTS01NRW/3Eh60J+a48lt8qsCzirQ6loCVfA==", + "dev": true, + "dependencies": { + "bytes": "3.1.2", + "http-errors": "2.0.0", + "iconv-lite": "0.4.24", + "unpipe": "1.0.0" + }, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/resolve-from": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz", @@ -1073,11 +1670,120 @@ "queue-microtask": "^1.2.2" } }, + "node_modules/safe-buffer": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/safe-buffer/-/safe-buffer-5.2.1.tgz", + "integrity": "sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==", + "dev": true, + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/feross" + }, + { + "type": "patreon", + "url": "https://www.patreon.com/feross" + }, + { + "type": "consulting", + "url": "https://feross.org/support" + } + ] + }, + "node_modules/safer-buffer": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/safer-buffer/-/safer-buffer-2.1.2.tgz", + "integrity": "sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==", + "dev": true + }, "node_modules/sax": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/sax/-/sax-1.3.0.tgz", "integrity": "sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA==" }, + "node_modules/send": { + "version": "0.18.0", + "resolved": "https://registry.npmjs.org/send/-/send-0.18.0.tgz", + "integrity": "sha512-qqWzuOjSFOuqPjFe4NOsMLafToQQwBSOEpS+FwEt3A2V3vKubTquT3vmLTQpFgMXp8AlFWFuP1qKaJZOtPpVXg==", + "dev": true, + "dependencies": { + "debug": "2.6.9", + "depd": "2.0.0", + "destroy": "1.2.0", + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "etag": "~1.8.1", + "fresh": "0.5.2", + "http-errors": "2.0.0", + "mime": "1.6.0", + "ms": "2.1.3", + "on-finished": "2.4.1", + "range-parser": "~1.2.1", + "statuses": "2.0.1" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/send/node_modules/debug": { + "version": "2.6.9", + "resolved": "https://registry.npmjs.org/debug/-/debug-2.6.9.tgz", + "integrity": "sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==", + "dev": true, + "dependencies": { + "ms": "2.0.0" + } + }, + "node_modules/send/node_modules/debug/node_modules/ms": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz", + "integrity": "sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==", + "dev": true + }, + "node_modules/send/node_modules/ms": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz", + "integrity": "sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==", + "dev": true + }, + "node_modules/serve-static": { + "version": "1.15.0", + "resolved": "https://registry.npmjs.org/serve-static/-/serve-static-1.15.0.tgz", + "integrity": "sha512-XGuRDNjXUijsUL0vl6nSD7cwURuzEgglbOaFuZM9g3kwDXOWVTck0jLzjPzGD+TazWbboZYu52/9/XPdUgne9g==", + "dev": true, + "dependencies": { + "encodeurl": "~1.0.2", + "escape-html": "~1.0.3", + "parseurl": "~1.3.3", + "send": "0.18.0" + }, + "engines": { + "node": ">= 0.8.0" + } + }, + "node_modules/set-function-length": { + "version": "1.2.2", + "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.2.tgz", + "integrity": "sha512-pgRc4hJ4/sNjWCSS9AmnS40x3bNMDTknHgL5UaMBTMyJnU90EgWh1Rz+MC9eFu4BuN/UwZjKQuY/1v3rM7HMfg==", + "dev": true, + "dependencies": { + "define-data-property": "^1.1.4", + "es-errors": "^1.3.0", + "function-bind": "^1.1.2", + "get-intrinsic": "^1.2.4", + "gopd": "^1.0.1", + "has-property-descriptors": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/setprototypeof": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/setprototypeof/-/setprototypeof-1.2.0.tgz", + "integrity": "sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==", + "dev": true + }, "node_modules/shebang-command": { "version": "2.0.0", "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", @@ -1099,6 +1805,33 @@ "node": ">=8" } }, + "node_modules/side-channel": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", + "integrity": "sha512-fDW/EZ6Q9RiO8eFG8Hj+7u/oW+XrPTIChwCOM2+th2A6OblDtYYIpve9m+KvI9Z4C9qSEXlaGR6bTEYHReuglA==", + "dev": true, + "dependencies": { + "call-bind": "^1.0.7", + "es-errors": "^1.3.0", + "get-intrinsic": "^1.2.4", + "object-inspect": "^1.13.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/statuses": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/statuses/-/statuses-2.0.1.tgz", + "integrity": "sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/strip-ansi": { "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", @@ -1141,6 +1874,15 @@ "integrity": "sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==", "dev": true }, + "node_modules/toidentifier": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/toidentifier/-/toidentifier-1.0.1.tgz", + "integrity": "sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==", + "dev": true, + "engines": { + "node": ">=0.6" + } + }, "node_modules/type-check": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/type-check/-/type-check-0.4.0.tgz", @@ -1165,6 +1907,28 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/type-is": { + "version": "1.6.18", + "resolved": "https://registry.npmjs.org/type-is/-/type-is-1.6.18.tgz", + "integrity": "sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==", + "dev": true, + "dependencies": { + "media-typer": "0.3.0", + "mime-types": "~2.1.24" + }, + "engines": { + "node": ">= 0.6" + } + }, + "node_modules/unpipe": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz", + "integrity": "sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/uri-js": { "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", @@ -1174,6 +1938,24 @@ "punycode": "^2.1.0" } }, + "node_modules/utils-merge": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/utils-merge/-/utils-merge-1.0.1.tgz", + "integrity": "sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==", + "dev": true, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/vary": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", + "integrity": "sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==", + "dev": true, + "engines": { + "node": ">= 0.8" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", diff --git a/package.json b/package.json index 7262f85f..afdc05dd 100644 --- a/package.json +++ b/package.json @@ -18,6 +18,7 @@ }, "devDependencies": { "eslint": "^8.56.0", + "express": "^4.19.2", "prettier": "^3.2.5" }, "scripts": { From 4c668730ea33ceed957676b6554104ca1cbb43e1 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 16:09:29 +0200 Subject: [PATCH 13/22] Revert "typographics" This reverts commit 2132027f2897ee5f05cfc833fee65a9a9e7c3252. --- _site/.gitignore | 2 - package-lock.json | 2 +- package.json | 3 +- vocabularies/Common.json | 2 +- vocabularies/Common.md | 304 ++++++++++++++++----------------- vocabularies/Common.xml | 21 ++- vocabularies/DirectEdit.json | 2 +- vocabularies/DirectEdit.md | 2 +- vocabularies/DirectEdit.xml | 27 +-- vocabularies/PersonalData.json | 2 +- vocabularies/PersonalData.md | 2 +- vocabularies/PersonalData.xml | 12 +- vocabularies/Session.json | 8 +- vocabularies/Session.md | 10 +- vocabularies/Session.xml | 49 ++++-- 15 files changed, 240 insertions(+), 208 deletions(-) delete mode 100644 _site/.gitignore diff --git a/_site/.gitignore b/_site/.gitignore deleted file mode 100644 index d6b7ef32..00000000 --- a/_site/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -* -!.gitignore diff --git a/package-lock.json b/package-lock.json index c2a9b4d2..8395fea7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -847,7 +847,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#1887311d443c40067a3285f3e00ef077ae21c117", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#d431c2f2abb2078f83b56f0ef1d42d3b75731306", "dependencies": { "colors": "^1.4.0", "odata-csdl": "^0.9.5", diff --git a/package.json b/package.json index 7262f85f..82fd9c8c 100644 --- a/package.json +++ b/package.json @@ -22,8 +22,7 @@ }, "scripts": { "build": "node lib/transform.js", - "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"", - "serve-pages": "node -e \"require('odata-vocabularies/serve-pages')\"" + "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"" }, "author": "", "license": "" diff --git a/vocabularies/Common.json b/vocabularies/Common.json index bbf8c119..f0834322 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -376,7 +376,7 @@ "$Collection": true, "$Type": "Edm.ComplexType", "@Core.Description": "Collection of end-user messages", - "@Core.LongDescription": "The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.\n\nThe minimum structure is\n
    • `code: Edm.String`
      • \n
    • `message: Edm.String`
      • \n
    • `target: Edm.String nullable`
      • \n
    • `additionalTargets: Collection(Edm.String)`
      • \n
    • `transition: Edm.Boolean`
      • \n
    • `numericSeverity: Edm.Byte`
      • \n
    • `longtextUrl: Edm.String nullable`
    \n " + "@Core.LongDescription": "The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.\n\nThe minimum structure is\n\n- `code: Edm.String`\n\n- `message: Edm.String`\n\n- `target: Edm.String nullable`\n\n- `additionalTargets: Collection(Edm.String)`\n\n- `transition: Edm.Boolean`\n\n- `numericSeverity: Edm.Byte`\n\n- `longtextUrl: Edm.String nullable`\n " }, "additionalTargets": { "$Kind": "Term", diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 8cdfa1dc..7501b9d5 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -46,71 +46,71 @@ Term|Type|Description [Timestamp](./Common.xml#L457:~:text=... [TransactionId](./Common.xml#L462:~:text=... [ErrorResolution](./Common.xml#L467:~:text=Hints for resolving this error -[Messages](./Common.xml#L485:~:text=Collection of end-user messages
    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
    The minimum structure is
    • `code: Edm.String`
    • `message: Edm.String`
    • `target: Edm.String nullable`
    • `additionalTargets: Collection(Edm.String)`
    • `transition: Edm.Boolean`
    • `numericSeverity: Edm.Byte`
    • `longtextUrl: Edm.String nullable`
    -[additionalTargets](./Common.xml#L501:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[longtextUrl](./Common.xml#L507:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[numericSeverity](./Common.xml#L513:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[MaximumNumericMessageSeverity](./Common.xml#L518:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
    This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) -[IsActionCritical](./Common.xml#L547:~:text=Criticality of the function or action to enforce a warning or similar before it's executed -[Attributes](./Common.xml#L551:~:text=Attributes related to this property, which may occur in denormalized entity types -[RelatedRecursiveHierarchy](./Common.xml#L555:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. -[Interval](./Common.xml#L559:~:text=An interval with lower and upper boundaries described by two properties -[ResultContext](./Common.xml#L582:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. -[SAPObjectNodeType](./Common.xml#L590:~:text=The SAP Object Node Type represented by the annotated entity type
    SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. -[Composition](./Common.xml#L606:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
    The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. -[SAPObjectNodeTypeReference](./Common.xml#L615:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
    The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. -[IsNaturalPerson](./Common.xml#L623:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person -[ValueList](./Common.xml#L629:~:text=Specifies how to get a list of acceptable values for a property or parameter
    The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. -[ValueListRelevantQualifiers](./Common.xml#L703:~:text=List of qualifiers of relevant ValueList annotations
    The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. -[ValueListWithFixedValues](./Common.xml#L708:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
    Can be annotated with:
    • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
    -[ValueListShowValuesImmediately](./Common.xml#L717:~:text=A value list with a very small number of fixed values, can decide to show all values immediately -[ValueListForValidation](./Common.xml#L722:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
    An empty string identifies the ValueList or ValueListMapping without a qualifier. -[ValueListReferences](./Common.xml#L727:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property -[ValueListMapping](./Common.xml#L732:~:text=Specifies the mapping between data service properties and value list properties
    The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. -[IsCalendarYear](./Common.xml#L844:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) -[IsCalendarHalfyear](./Common.xml#L853:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] -[IsCalendarQuarter](./Common.xml#L862:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsCalendarMonth](./Common.xml#L871:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] -[IsCalendarWeek](./Common.xml#L880:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsDayOfCalendarMonth](./Common.xml#L889:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. -[IsDayOfCalendarYear](./Common.xml#L897:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. -[IsCalendarYearHalfyear](./Common.xml#L905:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] -[IsCalendarYearQuarter](./Common.xml#L915:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] -[IsCalendarYearMonth](./Common.xml#L925:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) -[IsCalendarYearWeek](./Common.xml#L936:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsCalendarDate](./Common.xml#L946:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. -[IsFiscalYear](./Common.xml#L963:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} -[IsFiscalPeriod](./Common.xml#L972:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} -[IsFiscalYearPeriod](./Common.xml#L981:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) -[IsFiscalQuarter](./Common.xml#L991:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsFiscalYearQuarter](./Common.xml#L999:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] -[IsFiscalWeek](./Common.xml#L1008:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsFiscalYearWeek](./Common.xml#L1016:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsDayOfFiscalYear](./Common.xml#L1025:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. -[IsFiscalYearVariant](./Common.xml#L1032:~:text=Property encodes a fiscal year variant -[MutuallyExclusiveTerm](./Common.xml#L1040:~:text=Only one term of the group identified with the Qualifier attribute can be applied -[DraftRoot](./Common.xml#L1046:~:text=Root entities of business documents that support the draft pattern -[DraftNode](./Common.xml#L1087:~:text=Entities in this set are parts of business documents that support the draft pattern -[DraftActivationVia](./Common.xml#L1109:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets -[EditableFieldFor](./Common.xml#L1113:~:text=The annotated property is an editable field for the referenced key property -[SemanticKey](./Common.xml#L1143:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity -[SideEffects](./Common.xml#L1147:~:text=Describes side-effects of modification operations -[DefaultValuesFunction](./Common.xml#L1230:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
    The default values function must have a bound overload whose binding parameter type matches the annotation target
    - for an entity set: collection of entity type of entity set
    - for a navigation property: identical to the type of the navigation property (single- or collection-valued)
    - for a bound action/function: identical to the binding parameter type of the annotated action/function
    In addition the overload can have non-binding parameters for values that the user has already entered:
    - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
    - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
    The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
    - the properties of the entity to create, or
    - the parameters of the action or function to call -[DerivedDefaultValue](./Common.xml#L1259:~:text=Function import to derive a default value for the property from a given context.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[FilterDefaultValue](./Common.xml#L1280:~:text=A default value for the property to be used in filter expressions. -[FilterDefaultValueHigh](./Common.xml#L1284:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. -[DerivedFilterDefaultValue](./Common.xml#L1289:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[SortOrder](./Common.xml#L1313:~:text=List of sort criteria
    The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. -[RecursiveHierarchy](./Common.xml#L1369:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead -[CreatedAt](./Common.xml#L1417:~:text=Creation timestamp -[CreatedBy](./Common.xml#L1421:~:text=First editor -[ChangedAt](./Common.xml#L1425:~:text=Last modification timestamp -[ChangedBy](./Common.xml#L1429:~:text=Last editor -[OriginalProtocolVersion](./Common.xml#L1441:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` -[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1446:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
    TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ -[mediaUploadLink](./Common.xml#L1452:~:text=URL for uploading new media content to a Document Management Service
    In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. -[PrimitivePropertyPath](./Common.xml#L1467:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property -[WebSocketBaseURL](./Common.xml#L1472:~:text=Base URL for WebSocket connections +[Messages](./Common.xml#L485:~:text=Collection of end-user messages
    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
    The minimum structure is
    - `code: Edm.String`
    - `message: Edm.String`
    - `target: Edm.String nullable`
    - `additionalTargets: Collection(Edm.String)`
    - `transition: Edm.Boolean`
    - `numericSeverity: Edm.Byte`
    - `longtextUrl: Edm.String nullable` +[additionalTargets](./Common.xml#L508:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[longtextUrl](./Common.xml#L514:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[numericSeverity](./Common.xml#L520:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[MaximumNumericMessageSeverity](./Common.xml#L525:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
    This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) +[IsActionCritical](./Common.xml#L554:~:text=Criticality of the function or action to enforce a warning or similar before it's executed +[Attributes](./Common.xml#L558:~:text=Attributes related to this property, which may occur in denormalized entity types +[RelatedRecursiveHierarchy](./Common.xml#L562:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. +[Interval](./Common.xml#L566:~:text=An interval with lower and upper boundaries described by two properties +[ResultContext](./Common.xml#L589:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. +[SAPObjectNodeType](./Common.xml#L597:~:text=The SAP Object Node Type represented by the annotated entity type
    SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. +[Composition](./Common.xml#L613:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
    The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. +[SAPObjectNodeTypeReference](./Common.xml#L622:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
    The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. +[IsNaturalPerson](./Common.xml#L630:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person +[ValueList](./Common.xml#L636:~:text=Specifies how to get a list of acceptable values for a property or parameter
    The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. +[ValueListRelevantQualifiers](./Common.xml#L710:~:text=List of qualifiers of relevant ValueList annotations
    The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. +[ValueListWithFixedValues](./Common.xml#L715:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
    Can be annotated with:
    • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
    +[ValueListShowValuesImmediately](./Common.xml#L724:~:text=A value list with a very small number of fixed values, can decide to show all values immediately +[ValueListForValidation](./Common.xml#L729:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
    An empty string identifies the ValueList or ValueListMapping without a qualifier. +[ValueListReferences](./Common.xml#L734:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property +[ValueListMapping](./Common.xml#L739:~:text=Specifies the mapping between data service properties and value list properties
    The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. +[IsCalendarYear](./Common.xml#L851:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) +[IsCalendarHalfyear](./Common.xml#L860:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] +[IsCalendarQuarter](./Common.xml#L869:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsCalendarMonth](./Common.xml#L878:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] +[IsCalendarWeek](./Common.xml#L887:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsDayOfCalendarMonth](./Common.xml#L896:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. +[IsDayOfCalendarYear](./Common.xml#L904:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. +[IsCalendarYearHalfyear](./Common.xml#L912:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] +[IsCalendarYearQuarter](./Common.xml#L922:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] +[IsCalendarYearMonth](./Common.xml#L932:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) +[IsCalendarYearWeek](./Common.xml#L943:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsCalendarDate](./Common.xml#L953:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. +[IsFiscalYear](./Common.xml#L970:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} +[IsFiscalPeriod](./Common.xml#L979:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} +[IsFiscalYearPeriod](./Common.xml#L988:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) +[IsFiscalQuarter](./Common.xml#L998:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsFiscalYearQuarter](./Common.xml#L1006:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] +[IsFiscalWeek](./Common.xml#L1015:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsFiscalYearWeek](./Common.xml#L1023:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsDayOfFiscalYear](./Common.xml#L1032:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. +[IsFiscalYearVariant](./Common.xml#L1039:~:text=Property encodes a fiscal year variant +[MutuallyExclusiveTerm](./Common.xml#L1047:~:text=Only one term of the group identified with the Qualifier attribute can be applied +[DraftRoot](./Common.xml#L1053:~:text=Root entities of business documents that support the draft pattern +[DraftNode](./Common.xml#L1094:~:text=Entities in this set are parts of business documents that support the draft pattern +[DraftActivationVia](./Common.xml#L1116:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets +[EditableFieldFor](./Common.xml#L1120:~:text=The annotated property is an editable field for the referenced key property +[SemanticKey](./Common.xml#L1150:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity +[SideEffects](./Common.xml#L1154:~:text=Describes side-effects of modification operations +[DefaultValuesFunction](./Common.xml#L1237:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
    The default values function must have a bound overload whose binding parameter type matches the annotation target
    - for an entity set: collection of entity type of entity set
    - for a navigation property: identical to the type of the navigation property (single- or collection-valued)
    - for a bound action/function: identical to the binding parameter type of the annotated action/function
    In addition the overload can have non-binding parameters for values that the user has already entered:
    - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
    - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
    The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
    - the properties of the entity to create, or
    - the parameters of the action or function to call +[DerivedDefaultValue](./Common.xml#L1266:~:text=Function import to derive a default value for the property from a given context.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[FilterDefaultValue](./Common.xml#L1287:~:text=A default value for the property to be used in filter expressions. +[FilterDefaultValueHigh](./Common.xml#L1291:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. +[DerivedFilterDefaultValue](./Common.xml#L1296:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[SortOrder](./Common.xml#L1320:~:text=List of sort criteria
    The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. +[RecursiveHierarchy](./Common.xml#L1376:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead +[CreatedAt](./Common.xml#L1424:~:text=Creation timestamp +[CreatedBy](./Common.xml#L1428:~:text=First editor +[ChangedAt](./Common.xml#L1432:~:text=Last modification timestamp +[ChangedBy](./Common.xml#L1436:~:text=Last editor +[OriginalProtocolVersion](./Common.xml#L1448:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` +[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1453:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
    TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ +[mediaUploadLink](./Common.xml#L1459:~:text=URL for uploading new media content to a Document Management Service
    In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. +[PrimitivePropertyPath](./Common.xml#L1474:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property +[WebSocketBaseURL](./Common.xml#L1479:~:text=Base URL for WebSocket connections ## [TextFormatType](./Common.xml#L120:~:text= -## [NumericMessageSeverityType](./Common.xml#L523:~:text= -## [IntervalType](./Common.xml#L562:~:text= -## [SAPObjectNodeTypeType](./Common.xml#L598:~:text= -## [ValueListType](./Common.xml#L633:~:text=The value of the target property is used as the search expression instead of in $filter -[FetchValues](./Common.xml#L671:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath -[SelectionVariantQualifier](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L682:~:text=The value of the target property is used as the search expression instead of in $filter +[FetchValues](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath +[SelectionVariantQualifier](./Common.xml#L685:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L689:~:text= -## [FetchValuesType](./Common.xml#L687:~:text= -## [ValueListMappingType](./Common.xml#L736:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation -[SelectionVariantQualifier](./Common.xml#L759:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L763:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation +[SelectionVariantQualifier](./Common.xml#L766:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L770:~:text= -## [*ValueListParameter*](./Common.xml#L768:~:text= -## [ValueListParameterIn](./Common.xml#L773:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators -[InitialValueIsSignificant](./Common.xml#L778:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators +[InitialValueIsSignificant](./Common.xml#L785:~:text= -## [ValueListParameterConstant](./Common.xml#L782:~:text= -## [ValueListParameterConstants](./Common.xml#L791:~:text=An empty list means a vacuous filter condition +[*ValueListProperty*](./Common.xml#L776:~:text=An empty list means a vacuous filter condition -## [ValueListParameterInOut](./Common.xml#L800:~:text= -## [ValueListParameterOut](./Common.xml#L813:~:text= -## [ValueListParameterDisplayOnly](./Common.xml#L823:~:text= -## [ValueListParameterFilterOnly](./Common.xml#L831:~:text= -## [DraftRootType](./Common.xml#L1051:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. -[AdditionalNewActions](./Common.xml#L1066:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. -[ShareAction](./Common.xml#L1071:~:text=The action is bound to the draft document root node and has the following signature:
    - `Users`: collection of structure with properties
      - `UserID` of type `String` and
      - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
    It restricts access to the listed users in their specified roles. +[*PreparationAction*](./Common.xml#L1100:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. +[AdditionalNewActions](./Common.xml#L1073:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. +[ShareAction](./Common.xml#L1078:~:text=The action is bound to the draft document root node and has the following signature:
    - `Users`: collection of structure with properties
      - `UserID` of type `String` and
      - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
    It restricts access to the listed users in their specified roles. -## [DraftNodeType](./Common.xml#L1092:~:text= -## [SimpleIdentifier](./Common.xml#L1117:~:text= -## [QualifiedName](./Common.xml#L1129:~:text= -## [ActionOverload](./Common.xml#L1134:~:text= -## [SideEffectsType](./Common.xml#L1150:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path -[TargetEntities](./Common.xml#L1172:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. -[Discretionary](./Common.xml#L1190:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. +[SourceProperties](./Common.xml#L1169:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path +[TargetEntities](./Common.xml#L1179:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. +[Discretionary](./Common.xml#L1197:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. -## [EffectType](./Common.xml#L1196:~:text= -## [SortOrderType](./Common.xml#L1321:~:text=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:
    • [AggregatedProperty](Analytics.md#AggregatedProperty)
    • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
    -[Descending](./Common.xml#L1349:~:text=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:
    • [AggregatedProperty](Analytics.md#AggregatedProperty)
    • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
    +[Descending](./Common.xml#L1356:~:text= -## [RecursiveHierarchyType](./Common.xml#L1382:~:text= -## [UserID](./Common.xml#L1433:~:text=The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure. The minimum structure is -<ul><li>`code: Edm.String`</li> -<li>`message: Edm.String`</li> -<li>`target: Edm.String nullable`</li> -<li>`additionalTargets: Collection(Edm.String)`</li> -<li>`transition: Edm.Boolean`</li> -<li>`numericSeverity: Edm.Byte`</li> -<li>`longtextUrl: Edm.String nullable`</li></ul> + +- `code: Edm.String` + +- `message: Edm.String` + +- `target: Edm.String nullable` + +- `additionalTargets: Collection(Edm.String)` + +- `transition: Edm.Boolean` + +- `numericSeverity: Edm.Byte` + +- `longtextUrl: Edm.String nullable`     diff --git a/vocabularies/DirectEdit.json b/vocabularies/DirectEdit.json index 35651d52..b7792c35 100644 --- a/vocabularies/DirectEdit.json +++ b/vocabularies/DirectEdit.json @@ -38,7 +38,7 @@ }, "CalculationFunction": { "$Type": "Common.QualifiedName", - "@Core.Description": "The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:\n
    • `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\n or cast-compatible: the qualifier of the `SideEffects` annotation
      • \n
    • `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
      • \n
    • `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it
    \n\nThe **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it,\nit can be the same type as for `Data`.\n\nStructure-compatible means:\n
    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable
      • \n
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
      • \n
    • it may contain properties without a corresponding property in the entity type
      • \n
    • it may omit properties of the entity type
    " + "@Core.Description": "The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:\n\n- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\n or cast-compatible: the qualifier of the `SideEffects` annotation\n\n- `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property\n\n- `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it\n\nThe **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it,\nit can be the same type as for `Data`.\n\nStructure-compatible means:\n\n- each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, \n\n- each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property\n \n- it may contain properties without a corresponding property in the entity type\n\n- it may omit properties of the entity type" } } } diff --git a/vocabularies/DirectEdit.md b/vocabularies/DirectEdit.md index 97326780..54d99cd3 100644 --- a/vocabularies/DirectEdit.md +++ b/vocabularies/DirectEdit.md @@ -19,4 +19,4 @@ After a change to a property whose path is contained in `Triggers`, the client s Property|Type|Description :-------|:---|:---------- [Triggers](./DirectEdit.xml#L48:~:text=
  • `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) or cast-compatible: the qualifier of the `SideEffects` annotation
  • `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
  • `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it

    • The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means:
    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • it may contain properties without a corresponding property in the entity type
    • it may omit properties of the entity type
    +[CalculationFunction](./DirectEdit.xml#L52:~:text=- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) or cast-compatible: the qualifier of the `SideEffects` annotation
    - `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
    - `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it
    The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means:
    - each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
    - each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - it may contain properties without a corresponding property in the entity type
    - it may omit properties of the entity type diff --git a/vocabularies/DirectEdit.xml b/vocabularies/DirectEdit.xml index 7cd3a3fd..36a995d0 100644 --- a/vocabularies/DirectEdit.xml +++ b/vocabularies/DirectEdit.xml @@ -50,22 +50,27 @@     - - The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters: -<ul><li>`Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) - or cast-compatible: the qualifier of the `SideEffects` annotation</li> -<li>`Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property</li> -<li>`Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it</li></ul> + diff --git a/vocabularies/PersonalData.json b/vocabularies/PersonalData.json index d2848d6b..e02d7a05 100644 --- a/vocabularies/PersonalData.json +++ b/vocabularies/PersonalData.json @@ -136,7 +136,7 @@ "$DefaultValue": true, "$AppliesTo": ["Property"], "@Core.Description": "Property contains potentially sensitive personal data", - "@Core.LongDescription": "Sensitive data is a colloquial term usually including the following data:\n
    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
      • \n
    • Personal data subject to professional secrecy
      • \n
    • Personal data relating to criminal or administrative offences
      • \n
    • Personal data concerning bank or credit card accounts
    \n\nSee also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en)" + "@Core.LongDescription": "Sensitive data is a colloquial term usually including the following data:\n\n- Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation\n\n- Personal data subject to professional secrecy\n\n- Personal data relating to criminal or administrative offences\n\n- Personal data concerning bank or credit card accounts\n\nSee also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en)" } } } diff --git a/vocabularies/PersonalData.md b/vocabularies/PersonalData.md index 464c08fb..b70c9fd6 100644 --- a/vocabularies/PersonalData.md +++ b/vocabularies/PersonalData.md @@ -32,7 +32,7 @@ Term|Type|Description [DataSubjectRoleDescription](./PersonalData.xml#L68:~:text=Language-dependent description of the role of the data subjects in this set (e.g. employee, customer)
    Values are application-specific. Can be a static value or a `Path` expression If the role varies per entity [FieldSemantics](./PersonalData.xml#L111:~:text=Primary meaning of the personal data contained in the annotated property
    Changes to values of annotated properties are tracked in the audit log. Use this annotation also on fields that are already marked as contact or address data. [IsPotentiallyPersonal](./PersonalData.xml#L195:~:text=Property contains potentially personal data
    Personal data is information relating to an identified or identifiable natural person (data subject).
    Note: properties annotated with [`FieldSemantics`](#FieldSemantics) need not be additionally annotated with this term.
    See also: [What is personal data?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/what-personal-data_en) -[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data:
    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    • Personal data subject to professional secrecy
    • Personal data relating to criminal or administrative offences
    • Personal data concerning bank or credit card accounts

    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) +[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data:
    - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    - Personal data subject to professional secrecy
    - Personal data relating to criminal or administrative offences
    - Personal data concerning bank or credit card accounts
    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) ## [EntitySemanticsType](./PersonalData.xml#L76:~:text= Sensitive data is a colloquial term usually including the following data: -<ul><li>Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation</li> -<li>Personal data subject to professional secrecy</li> -<li>Personal data relating to criminal or administrative offences</li> -<li>Personal data concerning bank or credit card accounts</li></ul> + +- Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation + +- Personal data subject to professional secrecy + +- Personal data relating to criminal or administrative offences + +- Personal data concerning bank or credit card accounts See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) diff --git a/vocabularies/Session.json b/vocabularies/Session.json index 9be08ed8..61d5f12c 100644 --- a/vocabularies/Session.json +++ b/vocabularies/Session.json @@ -38,7 +38,7 @@ "NewAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that initiates a sticky session for creating new entities in the targeted entity set or collection", - "@Core.LongDescription": "Signature:\n
    • Binding parameter is collection of type of annotated entity set
      • \n
    • No non-binding parameters
      • \n
    • No return type
    \nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n
    • On success this action initiates a sticky session.
      • \n
    • On failure no sticky session is initiated.
    " + "@Core.LongDescription": "Signature:\n\n- Binding parameter is collection of type of annotated entity set\n\n- No non-binding parameters\n\n- No return type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n\n- On success this action initiates a sticky session.\n\n- On failure no sticky session is initiated." }, "AdditionalNewActions": { "$Collection": true, @@ -50,17 +50,17 @@ "EditAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that initiates a sticky session for editing the targeted entity", - "@Core.LongDescription": "Signature:\n
    • Binding parameter is type of annotated entity set
      • \n
    • No non-binding parameters
      • \n
    • Return type is same as binding parameter type
    \nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n
    • On success this action returns the targeted entity and initiates a sticky session.
      • \n
    • On failure no sticky session is initiated.
    " + "@Core.LongDescription": "Signature:\n\n- Binding parameter is type of annotated entity set\n\n- No non-binding parameters\n\n- Return type is same as binding parameter type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n\n- On success this action returns the targeted entity and initiates a sticky session.\n\n- On failure no sticky session is initiated." }, "SaveAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that saves a new or edited entity", - "@Core.LongDescription": "Signature:\n
    • Binding parameter is type of annotated entity set
      • \n
    • No non-binding parameters
      • \n
    • Return type is same as binding parameter type
    \nOn success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. \n\nOn failure the sticky session is kept alive." + "@Core.LongDescription": "Signature:\n\n- Binding parameter is type of annotated entity set\n\n- No non-binding parameters\n\n- Return type is same as binding parameter type \n\nOn success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. \n\nOn failure the sticky session is kept alive." }, "DiscardAction": { "$Type": "Core.SimpleIdentifier", "@Core.Description": "Action import for an unbound action that discards all changes and terminates the sticky session", - "@Core.LongDescription": "Signature:\n
    • No parameters
      • \n
    • No return type
    \nIf called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. \n\nIf called outside of a sticky session the action fails and does not initiate a session." + "@Core.LongDescription": "Signature:\n\n- No parameters\n\n- No return type \n\nIf called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. \n\nIf called outside of a sticky session the action fails and does not initiate a session." } } } diff --git a/vocabularies/Session.md b/vocabularies/Session.md index cdf2525d..f265822e 100644 --- a/vocabularies/Session.md +++ b/vocabularies/Session.md @@ -51,8 +51,8 @@ Actions for managing data modification within a sticky session Property|Type|Description :-------|:---|:---------- -[NewAction](./Session.xml#L88:~:text=Signature:
    • Binding parameter is collection of type of annotated entity set
    • No non-binding parameters
    • No return type
    If called within a sticky session the sticky session continues.
    Otherwise:
    • On success this action initiates a sticky session.
    • On failure no sticky session is initiated.
    -[AdditionalNewActions](./Session.xml#L102:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters -[EditAction](./Session.xml#L107:~:text=Signature:
    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise:
    • On success this action returns the targeted entity and initiates a sticky session.
    • On failure no sticky session is initiated.
    -[SaveAction](./Session.xml#L121:~:text=Signature:
    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. -[DiscardAction](./Session.xml#L133:~:text=Signature:
    • No parameters
    • No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. +[NewAction](./Session.xml#L88:~:text=Signature:
    - Binding parameter is collection of type of annotated entity set
    - No non-binding parameters
    - No return type
    If called within a sticky session the sticky session continues.
    Otherwise:
    - On success this action initiates a sticky session.
    - On failure no sticky session is initiated. +[AdditionalNewActions](./Session.xml#L108:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters +[EditAction](./Session.xml#L113:~:text=Signature:
    - Binding parameter is type of annotated entity set
    - No non-binding parameters
    - Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise:
    - On success this action returns the targeted entity and initiates a sticky session.
    - On failure no sticky session is initiated. +[SaveAction](./Session.xml#L133:~:text=Signature:
    - Binding parameter is type of annotated entity set
    - No non-binding parameters
    - Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. +[DiscardAction](./Session.xml#L149:~:text=Signature:
    - No parameters
    - No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. diff --git a/vocabularies/Session.xml b/vocabularies/Session.xml index eae4c293..fff02d02 100644 --- a/vocabularies/Session.xml +++ b/vocabularies/Session.xml @@ -89,14 +89,20 @@ combined as one UI app. Signature: -<ul><li>Binding parameter is collection of type of annotated entity set</li> -<li>No non-binding parameters</li> -<li>No return type </li></ul> + +- Binding parameter is collection of type of annotated entity set + +- No non-binding parameters + +- No return type + If called within a sticky session the sticky session continues. Otherwise: -<ul><li>On success this action initiates a sticky session.</li> -<li>On failure no sticky session is initiated.</li></ul> + +- On success this action initiates a sticky session. + +- On failure no sticky session is initiated. @@ -108,23 +114,33 @@ Otherwise: Signature: -<ul><li>Binding parameter is type of annotated entity set</li> -<li>No non-binding parameters</li> -<li>Return type is same as binding parameter type</li></ul> + +- Binding parameter is type of annotated entity set + +- No non-binding parameters + +- Return type is same as binding parameter type + If called within a sticky session the sticky session continues. Otherwise: -<ul><li>On success this action returns the targeted entity and initiates a sticky session.</li> -<li>On failure no sticky session is initiated.</li></ul> + +- On success this action returns the targeted entity and initiates a sticky session. + +- On failure no sticky session is initiated. Signature: -<ul><li>Binding parameter is type of annotated entity set</li> -<li>No non-binding parameters</li> -<li>Return type is same as binding parameter type</li></ul> + +- Binding parameter is type of annotated entity set + +- No non-binding parameters + +- Return type is same as binding parameter type + On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. On failure the sticky session is kept alive. @@ -134,8 +150,11 @@ On failure the sticky session is kept alive. Signature: -<ul><li>No parameters</li> -<li>No return type</li></ul> + +- No parameters + +- No return type + If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. If called outside of a sticky session the action fails and does not initiate a session. From 157fc79db9dddbbdf7e804918cae777a3382f154 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 16:14:54 +0200 Subject: [PATCH 14/22] typographics --- .github/workflows/nodejs.yml | 4 + vocabularies/Common.json | 2 +- vocabularies/Common.md | 304 ++++++++++++++++----------------- vocabularies/Common.xml | 7 - vocabularies/DirectEdit.json | 2 +- vocabularies/DirectEdit.md | 2 +- vocabularies/DirectEdit.xml | 7 - vocabularies/PersonalData.json | 2 +- vocabularies/PersonalData.md | 2 +- vocabularies/PersonalData.xml | 4 - vocabularies/Session.json | 8 +- vocabularies/Session.md | 10 +- vocabularies/Session.xml | 15 -- 13 files changed, 170 insertions(+), 199 deletions(-) diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 6dac03b5..9aa9c4ab 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -18,6 +18,10 @@ jobs: uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} + - name: Setup pandoc + uses: nikeee/setup-pandoc@v1 + with: + pandoc-version: 3.1.12.2 - name: npm install, build, and test run: | npm ci diff --git a/vocabularies/Common.json b/vocabularies/Common.json index f0834322..7968625d 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -376,7 +376,7 @@ "$Collection": true, "$Type": "Edm.ComplexType", "@Core.Description": "Collection of end-user messages", - "@Core.LongDescription": "The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.\n\nThe minimum structure is\n\n- `code: Edm.String`\n\n- `message: Edm.String`\n\n- `target: Edm.String nullable`\n\n- `additionalTargets: Collection(Edm.String)`\n\n- `transition: Edm.Boolean`\n\n- `numericSeverity: Edm.Byte`\n\n- `longtextUrl: Edm.String nullable`\n " + "@Core.LongDescription": "The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.\n\nThe minimum structure is\n- `code: Edm.String`\n- `message: Edm.String`\n- `target: Edm.String nullable`\n- `additionalTargets: Collection(Edm.String)`\n- `transition: Edm.Boolean`\n- `numericSeverity: Edm.Byte`\n- `longtextUrl: Edm.String nullable`\n " }, "additionalTargets": { "$Kind": "Term", diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 7501b9d5..b45b7833 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -46,71 +46,71 @@ Term|Type|Description [Timestamp](./Common.xml#L457:~:text=... [TransactionId](./Common.xml#L462:~:text=... [ErrorResolution](./Common.xml#L467:~:text=Hints for resolving this error -[Messages](./Common.xml#L485:~:text=Collection of end-user messages
    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
    The minimum structure is
    - `code: Edm.String`
    - `message: Edm.String`
    - `target: Edm.String nullable`
    - `additionalTargets: Collection(Edm.String)`
    - `transition: Edm.Boolean`
    - `numericSeverity: Edm.Byte`
    - `longtextUrl: Edm.String nullable` -[additionalTargets](./Common.xml#L508:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[longtextUrl](./Common.xml#L514:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[numericSeverity](./Common.xml#L520:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[MaximumNumericMessageSeverity](./Common.xml#L525:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
    This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) -[IsActionCritical](./Common.xml#L554:~:text=Criticality of the function or action to enforce a warning or similar before it's executed -[Attributes](./Common.xml#L558:~:text=Attributes related to this property, which may occur in denormalized entity types -[RelatedRecursiveHierarchy](./Common.xml#L562:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. -[Interval](./Common.xml#L566:~:text=An interval with lower and upper boundaries described by two properties -[ResultContext](./Common.xml#L589:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. -[SAPObjectNodeType](./Common.xml#L597:~:text=The SAP Object Node Type represented by the annotated entity type
    SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. -[Composition](./Common.xml#L613:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
    The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. -[SAPObjectNodeTypeReference](./Common.xml#L622:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
    The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. -[IsNaturalPerson](./Common.xml#L630:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person -[ValueList](./Common.xml#L636:~:text=Specifies how to get a list of acceptable values for a property or parameter
    The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. -[ValueListRelevantQualifiers](./Common.xml#L710:~:text=List of qualifiers of relevant ValueList annotations
    The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. -[ValueListWithFixedValues](./Common.xml#L715:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
    Can be annotated with:
    • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
    -[ValueListShowValuesImmediately](./Common.xml#L724:~:text=A value list with a very small number of fixed values, can decide to show all values immediately -[ValueListForValidation](./Common.xml#L729:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
    An empty string identifies the ValueList or ValueListMapping without a qualifier. -[ValueListReferences](./Common.xml#L734:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property -[ValueListMapping](./Common.xml#L739:~:text=Specifies the mapping between data service properties and value list properties
    The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. -[IsCalendarYear](./Common.xml#L851:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) -[IsCalendarHalfyear](./Common.xml#L860:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] -[IsCalendarQuarter](./Common.xml#L869:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsCalendarMonth](./Common.xml#L878:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] -[IsCalendarWeek](./Common.xml#L887:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsDayOfCalendarMonth](./Common.xml#L896:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. -[IsDayOfCalendarYear](./Common.xml#L904:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. -[IsCalendarYearHalfyear](./Common.xml#L912:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] -[IsCalendarYearQuarter](./Common.xml#L922:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] -[IsCalendarYearMonth](./Common.xml#L932:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) -[IsCalendarYearWeek](./Common.xml#L943:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsCalendarDate](./Common.xml#L953:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. -[IsFiscalYear](./Common.xml#L970:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} -[IsFiscalPeriod](./Common.xml#L979:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} -[IsFiscalYearPeriod](./Common.xml#L988:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) -[IsFiscalQuarter](./Common.xml#L998:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsFiscalYearQuarter](./Common.xml#L1006:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] -[IsFiscalWeek](./Common.xml#L1015:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsFiscalYearWeek](./Common.xml#L1023:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsDayOfFiscalYear](./Common.xml#L1032:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. -[IsFiscalYearVariant](./Common.xml#L1039:~:text=Property encodes a fiscal year variant -[MutuallyExclusiveTerm](./Common.xml#L1047:~:text=Only one term of the group identified with the Qualifier attribute can be applied -[DraftRoot](./Common.xml#L1053:~:text=Root entities of business documents that support the draft pattern -[DraftNode](./Common.xml#L1094:~:text=Entities in this set are parts of business documents that support the draft pattern -[DraftActivationVia](./Common.xml#L1116:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets -[EditableFieldFor](./Common.xml#L1120:~:text=The annotated property is an editable field for the referenced key property -[SemanticKey](./Common.xml#L1150:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity -[SideEffects](./Common.xml#L1154:~:text=Describes side-effects of modification operations -[DefaultValuesFunction](./Common.xml#L1237:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
    The default values function must have a bound overload whose binding parameter type matches the annotation target
    - for an entity set: collection of entity type of entity set
    - for a navigation property: identical to the type of the navigation property (single- or collection-valued)
    - for a bound action/function: identical to the binding parameter type of the annotated action/function
    In addition the overload can have non-binding parameters for values that the user has already entered:
    - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
    - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
    The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
    - the properties of the entity to create, or
    - the parameters of the action or function to call -[DerivedDefaultValue](./Common.xml#L1266:~:text=Function import to derive a default value for the property from a given context.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[FilterDefaultValue](./Common.xml#L1287:~:text=A default value for the property to be used in filter expressions. -[FilterDefaultValueHigh](./Common.xml#L1291:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. -[DerivedFilterDefaultValue](./Common.xml#L1296:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[SortOrder](./Common.xml#L1320:~:text=List of sort criteria
    The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. -[RecursiveHierarchy](./Common.xml#L1376:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead -[CreatedAt](./Common.xml#L1424:~:text=Creation timestamp -[CreatedBy](./Common.xml#L1428:~:text=First editor -[ChangedAt](./Common.xml#L1432:~:text=Last modification timestamp -[ChangedBy](./Common.xml#L1436:~:text=Last editor -[OriginalProtocolVersion](./Common.xml#L1448:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` -[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1453:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
    TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ -[mediaUploadLink](./Common.xml#L1459:~:text=URL for uploading new media content to a Document Management Service
    In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. -[PrimitivePropertyPath](./Common.xml#L1474:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property -[WebSocketBaseURL](./Common.xml#L1479:~:text=Base URL for WebSocket connections +[Messages](./Common.xml#L485:~:text=Collection of end-user messages

    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.

    The minimum structure is

    • code: Edm.String
    • message: Edm.String
    • target: Edm.String nullable
    • additionalTargets: Collection(Edm.String)
    • transition: Edm.Boolean
    • numericSeverity: Edm.Byte
    • longtextUrl: Edm.String nullable
    +[additionalTargets](./Common.xml#L501:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[longtextUrl](./Common.xml#L507:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[numericSeverity](./Common.xml#L513:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[MaximumNumericMessageSeverity](./Common.xml#L518:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
    This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) +[IsActionCritical](./Common.xml#L547:~:text=Criticality of the function or action to enforce a warning or similar before it's executed +[Attributes](./Common.xml#L551:~:text=Attributes related to this property, which may occur in denormalized entity types +[RelatedRecursiveHierarchy](./Common.xml#L555:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. +[Interval](./Common.xml#L559:~:text=An interval with lower and upper boundaries described by two properties +[ResultContext](./Common.xml#L582:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. +[SAPObjectNodeType](./Common.xml#L590:~:text=The SAP Object Node Type represented by the annotated entity type
    SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. +[Composition](./Common.xml#L606:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
    The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. +[SAPObjectNodeTypeReference](./Common.xml#L615:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
    The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. +[IsNaturalPerson](./Common.xml#L623:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person +[ValueList](./Common.xml#L629:~:text=Specifies how to get a list of acceptable values for a property or parameter
    The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. +[ValueListRelevantQualifiers](./Common.xml#L703:~:text=List of qualifiers of relevant ValueList annotations
    The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. +[ValueListWithFixedValues](./Common.xml#L708:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
    Can be annotated with:
    • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
    +[ValueListShowValuesImmediately](./Common.xml#L717:~:text=A value list with a very small number of fixed values, can decide to show all values immediately +[ValueListForValidation](./Common.xml#L722:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
    An empty string identifies the ValueList or ValueListMapping without a qualifier. +[ValueListReferences](./Common.xml#L727:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property +[ValueListMapping](./Common.xml#L732:~:text=Specifies the mapping between data service properties and value list properties
    The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. +[IsCalendarYear](./Common.xml#L844:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) +[IsCalendarHalfyear](./Common.xml#L853:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] +[IsCalendarQuarter](./Common.xml#L862:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsCalendarMonth](./Common.xml#L871:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] +[IsCalendarWeek](./Common.xml#L880:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsDayOfCalendarMonth](./Common.xml#L889:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. +[IsDayOfCalendarYear](./Common.xml#L897:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. +[IsCalendarYearHalfyear](./Common.xml#L905:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] +[IsCalendarYearQuarter](./Common.xml#L915:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] +[IsCalendarYearMonth](./Common.xml#L925:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) +[IsCalendarYearWeek](./Common.xml#L936:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsCalendarDate](./Common.xml#L946:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. +[IsFiscalYear](./Common.xml#L963:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} +[IsFiscalPeriod](./Common.xml#L972:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} +[IsFiscalYearPeriod](./Common.xml#L981:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) +[IsFiscalQuarter](./Common.xml#L991:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsFiscalYearQuarter](./Common.xml#L999:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] +[IsFiscalWeek](./Common.xml#L1008:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsFiscalYearWeek](./Common.xml#L1016:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsDayOfFiscalYear](./Common.xml#L1025:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. +[IsFiscalYearVariant](./Common.xml#L1032:~:text=Property encodes a fiscal year variant +[MutuallyExclusiveTerm](./Common.xml#L1040:~:text=Only one term of the group identified with the Qualifier attribute can be applied +[DraftRoot](./Common.xml#L1046:~:text=Root entities of business documents that support the draft pattern +[DraftNode](./Common.xml#L1087:~:text=Entities in this set are parts of business documents that support the draft pattern +[DraftActivationVia](./Common.xml#L1109:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets +[EditableFieldFor](./Common.xml#L1113:~:text=The annotated property is an editable field for the referenced key property +[SemanticKey](./Common.xml#L1143:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity +[SideEffects](./Common.xml#L1147:~:text=Describes side-effects of modification operations +[DefaultValuesFunction](./Common.xml#L1230:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
    The default values function must have a bound overload whose binding parameter type matches the annotation target
    - for an entity set: collection of entity type of entity set
    - for a navigation property: identical to the type of the navigation property (single- or collection-valued)
    - for a bound action/function: identical to the binding parameter type of the annotated action/function
    In addition the overload can have non-binding parameters for values that the user has already entered:
    - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
    - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
    The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
    - the properties of the entity to create, or
    - the parameters of the action or function to call +[DerivedDefaultValue](./Common.xml#L1259:~:text=Function import to derive a default value for the property from a given context.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[FilterDefaultValue](./Common.xml#L1280:~:text=A default value for the property to be used in filter expressions. +[FilterDefaultValueHigh](./Common.xml#L1284:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. +[DerivedFilterDefaultValue](./Common.xml#L1289:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[SortOrder](./Common.xml#L1313:~:text=List of sort criteria
    The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. +[RecursiveHierarchy](./Common.xml#L1369:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead +[CreatedAt](./Common.xml#L1417:~:text=Creation timestamp +[CreatedBy](./Common.xml#L1421:~:text=First editor +[ChangedAt](./Common.xml#L1425:~:text=Last modification timestamp +[ChangedBy](./Common.xml#L1429:~:text=Last editor +[OriginalProtocolVersion](./Common.xml#L1441:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` +[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1446:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
    TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ +[mediaUploadLink](./Common.xml#L1452:~:text=URL for uploading new media content to a Document Management Service
    In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. +[PrimitivePropertyPath](./Common.xml#L1467:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property +[WebSocketBaseURL](./Common.xml#L1472:~:text=Base URL for WebSocket connections ## [TextFormatType](./Common.xml#L120:~:text= -## [NumericMessageSeverityType](./Common.xml#L530:~:text= -## [IntervalType](./Common.xml#L569:~:text= -## [SAPObjectNodeTypeType](./Common.xml#L605:~:text= -## [ValueListType](./Common.xml#L640:~:text=The value of the target property is used as the search expression instead of in $filter -[FetchValues](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath -[SelectionVariantQualifier](./Common.xml#L685:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L689:~:text=The value of the target property is used as the search expression instead of in $filter +[FetchValues](./Common.xml#L671:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath +[SelectionVariantQualifier](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L682:~:text= -## [FetchValuesType](./Common.xml#L694:~:text= -## [ValueListMappingType](./Common.xml#L743:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation -[SelectionVariantQualifier](./Common.xml#L766:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L770:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation +[SelectionVariantQualifier](./Common.xml#L759:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L763:~:text= -## [*ValueListParameter*](./Common.xml#L775:~:text= -## [ValueListParameterIn](./Common.xml#L780:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators -[InitialValueIsSignificant](./Common.xml#L785:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators +[InitialValueIsSignificant](./Common.xml#L778:~:text= -## [ValueListParameterConstant](./Common.xml#L789:~:text= -## [ValueListParameterConstants](./Common.xml#L798:~:text=An empty list means a vacuous filter condition +[*ValueListProperty*](./Common.xml#L769:~:text=An empty list means a vacuous filter condition -## [ValueListParameterInOut](./Common.xml#L807:~:text= -## [ValueListParameterOut](./Common.xml#L820:~:text= -## [ValueListParameterDisplayOnly](./Common.xml#L830:~:text= -## [ValueListParameterFilterOnly](./Common.xml#L838:~:text= -## [DraftRootType](./Common.xml#L1058:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. -[AdditionalNewActions](./Common.xml#L1073:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. -[ShareAction](./Common.xml#L1078:~:text=The action is bound to the draft document root node and has the following signature:
    - `Users`: collection of structure with properties
      - `UserID` of type `String` and
      - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
    It restricts access to the listed users in their specified roles. +[*PreparationAction*](./Common.xml#L1093:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. +[AdditionalNewActions](./Common.xml#L1066:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. +[ShareAction](./Common.xml#L1071:~:text=The action is bound to the draft document root node and has the following signature:
    - `Users`: collection of structure with properties
      - `UserID` of type `String` and
      - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
    It restricts access to the listed users in their specified roles. -## [DraftNodeType](./Common.xml#L1099:~:text= -## [SimpleIdentifier](./Common.xml#L1124:~:text= -## [QualifiedName](./Common.xml#L1136:~:text= -## [ActionOverload](./Common.xml#L1141:~:text= -## [SideEffectsType](./Common.xml#L1157:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path -[TargetEntities](./Common.xml#L1179:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. -[Discretionary](./Common.xml#L1197:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. +[SourceProperties](./Common.xml#L1162:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path +[TargetEntities](./Common.xml#L1172:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. +[Discretionary](./Common.xml#L1190:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. -## [EffectType](./Common.xml#L1203:~:text= -## [SortOrderType](./Common.xml#L1328:~:text=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:
    • [AggregatedProperty](Analytics.md#AggregatedProperty)
    • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
    -[Descending](./Common.xml#L1356:~:text=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:
    • [AggregatedProperty](Analytics.md#AggregatedProperty)
    • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
    +[Descending](./Common.xml#L1349:~:text= -## [RecursiveHierarchyType](./Common.xml#L1389:~:text= -## [UserID](./Common.xml#L1440:~:text=The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure. The minimum structure is - - `code: Edm.String` - - `message: Edm.String` - - `target: Edm.String nullable` - - `additionalTargets: Collection(Edm.String)` - - `transition: Edm.Boolean` - - `numericSeverity: Edm.Byte` - - `longtextUrl: Edm.String nullable`     diff --git a/vocabularies/DirectEdit.json b/vocabularies/DirectEdit.json index b7792c35..ce6bd18d 100644 --- a/vocabularies/DirectEdit.json +++ b/vocabularies/DirectEdit.json @@ -38,7 +38,7 @@ }, "CalculationFunction": { "$Type": "Common.QualifiedName", - "@Core.Description": "The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:\n\n- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\n or cast-compatible: the qualifier of the `SideEffects` annotation\n\n- `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property\n\n- `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it\n\nThe **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it,\nit can be the same type as for `Data`.\n\nStructure-compatible means:\n\n- each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, \n\n- each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property\n \n- it may contain properties without a corresponding property in the entity type\n\n- it may omit properties of the entity type" + "@Core.Description": "The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:\n- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier)\n or cast-compatible: the qualifier of the `SideEffects` annotation\n- `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property\n- `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it\n\nThe **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it,\nit can be the same type as for `Data`.\n\nStructure-compatible means:\n- each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, \n- each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property\n- it may contain properties without a corresponding property in the entity type\n- it may omit properties of the entity type" } } } diff --git a/vocabularies/DirectEdit.md b/vocabularies/DirectEdit.md index 54d99cd3..940f2468 100644 --- a/vocabularies/DirectEdit.md +++ b/vocabularies/DirectEdit.md @@ -19,4 +19,4 @@ After a change to a property whose path is contained in `Triggers`, the client s Property|Type|Description :-------|:---|:---------- [Triggers](./DirectEdit.xml#L48:~:text=- `Qualifier` of type [`Core.SimpleIdentifier`](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#SimpleIdentifier) or cast-compatible: the qualifier of the `SideEffects` annotation
    - `Trigger` of type `Edm.String`: the trigger of the side-effects determination, see `Triggers` property
    - `Data` of either the entity type of the annotated entity set or a complex type that is structure-compatible with it
    The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means:
    - each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
    - each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - it may contain properties without a corresponding property in the entity type
    - it may omit properties of the entity type +[CalculationFunction](./DirectEdit.xml#L52:~:text=The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:

    • Qualifier of type Core.SimpleIdentifier or cast-compatible: the qualifier of the SideEffects annotation
    • Trigger of type Edm.String: the trigger of the side-effects determination, see Triggers property
    • Data of either the entity type of the annotated entity set or a complex type that is structure-compatible with it

    The return type of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for Data.

    Structure-compatible means:

    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • it may contain properties without a corresponding property in the entity type
    • it may omit properties of the entity type
    diff --git a/vocabularies/DirectEdit.xml b/vocabularies/DirectEdit.xml index 36a995d0..78417217 100644 --- a/vocabularies/DirectEdit.xml +++ b/vocabularies/DirectEdit.xml @@ -51,25 +51,18 @@     diff --git a/vocabularies/PersonalData.json b/vocabularies/PersonalData.json index e02d7a05..c8ae689f 100644 --- a/vocabularies/PersonalData.json +++ b/vocabularies/PersonalData.json @@ -136,7 +136,7 @@ "$DefaultValue": true, "$AppliesTo": ["Property"], "@Core.Description": "Property contains potentially sensitive personal data", - "@Core.LongDescription": "Sensitive data is a colloquial term usually including the following data:\n\n- Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation\n\n- Personal data subject to professional secrecy\n\n- Personal data relating to criminal or administrative offences\n\n- Personal data concerning bank or credit card accounts\n\nSee also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en)" + "@Core.LongDescription": "Sensitive data is a colloquial term usually including the following data:\n- Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation\n- Personal data subject to professional secrecy\n- Personal data relating to criminal or administrative offences\n- Personal data concerning bank or credit card accounts\n\nSee also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en)" } } } diff --git a/vocabularies/PersonalData.md b/vocabularies/PersonalData.md index b70c9fd6..87766e81 100644 --- a/vocabularies/PersonalData.md +++ b/vocabularies/PersonalData.md @@ -32,7 +32,7 @@ Term|Type|Description [DataSubjectRoleDescription](./PersonalData.xml#L68:~:text=Language-dependent description of the role of the data subjects in this set (e.g. employee, customer)
    Values are application-specific. Can be a static value or a `Path` expression If the role varies per entity [FieldSemantics](./PersonalData.xml#L111:~:text=Primary meaning of the personal data contained in the annotated property
    Changes to values of annotated properties are tracked in the audit log. Use this annotation also on fields that are already marked as contact or address data. [IsPotentiallyPersonal](./PersonalData.xml#L195:~:text=Property contains potentially personal data
    Personal data is information relating to an identified or identifiable natural person (data subject).
    Note: properties annotated with [`FieldSemantics`](#FieldSemantics) need not be additionally annotated with this term.
    See also: [What is personal data?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/what-personal-data_en) -[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data:
    - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    - Personal data subject to professional secrecy
    - Personal data relating to criminal or administrative offences
    - Personal data concerning bank or credit card accounts
    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) +[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data

    Sensitive data is a colloquial term usually including the following data:

    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    • Personal data subject to professional secrecy
    • Personal data relating to criminal or administrative offences
    • Personal data concerning bank or credit card accounts

    See also: What personal data is considered sensitive?

    ## [EntitySemanticsType](./PersonalData.xml#L76:~:text= Sensitive data is a colloquial term usually including the following data: - - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation - - Personal data subject to professional secrecy - - Personal data relating to criminal or administrative offences - - Personal data concerning bank or credit card accounts See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) diff --git a/vocabularies/Session.json b/vocabularies/Session.json index 61d5f12c..8f20dbdf 100644 --- a/vocabularies/Session.json +++ b/vocabularies/Session.json @@ -38,7 +38,7 @@ "NewAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that initiates a sticky session for creating new entities in the targeted entity set or collection", - "@Core.LongDescription": "Signature:\n\n- Binding parameter is collection of type of annotated entity set\n\n- No non-binding parameters\n\n- No return type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n\n- On success this action initiates a sticky session.\n\n- On failure no sticky session is initiated." + "@Core.LongDescription": "Signature:\n- Binding parameter is collection of type of annotated entity set\n- No non-binding parameters\n- No return type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n- On success this action initiates a sticky session.\n- On failure no sticky session is initiated." }, "AdditionalNewActions": { "$Collection": true, @@ -50,17 +50,17 @@ "EditAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that initiates a sticky session for editing the targeted entity", - "@Core.LongDescription": "Signature:\n\n- Binding parameter is type of annotated entity set\n\n- No non-binding parameters\n\n- Return type is same as binding parameter type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n\n- On success this action returns the targeted entity and initiates a sticky session.\n\n- On failure no sticky session is initiated." + "@Core.LongDescription": "Signature:\n- Binding parameter is type of annotated entity set\n- No non-binding parameters\n- Return type is same as binding parameter type \n\nIf called within a sticky session the sticky session continues. \n\nOtherwise:\n- On success this action returns the targeted entity and initiates a sticky session.\n- On failure no sticky session is initiated." }, "SaveAction": { "$Type": "Common.QualifiedName", "@Core.Description": "Bound action that saves a new or edited entity", - "@Core.LongDescription": "Signature:\n\n- Binding parameter is type of annotated entity set\n\n- No non-binding parameters\n\n- Return type is same as binding parameter type \n\nOn success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. \n\nOn failure the sticky session is kept alive." + "@Core.LongDescription": "Signature:\n- Binding parameter is type of annotated entity set\n- No non-binding parameters\n- Return type is same as binding parameter type \n\nOn success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. \n\nOn failure the sticky session is kept alive." }, "DiscardAction": { "$Type": "Core.SimpleIdentifier", "@Core.Description": "Action import for an unbound action that discards all changes and terminates the sticky session", - "@Core.LongDescription": "Signature:\n\n- No parameters\n\n- No return type \n\nIf called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. \n\nIf called outside of a sticky session the action fails and does not initiate a session." + "@Core.LongDescription": "Signature:\n- No parameters\n- No return type \n\nIf called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. \n\nIf called outside of a sticky session the action fails and does not initiate a session." } } } diff --git a/vocabularies/Session.md b/vocabularies/Session.md index f265822e..800440d0 100644 --- a/vocabularies/Session.md +++ b/vocabularies/Session.md @@ -51,8 +51,8 @@ Actions for managing data modification within a sticky session Property|Type|Description :-------|:---|:---------- -[NewAction](./Session.xml#L88:~:text=Signature:
    - Binding parameter is collection of type of annotated entity set
    - No non-binding parameters
    - No return type
    If called within a sticky session the sticky session continues.
    Otherwise:
    - On success this action initiates a sticky session.
    - On failure no sticky session is initiated. -[AdditionalNewActions](./Session.xml#L108:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters -[EditAction](./Session.xml#L113:~:text=Signature:
    - Binding parameter is type of annotated entity set
    - No non-binding parameters
    - Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise:
    - On success this action returns the targeted entity and initiates a sticky session.
    - On failure no sticky session is initiated. -[SaveAction](./Session.xml#L133:~:text=Signature:
    - Binding parameter is type of annotated entity set
    - No non-binding parameters
    - Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. -[DiscardAction](./Session.xml#L149:~:text=Signature:
    - No parameters
    - No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. +[NewAction](./Session.xml#L88:~:text=

    Signature:

    • Binding parameter is collection of type of annotated entity set
    • No non-binding parameters
    • No return type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action initiates a sticky session.
    • On failure no sticky session is initiated.
    +[AdditionalNewActions](./Session.xml#L103:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters +[EditAction](./Session.xml#L108:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action returns the targeted entity and initiates a sticky session.
    • On failure no sticky session is initiated.
    +[SaveAction](./Session.xml#L123:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.

    On failure the sticky session is kept alive.

    +[DiscardAction](./Session.xml#L136:~:text=

    Signature:

    • No parameters
    • No return type

    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.

    If called outside of a sticky session the action fails and does not initiate a session.

    diff --git a/vocabularies/Session.xml b/vocabularies/Session.xml index fff02d02..b909bf50 100644 --- a/vocabularies/Session.xml +++ b/vocabularies/Session.xml @@ -89,19 +89,14 @@ combined as one UI app. Signature: - - Binding parameter is collection of type of annotated entity set - - No non-binding parameters - - No return type If called within a sticky session the sticky session continues. Otherwise: - - On success this action initiates a sticky session. - - On failure no sticky session is initiated. @@ -114,19 +109,14 @@ Otherwise: Signature: - - Binding parameter is type of annotated entity set - - No non-binding parameters - - Return type is same as binding parameter type If called within a sticky session the sticky session continues. Otherwise: - - On success this action returns the targeted entity and initiates a sticky session. - - On failure no sticky session is initiated. @@ -134,11 +124,8 @@ Otherwise: Signature: - - Binding parameter is type of annotated entity set - - No non-binding parameters - - Return type is same as binding parameter type On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved. @@ -150,9 +137,7 @@ On failure the sticky session is kept alive. Signature: - - No parameters - - No return type If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails. From 83002131f74c7eff7b611ec2faf65778a6d4f574 Mon Sep 17 00:00:00 2001 From: HeikoTheissen Date: Thu, 11 Apr 2024 14:15:48 +0000 Subject: [PATCH 15/22] auto-refreshed --- vocabularies/Common.md | 2 +- vocabularies/DirectEdit.md | 2 +- vocabularies/PersonalData.md | 2 +- vocabularies/Session.md | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/vocabularies/Common.md b/vocabularies/Common.md index b45b7833..026f7e6b 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -46,7 +46,7 @@ Term|Type|Description [Timestamp](./Common.xml#L457:~:text=... [TransactionId](./Common.xml#L462:~:text=... [ErrorResolution](./Common.xml#L467:~:text=Hints for resolving this error -[Messages](./Common.xml#L485:~:text=Collection of end-user messages

    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.

    The minimum structure is

    • code: Edm.String
    • message: Edm.String
    • target: Edm.String nullable
    • additionalTargets: Collection(Edm.String)
    • transition: Edm.Boolean
    • numericSeverity: Edm.Byte
    • longtextUrl: Edm.String nullable
    +[Messages](./Common.xml#L485:~:text=Collection of end-user messages
    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
    The minimum structure is - `code: Edm.String` - `message: Edm.String` - `target: Edm.String nullable` - `additionalTargets: Collection(Edm.String)` - `transition: Edm.Boolean` - `numericSeverity: Edm.Byte` - `longtextUrl: Edm.String nullable` [additionalTargets](./Common.xml#L501:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response [longtextUrl](./Common.xml#L507:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response [numericSeverity](./Common.xml#L513:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response diff --git a/vocabularies/DirectEdit.md b/vocabularies/DirectEdit.md index 940f2468..8ab4b473 100644 --- a/vocabularies/DirectEdit.md +++ b/vocabularies/DirectEdit.md @@ -19,4 +19,4 @@ After a change to a property whose path is contained in `Triggers`, the client s Property|Type|Description :-------|:---|:---------- [Triggers](./DirectEdit.xml#L48:~:text=The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:

    • Qualifier of type Core.SimpleIdentifier or cast-compatible: the qualifier of the SideEffects annotation
    • Trigger of type Edm.String: the trigger of the side-effects determination, see Triggers property
    • Data of either the entity type of the annotated entity set or a complex type that is structure-compatible with it

    The return type of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for Data.

    Structure-compatible means:

    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • it may contain properties without a corresponding property in the entity type
    • it may omit properties of the entity type
    +[CalculationFunction](./DirectEdit.xml#L52:~:text=The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means: - each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, - each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - it may contain properties without a corresponding property in the entity type - it may omit properties of the entity type diff --git a/vocabularies/PersonalData.md b/vocabularies/PersonalData.md index 87766e81..735bada6 100644 --- a/vocabularies/PersonalData.md +++ b/vocabularies/PersonalData.md @@ -32,7 +32,7 @@ Term|Type|Description [DataSubjectRoleDescription](./PersonalData.xml#L68:~:text=Language-dependent description of the role of the data subjects in this set (e.g. employee, customer)
    Values are application-specific. Can be a static value or a `Path` expression If the role varies per entity [FieldSemantics](./PersonalData.xml#L111:~:text=Primary meaning of the personal data contained in the annotated property
    Changes to values of annotated properties are tracked in the audit log. Use this annotation also on fields that are already marked as contact or address data. [IsPotentiallyPersonal](./PersonalData.xml#L195:~:text=Property contains potentially personal data
    Personal data is information relating to an identified or identifiable natural person (data subject).
    Note: properties annotated with [`FieldSemantics`](#FieldSemantics) need not be additionally annotated with this term.
    See also: [What is personal data?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/what-personal-data_en) -[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data

    Sensitive data is a colloquial term usually including the following data:

    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    • Personal data subject to professional secrecy
    • Personal data relating to criminal or administrative offences
    • Personal data concerning bank or credit card accounts

    See also: What personal data is considered sensitive?

    +[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data: - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation - Personal data subject to professional secrecy - Personal data relating to criminal or administrative offences - Personal data concerning bank or credit card accounts
    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) ## [EntitySemanticsType](./PersonalData.xml#L76:~:text=

    Signature:

    • Binding parameter is collection of type of annotated entity set
    • No non-binding parameters
    • No return type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action initiates a sticky session.
    • On failure no sticky session is initiated.
    +[NewAction](./Session.xml#L88:~:text=Signature: - Binding parameter is collection of type of annotated entity set - No non-binding parameters - No return type
    If called within a sticky session the sticky session continues.
    Otherwise: - On success this action initiates a sticky session. - On failure no sticky session is initiated. [AdditionalNewActions](./Session.xml#L103:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters -[EditAction](./Session.xml#L108:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action returns the targeted entity and initiates a sticky session.
    • On failure no sticky session is initiated.
    -[SaveAction](./Session.xml#L123:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.

    On failure the sticky session is kept alive.

    -[DiscardAction](./Session.xml#L136:~:text=

    Signature:

    • No parameters
    • No return type

    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.

    If called outside of a sticky session the action fails and does not initiate a session.

    +[EditAction](./Session.xml#L108:~:text=Signature: - Binding parameter is type of annotated entity set - No non-binding parameters - Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise: - On success this action returns the targeted entity and initiates a sticky session. - On failure no sticky session is initiated. +[SaveAction](./Session.xml#L123:~:text=Signature: - Binding parameter is type of annotated entity set - No non-binding parameters - Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. +[DiscardAction](./Session.xml#L136:~:text=Signature: - No parameters - No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. From 7e58082cf621f91885699ec27e553db4de15741c Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 16:31:28 +0200 Subject: [PATCH 16/22] No more < --- vocabularies/Common.json | 2 +- vocabularies/Common.md | 342 ++++++++++++++++++------------------ vocabularies/Common.xml | 19 +- vocabularies/Hierarchy.json | 4 +- vocabularies/Hierarchy.md | 70 ++++---- vocabularies/Hierarchy.xml | 21 ++- vocabularies/UI.json | 2 +- vocabularies/UI.md | 2 +- vocabularies/UI.xml | 6 +- 9 files changed, 236 insertions(+), 232 deletions(-) diff --git a/vocabularies/Common.json b/vocabularies/Common.json index 7968625d..b0ea507f 100644 --- a/vocabularies/Common.json +++ b/vocabularies/Common.json @@ -308,7 +308,7 @@ "@Core.LongDescription": "When changes are requested, the value of this annotation in the before-image or after-image\n of the request plays a role. These may differ if the value is given dynamically in the metadata.", "Mandatory": 7, "Mandatory@Core.Description": "Property is mandatory from a business perspective", - "Mandatory@Core.LongDescription": "A request that\n
    - sets the property to null or an empty value or\n
    - creates a non-[draft](#DraftRoot) entity and omits the property or\n
    - activates a draft entity while the property is null or empty\n
    fails entirely if this annotation is `Mandatory` in the after-image of the request.\n The empty string is an empty value. Service-specific rules may consider other values, also\n of non-string type, empty.\n Values in draft entities are never considered empty.\n Mandatory properties SHOULD be decorated in the UI with an asterisk.\n Null or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md).", + "Mandatory@Core.LongDescription": "A request that\n- sets the property to null or an empty value or\n- creates a non-[draft](#DraftRoot) entity and omits the property or\n- activates a draft entity while the property is null or empty\n\nfails entirely if this annotation is `Mandatory` in the after-image of the request.\nThe empty string is an empty value. Service-specific rules may consider other values, also\nof non-string type, empty.\nValues in draft entities are never considered empty.\nMandatory properties SHOULD be decorated in the UI with an asterisk.\nNull or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md).", "Optional": 3, "Optional@Core.Description": "Property may have a value", "Optional@Core.LongDescription": "This value does not make sense as a static annotation value.", diff --git a/vocabularies/Common.md b/vocabularies/Common.md index b45b7833..6ebca216 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -41,76 +41,76 @@ Term|Type|Description [IsInstanceAnnotation](./Common.xml#L303:~:text=Term can also be used as instance annotation; AppliesTo of this term specifies where it can be applied [FilterExpressionRestrictions](./Common.xml#L333:~:text=Use term Capabilities.FilterRestrictions instead [FieldControl](./Common.xml#L376:~:text=Control state of a property, parameter, or the media stream of a media entity
    This term can be used for static field control, providing an enumeration member value in $metadata, as well as dynamically, providing a `Path` expression.
    In the dynamic case the property referenced by the `Path` expression MUST be of type `Edm.Byte` to accommodate OData V2 services as well as V4 infrastructures that don't support enumeration types. -[ExceptionCategory](./Common.xml#L432:~:text=A machine-readable exception category -[Application](./Common.xml#L437:~:text=... -[Timestamp](./Common.xml#L457:~:text=... -[TransactionId](./Common.xml#L462:~:text=... -[ErrorResolution](./Common.xml#L467:~:text=Hints for resolving this error -[Messages](./Common.xml#L485:~:text=Collection of end-user messages

    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.

    The minimum structure is

    • code: Edm.String
    • message: Edm.String
    • target: Edm.String nullable
    • additionalTargets: Collection(Edm.String)
    • transition: Edm.Boolean
    • numericSeverity: Edm.Byte
    • longtextUrl: Edm.String nullable
    -[additionalTargets](./Common.xml#L501:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[longtextUrl](./Common.xml#L507:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[numericSeverity](./Common.xml#L513:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response -[MaximumNumericMessageSeverity](./Common.xml#L518:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
    This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) -[IsActionCritical](./Common.xml#L547:~:text=Criticality of the function or action to enforce a warning or similar before it's executed -[Attributes](./Common.xml#L551:~:text=Attributes related to this property, which may occur in denormalized entity types -[RelatedRecursiveHierarchy](./Common.xml#L555:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. -[Interval](./Common.xml#L559:~:text=An interval with lower and upper boundaries described by two properties -[ResultContext](./Common.xml#L582:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. -[SAPObjectNodeType](./Common.xml#L590:~:text=The SAP Object Node Type represented by the annotated entity type
    SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. -[Composition](./Common.xml#L606:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
    The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. -[SAPObjectNodeTypeReference](./Common.xml#L615:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
    The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. -[IsNaturalPerson](./Common.xml#L623:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person -[ValueList](./Common.xml#L629:~:text=Specifies how to get a list of acceptable values for a property or parameter
    The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. -[ValueListRelevantQualifiers](./Common.xml#L703:~:text=List of qualifiers of relevant ValueList annotations
    The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. -[ValueListWithFixedValues](./Common.xml#L708:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
    Can be annotated with:
    • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
    -[ValueListShowValuesImmediately](./Common.xml#L717:~:text=A value list with a very small number of fixed values, can decide to show all values immediately -[ValueListForValidation](./Common.xml#L722:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
    An empty string identifies the ValueList or ValueListMapping without a qualifier. -[ValueListReferences](./Common.xml#L727:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property -[ValueListMapping](./Common.xml#L732:~:text=Specifies the mapping between data service properties and value list properties
    The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. -[IsCalendarYear](./Common.xml#L844:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) -[IsCalendarHalfyear](./Common.xml#L853:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] -[IsCalendarQuarter](./Common.xml#L862:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsCalendarMonth](./Common.xml#L871:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] -[IsCalendarWeek](./Common.xml#L880:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsDayOfCalendarMonth](./Common.xml#L889:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. -[IsDayOfCalendarYear](./Common.xml#L897:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. -[IsCalendarYearHalfyear](./Common.xml#L905:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] -[IsCalendarYearQuarter](./Common.xml#L915:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] -[IsCalendarYearMonth](./Common.xml#L925:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) -[IsCalendarYearWeek](./Common.xml#L936:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsCalendarDate](./Common.xml#L946:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. -[IsFiscalYear](./Common.xml#L963:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} -[IsFiscalPeriod](./Common.xml#L972:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} -[IsFiscalYearPeriod](./Common.xml#L981:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) -[IsFiscalQuarter](./Common.xml#L991:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] -[IsFiscalYearQuarter](./Common.xml#L999:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] -[IsFiscalWeek](./Common.xml#L1008:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] -[IsFiscalYearWeek](./Common.xml#L1016:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) -[IsDayOfFiscalYear](./Common.xml#L1025:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. -[IsFiscalYearVariant](./Common.xml#L1032:~:text=Property encodes a fiscal year variant -[MutuallyExclusiveTerm](./Common.xml#L1040:~:text=Only one term of the group identified with the Qualifier attribute can be applied -[DraftRoot](./Common.xml#L1046:~:text=Root entities of business documents that support the draft pattern -[DraftNode](./Common.xml#L1087:~:text=Entities in this set are parts of business documents that support the draft pattern -[DraftActivationVia](./Common.xml#L1109:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets -[EditableFieldFor](./Common.xml#L1113:~:text=The annotated property is an editable field for the referenced key property -[SemanticKey](./Common.xml#L1143:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity -[SideEffects](./Common.xml#L1147:~:text=Describes side-effects of modification operations -[DefaultValuesFunction](./Common.xml#L1230:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
    The default values function must have a bound overload whose binding parameter type matches the annotation target
    - for an entity set: collection of entity type of entity set
    - for a navigation property: identical to the type of the navigation property (single- or collection-valued)
    - for a bound action/function: identical to the binding parameter type of the annotated action/function
    In addition the overload can have non-binding parameters for values that the user has already entered:
    - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
    - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
    The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
    - the properties of the entity to create, or
    - the parameters of the action or function to call -[DerivedDefaultValue](./Common.xml#L1259:~:text=Function import to derive a default value for the property from a given context.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[FilterDefaultValue](./Common.xml#L1280:~:text=A default value for the property to be used in filter expressions. -[FilterDefaultValueHigh](./Common.xml#L1284:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. -[DerivedFilterDefaultValue](./Common.xml#L1289:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. -[SortOrder](./Common.xml#L1313:~:text=List of sort criteria
    The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. -[RecursiveHierarchy](./Common.xml#L1369:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead -[CreatedAt](./Common.xml#L1417:~:text=Creation timestamp -[CreatedBy](./Common.xml#L1421:~:text=First editor -[ChangedAt](./Common.xml#L1425:~:text=Last modification timestamp -[ChangedBy](./Common.xml#L1429:~:text=Last editor -[OriginalProtocolVersion](./Common.xml#L1441:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` -[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1446:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
    TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ -[mediaUploadLink](./Common.xml#L1452:~:text=URL for uploading new media content to a Document Management Service
    In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. -[PrimitivePropertyPath](./Common.xml#L1467:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property -[WebSocketBaseURL](./Common.xml#L1472:~:text=Base URL for WebSocket connections +[ExceptionCategory](./Common.xml#L433:~:text=A machine-readable exception category +[Application](./Common.xml#L438:~:text=... +[Timestamp](./Common.xml#L458:~:text=... +[TransactionId](./Common.xml#L463:~:text=... +[ErrorResolution](./Common.xml#L468:~:text=Hints for resolving this error +[Messages](./Common.xml#L486:~:text=Collection of end-user messages

    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.

    The minimum structure is

    • code: Edm.String
    • message: Edm.String
    • target: Edm.String nullable
    • additionalTargets: Collection(Edm.String)
    • transition: Edm.Boolean
    • numericSeverity: Edm.Byte
    • longtextUrl: Edm.String nullable
    +[additionalTargets](./Common.xml#L502:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[longtextUrl](./Common.xml#L508:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[numericSeverity](./Common.xml#L514:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response +[MaximumNumericMessageSeverity](./Common.xml#L519:~:text=The maximum severity of all end-user messages attached to an entity, null if no messages are attached
    This metadata annotation can be applied to entity types that are also annotated with term [`Common.Messages`](#Messages) +[IsActionCritical](./Common.xml#L548:~:text=Criticality of the function or action to enforce a warning or similar before it's executed +[Attributes](./Common.xml#L552:~:text=Attributes related to this property, which may occur in denormalized entity types +[RelatedRecursiveHierarchy](./Common.xml#L556:~:text=A recursive hierarchy related to this property. The annotation path must end in Aggregation.RecursiveHierarchy. +[Interval](./Common.xml#L560:~:text=An interval with lower and upper boundaries described by two properties +[ResultContext](./Common.xml#L583:~:text=The annotated entity type has one or more containment navigation properties. An instance of the annotated entity type provides the context required for determining the target entity sets reached by these containment navigation properties. +[SAPObjectNodeType](./Common.xml#L591:~:text=The SAP Object Node Type represented by the annotated entity type
    SAP Object Node Types define the structure of SAP Object Types, which are a generalization of Business Object, Technical Object, Configuration Object, and Analytical Object. +[Composition](./Common.xml#L607:~:text=The annotated navigation property represents a logical composition, even though it is non-containment
    The entities related via this navigation property have an existential dependency on their composition parent. The entity set of the composition parent MUST contain a NavigationPropertyBinding for this navigation property. +[SAPObjectNodeTypeReference](./Common.xml#L616:~:text=The entity referenced by the annotated property has the [`SAPObjectNodeType`](#SAPObjectNodeType) with this name
    The entity containing the property and the entity referenced by it will in general have different SAP Object Node Types. +[IsNaturalPerson](./Common.xml#L624:~:text=The annotated entity type (e.g. `Employee`) or annotation (e.g. `IsImageUrl`) represents a natural person +[ValueList](./Common.xml#L630:~:text=Specifies how to get a list of acceptable values for a property or parameter
    The value list can be based on user input that is passed in the value list request. The value list can be used for type-ahead and classical pick lists. +[ValueListRelevantQualifiers](./Common.xml#L704:~:text=List of qualifiers of relevant ValueList annotations
    The value of this annotation is a dynamic expression for calculating the qualifiers of relevant value lists depending on the values of one or more other properties. +[ValueListWithFixedValues](./Common.xml#L709:~:text=If specified as true, there's only one value list mapping and its value list consists of a small number of fixed values
    Can be annotated with:
    • [ValueListShowValuesImmediately](#ValueListShowValuesImmediately)
    +[ValueListShowValuesImmediately](./Common.xml#L718:~:text=A value list with a very small number of fixed values, can decide to show all values immediately +[ValueListForValidation](./Common.xml#L723:~:text=Contains the qualifier of the ValueList or ValueListMapping that should be used for validation
    An empty string identifies the ValueList or ValueListMapping without a qualifier. +[ValueListReferences](./Common.xml#L728:~:text=A list of URLs of CSDL documents containing value list mappings for this parameter or property +[ValueListMapping](./Common.xml#L733:~:text=Specifies the mapping between data service properties and value list properties
    The value list can be filtered based on user input. It can be used for type-ahead and classical pick lists. There may be many alternative mappings with different qualifiers. +[IsCalendarYear](./Common.xml#L845:~:text=Property encodes a year number as string following the logical pattern (-?)YYYY(Y*) consisting of an optional minus sign for years B.C. followed by at least four digits. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3}) +[IsCalendarHalfyear](./Common.xml#L854:~:text=Property encodes a halfyear number as string following the logical pattern H consisting of a single digit. The string matches the regex pattern [1-2] +[IsCalendarQuarter](./Common.xml#L863:~:text=Property encodes a calendar quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsCalendarMonth](./Common.xml#L872:~:text=Property encodes a calendar month number as string following the logical pattern MM consisting of two digits. The string matches the regex pattern 0[1-9]\|1[0-2] +[IsCalendarWeek](./Common.xml#L881:~:text=Property encodes a calendar week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsDayOfCalendarMonth](./Common.xml#L890:~:text=Day number relative to a calendar month. Valid values are between 1 and 31. +[IsDayOfCalendarYear](./Common.xml#L898:~:text=Day number relative to a calendar year. Valid values are between 1 and 366. +[IsCalendarYearHalfyear](./Common.xml#L906:~:text=Property encodes a calendar year and halfyear as string following the logical pattern (-?)YYYY(Y*)H consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the halfyear. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-2] +[IsCalendarYearQuarter](./Common.xml#L916:~:text=Property encodes a calendar year and quarter as string following the logical pattern (-?)YYYY(Y*)Q consisting of an optional minus sign for years B.C. followed by at least five digits, where the last digit represents the quarter. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})[1-4] +[IsCalendarYearMonth](./Common.xml#L926:~:text=Property encodes a calendar year and month as string following the logical pattern (-?)YYYY(Y*)MM consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent the months January to December. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2]) +[IsCalendarYearWeek](./Common.xml#L937:~:text=Property encodes a calendar year and week as string following the logical pattern (-?)YYYY(Y*)WW consisting of an optional minus sign for years B.C. followed by at least six digits, where the last two digits represent week number in the year. The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsCalendarDate](./Common.xml#L947:~:text=Property encodes a calendar date: year, month and day as string following the logical pattern (-?)YYYY(Y*)MMDD consisting of an optional minus sign for years B.C. followed by at least eight digits, where the last four digits represent the months January to December (MM) and the day of the month (DD). The string matches the regex pattern -?([1-9][0-9]{3,}\|0[0-9]{3})(0[1-9]\|1[0-2])(0[1-9]\|[12][0-9]\|3[01]) The regex pattern does not reflect the additional constraint for "Day-of-month Values": The day value must be no more than 30 if month is one of 04, 06, 09, or 11, no more than 28 if month is 02 and year is not divisible by 4, or is divisible by 100 but not by 400, and no more than 29 if month is 02 and year is divisible by 400, or by 4 but not by 100. +[IsFiscalYear](./Common.xml#L964:~:text=Property encodes a fiscal year number as string following the logical pattern YYYY consisting of four digits. The string matches the regex pattern [1-9][0-9]{3} +[IsFiscalPeriod](./Common.xml#L973:~:text=Property encodes a fiscal period as string following the logical pattern PPP consisting of three digits. The string matches the regex pattern [0-9]{3} +[IsFiscalYearPeriod](./Common.xml#L982:~:text=Property encodes a fiscal year and period as string following the logical pattern YYYYPPP consisting of seven digits, where the last three digits represent the fiscal period in the year. The string matches the regex pattern ([1-9][0-9]{3})([0-9]{3}) +[IsFiscalQuarter](./Common.xml#L992:~:text=Property encodes a fiscal quarter number as string following the logical pattern Q consisting of a single digit. The string matches the regex pattern [1-4] +[IsFiscalYearQuarter](./Common.xml#L1000:~:text=Property encodes a fiscal year and quarter as string following the logical pattern YYYYQ consisting of five digits, where the last digit represents the quarter. The string matches the regex pattern [1-9][0-9]{3}[1-4] +[IsFiscalWeek](./Common.xml#L1009:~:text=Property encodes a fiscal week number as string following the logical pattern WW consisting of two digits. The string matches the regex pattern 0[1-9]\|[1-4][0-9]\|5[0-3] +[IsFiscalYearWeek](./Common.xml#L1017:~:text=Property encodes a fiscal year and week as string following the logical pattern YYYYWW consisting of six digits, where the last two digits represent the week number in the year. The string matches the regex pattern [1-9][0-9]{3}(0[1-9]\|[1-4][0-9]\|5[0-3]) +[IsDayOfFiscalYear](./Common.xml#L1026:~:text=Day number relative to a fiscal year. Valid values are between 1 and 371. +[IsFiscalYearVariant](./Common.xml#L1033:~:text=Property encodes a fiscal year variant +[MutuallyExclusiveTerm](./Common.xml#L1041:~:text=Only one term of the group identified with the Qualifier attribute can be applied +[DraftRoot](./Common.xml#L1047:~:text=Root entities of business documents that support the draft pattern +[DraftNode](./Common.xml#L1088:~:text=Entities in this set are parts of business documents that support the draft pattern +[DraftActivationVia](./Common.xml#L1110:~:text=Draft entities in this set are indirectly activated via draft entities in the referenced entity sets +[EditableFieldFor](./Common.xml#L1114:~:text=The annotated property is an editable field for the referenced key property +[SemanticKey](./Common.xml#L1144:~:text=The listed properties form the semantic key, i.e. they are unique modulo IsActiveEntity +[SideEffects](./Common.xml#L1148:~:text=Describes side-effects of modification operations +[DefaultValuesFunction](./Common.xml#L1231:~:text=Function to calculate default values based on user input that is only known to the client and "context information" that is already available to the service
    The default values function must have a bound overload whose binding parameter type matches the annotation target
    - for an entity set: collection of entity type of entity set
    - for a navigation property: identical to the type of the navigation property (single- or collection-valued)
    - for a bound action/function: identical to the binding parameter type of the annotated action/function
    In addition the overload can have non-binding parameters for values that the user has already entered:
    - for an entity set or navigation property: each non-binding parameter name and type must match the name and type of a property of the entity to be created
    - for an action or function: each non-binding parameter name and type must match the name and type of a non-binding parameter of the action or function to be called
    The result type of the default values function is a complex type whose properties correspond in name and type to a subset of
    - the properties of the entity to create, or
    - the parameters of the action or function to call +[DerivedDefaultValue](./Common.xml#L1260:~:text=Function import to derive a default value for the property from a given context.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[FilterDefaultValue](./Common.xml#L1281:~:text=A default value for the property to be used in filter expressions. +[FilterDefaultValueHigh](./Common.xml#L1285:~:text=A default upper limit for the property to be used in 'less than or equal' filter expressions. +[DerivedFilterDefaultValue](./Common.xml#L1290:~:text=Function import to derive a default value for the property from a given context in order to use it in filter expressions.
    Function import has two parameters of complex types:
    - `parameters`, a structure resembling the entity type the parameter entity set related to the entity set of the annotated property
    - `properties`, a structure resembling the type of the entity set of the annotated property
    The return type must be of the same type as the annotated property.
    Arguments passed to the function import are used as context for deriving the default value. The function import returns this default value, or null in case such a value could not be determined. +[SortOrder](./Common.xml#L1314:~:text=List of sort criteria
    The items of the annotated entity set or the items of the collection of the annotated entity type are sorted by the first entry of the SortOrder collection. Items with same value for this first sort criteria are sorted by the second entry of the SortOrder collection, and so on. +[RecursiveHierarchy](./Common.xml#L1370:~:text=Use terms [Aggregation.RecursiveHierarchy](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#RecursiveHierarchy) and [Hierarchy.RecursiveHierarchy](https://github.com/SAP/odata-vocabularies/blob/main/vocabularies/Hierarchy.md#RecursiveHierarchy) instead +[CreatedAt](./Common.xml#L1418:~:text=Creation timestamp +[CreatedBy](./Common.xml#L1422:~:text=First editor +[ChangedAt](./Common.xml#L1426:~:text=Last modification timestamp +[ChangedBy](./Common.xml#L1430:~:text=Last editor +[OriginalProtocolVersion](./Common.xml#L1442:~:text=Original protocol version of a converted (V4) CSDL document, allowed values `2.0` and `3.0` +[ApplyMultiUnitBehaviorForSortingAndFiltering](./Common.xml#L1447:~:text=Sorting and filtering of amounts in multiple currencies needs special consideration
    TODO: add link to UX documentation on https://experience.sap.com/fiori-design/ +[mediaUploadLink](./Common.xml#L1453:~:text=URL for uploading new media content to a Document Management Service
    In contrast to the `@odata.mediaEditLink` this URL allows to upload new media content without directly changing a stream property or media resource. The upload request typically uses HTTP POST with `Content-Type: multipart/form-data` following RFC 7578. The upload request must contain one multipart representing the content of the file. The `name` parameter in the `Content-Disposition` header (as described in RFC 7578) is irrelevant, but the `filename` parameter is expected. If the request succeeds the response will contain a JSON body of `Content-Type: application/json` with a JSON property `readLink`. The newly uploaded media resource can be linked to the stream property by changing the `@odata.mediaReadLink` to the value of this `readLink` in a subsequent PATCH request to the OData entity. +[PrimitivePropertyPath](./Common.xml#L1468:~:text=A term or term property with this tag whose type is (a collection of) `Edm.PropertyPath` MUST resolve to a primitive structural property +[WebSocketBaseURL](./Common.xml#L1473:~:text=Base URL for WebSocket connections ## [TextFormatType](./Common.xml#L120:~:text=A request that
    - sets the property to null or an empty value or
    - creates a non-[draft](#DraftRoot) entity and omits the property or
    - activates a draft entity while the property is null or empty
    fails entirely if this annotation is `Mandatory` in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md). -[Optional](./Common.xml#L402:~:text=This value does not make sense as a static annotation value. -[ReadOnly](./Common.xml#L406:~:text=A request to change the property to a value that differs from the before-image fails entirely according to [OData-Protocol, section 11.4.3](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) if this annotation is given dynamically as `ReadOnly` in the before-image of the request.
    To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead. -[Inapplicable](./Common.xml#L416:~:text=A request that sets the property to a non-initial non-null value fails entirely if this annotation is `Inapplicable` in the after-image of the request.
    This value does not make sense as a static annotation value.
    Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international. -[Hidden](./Common.xml#L426:~:text=To statically hide a property on a UI use [UI.Hidden](UI.md#Hidden) instead +[Mandatory](./Common.xml#L387:~:text=

    A request that

    • sets the property to null or an empty value or
    • creates a non-draft entity and omits the property or
    • activates a draft entity while the property is null or empty

    fails entirely if this annotation is Mandatory in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet Nullable or terms from the Validation vocabulary.

    +[Optional](./Common.xml#L403:~:text=This value does not make sense as a static annotation value. +[ReadOnly](./Common.xml#L407:~:text=A request to change the property to a value that differs from the before-image fails entirely according to [OData-Protocol, section 11.4.3](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) if this annotation is given dynamically as `ReadOnly` in the before-image of the request.
    To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead. +[Inapplicable](./Common.xml#L417:~:text=A request that sets the property to a non-initial non-null value fails entirely if this annotation is `Inapplicable` in the after-image of the request.
    This value does not make sense as a static annotation value.
    Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international. +[Hidden](./Common.xml#L427:~:text=To statically hide a property on a UI use [UI.Hidden](UI.md#Hidden) instead -## [ApplicationType](./Common.xml#L442:~:text= -## [ErrorResolutionType](./Common.xml#L472:~:text= -## [NumericMessageSeverityType](./Common.xml#L523:~:text= -## [IntervalType](./Common.xml#L562:~:text= -## [SAPObjectNodeTypeType](./Common.xml#L598:~:text= -## [ValueListType](./Common.xml#L633:~:text=The value of the target property is used as the search expression instead of in $filter -[FetchValues](./Common.xml#L671:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath -[SelectionVariantQualifier](./Common.xml#L678:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L682:~:text=The value of the target property is used as the search expression instead of in $filter +[FetchValues](./Common.xml#L672:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the entity set identified via CollectionPath +[SelectionVariantQualifier](./Common.xml#L679:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L683:~:text= -## [FetchValuesType](./Common.xml#L687:~:text= -## [ValueListMappingType](./Common.xml#L736:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation -[SelectionVariantQualifier](./Common.xml#L759:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath -[Parameters](./Common.xml#L763:~:text=Qualifier for annotation with term [UI.PresentationVariant](UI.md#PresentationVariant) on the value list entity set identified via CollectionPath in the ValueListReference annotation +[SelectionVariantQualifier](./Common.xml#L760:~:text=Qualifier for annotation with term [UI.SelectionVariant](UI.md#SelectionVariant) on the entity set identified via CollectionPath +[Parameters](./Common.xml#L764:~:text= -## [*ValueListParameter*](./Common.xml#L768:~:text= -## [ValueListParameterIn](./Common.xml#L773:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators -[InitialValueIsSignificant](./Common.xml#L778:~:text=In case the property path contains a collection-based navigation or structural property, the filter is a set of `eq` comparisons connected by `or` operators +[InitialValueIsSignificant](./Common.xml#L779:~:text= -## [ValueListParameterConstant](./Common.xml#L782:~:text= -## [ValueListParameterConstants](./Common.xml#L791:~:text=An empty list means a vacuous filter condition +[*ValueListProperty*](./Common.xml#L770:~:text=An empty list means a vacuous filter condition -## [ValueListParameterInOut](./Common.xml#L800:~:text= -## [ValueListParameterOut](./Common.xml#L813:~:text= -## [ValueListParameterDisplayOnly](./Common.xml#L823:~:text= -## [ValueListParameterFilterOnly](./Common.xml#L831:~:text= -## [DraftRootType](./Common.xml#L1051:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. -[AdditionalNewActions](./Common.xml#L1066:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. -[ShareAction](./Common.xml#L1071:~:text=The action is bound to the draft document root node and has the following signature:
    - `Users`: collection of structure with properties
      - `UserID` of type `String` and
      - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
    It restricts access to the listed users in their specified roles. +[*PreparationAction*](./Common.xml#L1094:~:text=New drafts may also be created by POSTing an empty entity without any properties to the entity set. +[AdditionalNewActions](./Common.xml#L1067:~:text=Additional actions beside the default POST or standard `NewAction` that create a new draft. +[ShareAction](./Common.xml#L1072:~:text=The action is bound to the draft document root node and has the following signature:
    - `Users`: collection of structure with properties
      - `UserID` of type `String` and
      - `UserAccessRole` of type `String` with possible values `O` (owner, can perform all draft actions), and `E` (editor, can change the draft)
    It restricts access to the listed users in their specified roles. -## [DraftNodeType](./Common.xml#L1092:~:text= -## [SimpleIdentifier](./Common.xml#L1117:~:text= -## [QualifiedName](./Common.xml#L1129:~:text= -## [ActionOverload](./Common.xml#L1134:~:text= -## [SideEffectsType](./Common.xml#L1150:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path -[TargetEntities](./Common.xml#L1172:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. -[Discretionary](./Common.xml#L1190:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. +[SourceProperties](./Common.xml#L1163:~:text=The syntax follows closely the syntax rules for `Edm.PropertyPath`, with the addition of `*` as the last path segment meaning all structural properties directly reached via the preceding path +[TargetEntities](./Common.xml#L1173:~:text=Binding parameter type of the trigger action is the entity type annotated with `SideEffects`. The action does not have any additional parameters and does not return anything. It either succeeds with `204 No Content` or it fails with `4xx` or `5xx`. +[Discretionary](./Common.xml#L1191:~:text=The value of this property typically a static boolean value. It can be used by clients (e.g. by asking the end user) to decide if the side effect should be triggered or not. This indicator is only allowed in case a trigger action is given as only then the execution control of the side effect is provided to the client. -## [EffectType](./Common.xml#L1196:~:text= -## [SortOrderType](./Common.xml#L1321:~:text=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:
    • [AggregatedProperty](Analytics.md#AggregatedProperty)
    • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
    -[Descending](./Common.xml#L1349:~:text=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:
    • [AggregatedProperty](Analytics.md#AggregatedProperty)
    • [CustomAggregate](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Aggregation.V1.md#CustomAggregate)
    +[Descending](./Common.xml#L1350:~:text= -## [RecursiveHierarchyType](./Common.xml#L1382:~:text= -## [UserID](./Common.xml#L1433:~:text= A request that - <br>- sets the property to null or an empty value or - <br>- creates a non-[draft](#DraftRoot) entity and omits the property or - <br>- activates a draft entity while the property is null or empty - <br>fails entirely if this annotation is `Mandatory` in the after-image of the request. - The empty string is an empty value. Service-specific rules may consider other values, also - of non-string type, empty. - Values in draft entities are never considered empty. - Mandatory properties SHOULD be decorated in the UI with an asterisk. - Null or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md). +- sets the property to null or an empty value or +- creates a non-[draft](#DraftRoot) entity and omits the property or +- activates a draft entity while the property is null or empty + +fails entirely if this annotation is `Mandatory` in the after-image of the request. +The empty string is an empty value. Service-specific rules may consider other values, also +of non-string type, empty. +Values in draft entities are never considered empty. +Mandatory properties SHOULD be decorated in the UI with an asterisk. +Null or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md).         diff --git a/vocabularies/Hierarchy.json b/vocabularies/Hierarchy.json index 1d8d3f64..07673fc8 100644 --- a/vocabularies/Hierarchy.json +++ b/vocabularies/Hierarchy.json @@ -45,7 +45,7 @@ "NodeType": { "$Nullable": true, "@Core.Description": "Type of a node", - "@Core.LongDescription": "In a recursive hierarchy with mixed types, nodes can\n
    - have a type-specific (navigation) property whose name is the node type or\n
    - be represented by entities of different subtypes of a common entity type that is\n annotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type." + "@Core.LongDescription": "In a recursive hierarchy with mixed types, nodes can\n- have a type-specific (navigation) property whose name is the node type or\n- be represented by entities of different subtypes of a common entity type that is\n\nannotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type." }, "ChildCount": { "$Type": "Edm.Int64", @@ -131,7 +131,7 @@ "@Common.Experimental": true, "@Common.IsInstanceAnnotation": true, "@Core.Description": "Instance annotation on the result of an `$apply` query option containing the number of matching nodes after hierarchical transformations", - "@Core.LongDescription": "The service MAY designate a subset of the `$apply` result as \"matching nodes\".\n For requests following the pattern described [here](#RecursiveHierarchyType), this subset is the output set of the\n `filter` or `search` transformation that occurs as the fourth parameter\n of the last `ancestors` transformation or occurs nested into it.
    \n For requests not following this pattern, the subset NEED NOT be defined.
    \n This instance annotation is available if [`RecursiveHierarchy/Matched`](#RecursiveHierarchyType)\n and [`RecursiveHierarchy/MatchedDescendantCount`](#RecursiveHierarchyType) are also available." + "@Core.LongDescription": "The service MAY designate a subset of the `$apply` result as \"matching nodes\".\nFor requests following the pattern described [here](#RecursiveHierarchyType), this subset is the output set of the\n`filter` or `search` transformation that occurs as the fourth parameter\nof the last `ancestors` transformation or occurs nested into it.\n\nFor requests not following this pattern, the subset NEED NOT be defined.\n\nThis instance annotation is available if [`RecursiveHierarchy/Matched`](#RecursiveHierarchyType)\nand [`RecursiveHierarchy/MatchedDescendantCount`](#RecursiveHierarchyType) are also available." }, "TopLevels": [ { diff --git a/vocabularies/Hierarchy.md b/vocabularies/Hierarchy.md index 8ae4fa6b..1d71774f 100644 --- a/vocabularies/Hierarchy.md +++ b/vocabularies/Hierarchy.md @@ -9,26 +9,26 @@ Terms for Hierarchies Term|Type|Description :---|:---|:---------- [RecursiveHierarchy](./Hierarchy.xml#L41:~:text=Hierarchy-specific information in the result set of a hierarchical request
    The [base term](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchy) governs what are the nodes and parents in the hierarchy, whereas this term defines derived information. -[RecursiveHierarchyActions](./Hierarchy.xml#L154:~:text=Actions for maintaining the recursive hierarchy defined by the [base term](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchy)
    When an annotation with this term is present, the [`ParentNavigationProperty`](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchyType) in the base term must not have a collection-valued segment prior to its last segment. -[MatchCount](./Hierarchy.xml#L208:~:text=Instance annotation on the result of an `$apply` query option containing the number of matching nodes after hierarchical transformations
    The service MAY designate a subset of the `$apply` result as "matching nodes". For requests following the pattern described [here](#RecursiveHierarchyType), this subset is the output set of the `filter` or `search` transformation that occurs as the fourth parameter of the last `ancestors` transformation or occurs nested into it.
    For requests not following this pattern, the subset NEED NOT be defined.
    This instance annotation is available if [`RecursiveHierarchy/Matched`](#RecursiveHierarchyType) and [`RecursiveHierarchy/MatchedDescendantCount`](#RecursiveHierarchyType) are also available. -[RecursiveHierarchySupported](./Hierarchy.xml#L290:~:text=Whether the annotated collection acts as a [`RecursiveHierarchy`](#RecursiveHierarchy) with the given qualifier
    This tag is applied to a collection with the same qualifier as the [`RecursiveHierarchy`](#RecursiveHierarchy) term which is applied to its entity type. The recursive hierarchy can then only be addressed through a collection where this tag is true. +[RecursiveHierarchyActions](./Hierarchy.xml#L155:~:text=Actions for maintaining the recursive hierarchy defined by the [base term](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchy)
    When an annotation with this term is present, the [`ParentNavigationProperty`](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchyType) in the base term must not have a collection-valued segment prior to its last segment. +[MatchCount](./Hierarchy.xml#L209:~:text=Instance annotation on the result of an `$apply` query option containing the number of matching nodes after hierarchical transformations
    The service MAY designate a subset of the `$apply` result as "matching nodes". For requests following the pattern described [here](#RecursiveHierarchyType), this subset is the output set of the `filter` or `search` transformation that occurs as the fourth parameter of the last `ancestors` transformation or occurs nested into it.
    For requests not following this pattern, the subset NEED NOT be defined.
    This instance annotation is available if [`RecursiveHierarchy/Matched`](#RecursiveHierarchyType) and [`RecursiveHierarchy/MatchedDescendantCount`](#RecursiveHierarchyType) are also available. +[RecursiveHierarchySupported](./Hierarchy.xml#L293:~:text=Whether the annotated collection acts as a [`RecursiveHierarchy`](#RecursiveHierarchy) with the given qualifier
    This tag is applied to a collection with the same qualifier as the [`RecursiveHierarchy`](#RecursiveHierarchy) term which is applied to its entity type. The recursive hierarchy can then only be addressed through a collection where this tag is true. ## Actions -### [Template_ChangeNextSiblingAction](./Hierarchy.xml#L300:~:text=This parameter has properties with the same names as the key properties of the entity type. next(T) = S after the action. If R is a node with next(R) = S before the action, then next(R) = T after the action, even if S = null. It is an error if S has a different parent than T. +**[Node](./Hierarchy.xml#L306:~:text=This parameter has properties with the same names as the key properties of the entity type. next(T) = S after the action. If R is a node with next(R) = S before the action, then next(R) = T after the action, even if S = null. It is an error if S has a different parent than T. -### [Template_CopyAction](./Hierarchy.xml#L334:~:text= -### [TopLevels](./Hierarchy.xml#L236:~:text= @@ -127,19 +127,19 @@ the following collections of hierarchy nodes are distinguished: Property|Type|Description :-------|:---|:---------- [ExternalKey](./Hierarchy.xml#L87:~:text=If a `NodeType` exists, the external key is unique only in combination with it. Or the external key can coincide with the [`Aggregation.RecursiveHierarchy/NodeProperty`](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchyType). -[NodeType](./Hierarchy.xml#L94:~:text=In a recursive hierarchy with mixed types, nodes can
    - have a type-specific (navigation) property whose name is the node type or
    - be represented by entities of different subtypes of a common entity type that is annotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type. -[ChildCount](./Hierarchy.xml#L103:~:text=Possible drill states are:
    - `expanded` if a node has children in the limited hierarchy
    - `collapsed` if a node has children in the unlimited hierarchy but not in the limited hierarchy
    - `leaf` if a node has no children in the unlimited hierarchy -[DistanceFromRoot](./Hierarchy.xml#L121:~:text=This equals the number of ancestors in the sub-hierarchy, if the request involves a sub-hierarchy. -[LimitedRank](./Hierarchy.xml#L127:~:text=The rank of a node is the index of the node in the sequence of nodes created from a preorder or postorder traversal of the limited hierarchy. The first node in the traversal has rank 0. -[SiblingRank](./Hierarchy.xml#L134:~:text=The sibling rank of a node is the index of the node in the sequence of all nodes in the unlimited hierarchy with the same parent. The first sibling has rank 0. -[Matched](./Hierarchy.xml#L141:~:text=

    In a recursive hierarchy with mixed types, nodes can

    • have a type-specific (navigation) property whose name is the node type or
    • be represented by entities of different subtypes of a common entity type that is

    annotated with the RecursiveHierarchy annotation. The qualified name of the subtype is the node type.

    +[ChildCount](./Hierarchy.xml#L104:~:text=Possible drill states are:
    - `expanded` if a node has children in the limited hierarchy
    - `collapsed` if a node has children in the unlimited hierarchy but not in the limited hierarchy
    - `leaf` if a node has no children in the unlimited hierarchy +[DistanceFromRoot](./Hierarchy.xml#L122:~:text=This equals the number of ancestors in the sub-hierarchy, if the request involves a sub-hierarchy. +[LimitedRank](./Hierarchy.xml#L128:~:text=The rank of a node is the index of the node in the sequence of nodes created from a preorder or postorder traversal of the limited hierarchy. The first node in the traversal has rank 0. +[SiblingRank](./Hierarchy.xml#L135:~:text=The sibling rank of a node is the index of the node in the sequence of all nodes in the unlimited hierarchy with the same parent. The first sibling has rank 0. +[Matched](./Hierarchy.xml#L142:~:text= -## [RecursiveHierarchyActionsType](./Hierarchy.xml#L162:~:text= -## [TopLevelsExpandType](./Hierarchy.xml#L279:~:text= In a recursive hierarchy with mixed types, nodes can - <br>- have a type-specific (navigation) property whose name is the node type or - <br>- be represented by entities of different subtypes of a common entity type that is - annotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type. +- have a type-specific (navigation) property whose name is the node type or +- be represented by entities of different subtypes of a common entity type that is + +annotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type. @@ -211,12 +212,14 @@ The template actions themselves cannot be invoked. The service MAY designate a subset of the `$apply` result as "matching nodes". - For requests following the pattern described [here](#RecursiveHierarchyType), this subset is the output set of the - `filter` or `search` transformation that occurs as the fourth parameter - of the last `ancestors` transformation or occurs nested into it.<br> - For requests not following this pattern, the subset NEED NOT be defined.<br> - This instance annotation is available if [`RecursiveHierarchy/Matched`](#RecursiveHierarchyType) - and [`RecursiveHierarchy/MatchedDescendantCount`](#RecursiveHierarchyType) are also available. +For requests following the pattern described [here](#RecursiveHierarchyType), this subset is the output set of the +`filter` or `search` transformation that occurs as the fourth parameter +of the last `ancestors` transformation or occurs nested into it. + +For requests not following this pattern, the subset NEED NOT be defined. + +This instance annotation is available if [`RecursiveHierarchy/Matched`](#RecursiveHierarchyType) +and [`RecursiveHierarchy/MatchedDescendantCount`](#RecursiveHierarchyType) are also available. diff --git a/vocabularies/UI.json b/vocabularies/UI.json index 54402513..8a0a031a 100644 --- a/vocabularies/UI.json +++ b/vocabularies/UI.json @@ -1254,7 +1254,7 @@ "$Type": "UI.TextArrangementType", "$AppliesTo": ["Annotation", "EntityType"], "@Core.Description": "Describes the arrangement of a code or ID value and its text", - "@Core.LongDescription": "This term annotates one of the following:
    \n (1) a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text
    \n (2) an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type." + "@Core.LongDescription": "This term annotates one of the following:\n1. a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text\n2. an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type." }, "TextArrangementType": { "$Kind": "EnumType", diff --git a/vocabularies/UI.md b/vocabularies/UI.md index 03e9bab6..13efe540 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -54,7 +54,7 @@ Term|Type|Description [IsImage](./UI.xml#L1383:~:text=Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
    Can be annotated with:
    • [IsNaturalPerson](Common.md#IsNaturalPerson)
    [MultiLineText](./UI.xml#L1394:~:text=Properties and parameters annotated with this annotation should be rendered as multi-line text (e.g. text area) [Placeholder](./UI.xml#L1399:~:text=A short, human-readable text that gives a hint or an example to help the user with data entry -[TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text
    This term annotates one of the following:
    (1) a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text
    (2) an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type. +[TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text

    This term annotates one of the following:

    1. a Common.Text annotation of the code or ID property where the annotation value is the text
    2. an entity type, this has the same effect as annotating all Common.Text annotations of properties of that entity type.
    [Note](./UI.xml#L1427:~:text=Visualization of a note attached to an entity
    Administrative data is given by the annotations [`Common.CreatedBy`](Common.md#CreatedBy), [`Common.CreatedAt`](Common.md#CreatedAt), [`Common.ChangedBy`](Common.md#ChangedBy), [`Common.ChangedAt`](Common.md#ChangedAt) on the same entity type. [Importance](./UI.xml#L1480:~:text=Expresses the importance of e.g. a DataField or an annotation [Hidden](./UI.xml#L1495:~:text=Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.
    Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature. If a navigation property is annotated with `Hidden` true, all subsequent parts are hidden - independent of their own potential `Hidden` annotations. diff --git a/vocabularies/UI.xml b/vocabularies/UI.xml index 408a53c9..636fac2e 100644 --- a/vocabularies/UI.xml +++ b/vocabularies/UI.xml @@ -1404,9 +1404,9 @@ The trend is - This term annotates one of the following:<br> - (1) a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text<br> - (2) an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type. + This term annotates one of the following: +1. a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text +2. an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type. From ff02e765575e27927d769504cbc7f7257c8ba58d Mon Sep 17 00:00:00 2001 From: HeikoTheissen Date: Thu, 11 Apr 2024 14:32:25 +0000 Subject: [PATCH 17/22] auto-refreshed --- vocabularies/Common.md | 4 ++-- vocabularies/DirectEdit.md | 2 +- vocabularies/Hierarchy.md | 2 +- vocabularies/PersonalData.md | 2 +- vocabularies/Session.md | 8 ++++---- vocabularies/UI.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 6ebca216..9292f1fb 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -46,7 +46,7 @@ Term|Type|Description [Timestamp](./Common.xml#L458:~:text=... [TransactionId](./Common.xml#L463:~:text=... [ErrorResolution](./Common.xml#L468:~:text=Hints for resolving this error -[Messages](./Common.xml#L486:~:text=Collection of end-user messages

    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.

    The minimum structure is

    • code: Edm.String
    • message: Edm.String
    • target: Edm.String nullable
    • additionalTargets: Collection(Edm.String)
    • transition: Edm.Boolean
    • numericSeverity: Edm.Byte
    • longtextUrl: Edm.String nullable
    +[Messages](./Common.xml#L486:~:text=Collection of end-user messages
    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
    The minimum structure is - `code: Edm.String` - `message: Edm.String` - `target: Edm.String nullable` - `additionalTargets: Collection(Edm.String)` - `transition: Edm.Boolean` - `numericSeverity: Edm.Byte` - `longtextUrl: Edm.String nullable` [additionalTargets](./Common.xml#L502:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response [longtextUrl](./Common.xml#L508:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response [numericSeverity](./Common.xml#L514:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response @@ -147,7 +147,7 @@ When changes are requested, the value of this annotation in the before-image or Member|Value|Description :-----|----:|:---------- -[Mandatory](./Common.xml#L387:~:text=

    A request that

    • sets the property to null or an empty value or
    • creates a non-draft entity and omits the property or
    • activates a draft entity while the property is null or empty

    fails entirely if this annotation is Mandatory in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet Nullable or terms from the Validation vocabulary.

    +[Mandatory](./Common.xml#L387:~:text=A request that - sets the property to null or an empty value or - creates a non-[draft](#DraftRoot) entity and omits the property or - activates a draft entity while the property is null or empty
    fails entirely if this annotation is `Mandatory` in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md). [Optional](./Common.xml#L403:~:text=This value does not make sense as a static annotation value. [ReadOnly](./Common.xml#L407:~:text=A request to change the property to a value that differs from the before-image fails entirely according to [OData-Protocol, section 11.4.3](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) if this annotation is given dynamically as `ReadOnly` in the before-image of the request.
    To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead. [Inapplicable](./Common.xml#L417:~:text=A request that sets the property to a non-initial non-null value fails entirely if this annotation is `Inapplicable` in the after-image of the request.
    This value does not make sense as a static annotation value.
    Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international. diff --git a/vocabularies/DirectEdit.md b/vocabularies/DirectEdit.md index 940f2468..8ab4b473 100644 --- a/vocabularies/DirectEdit.md +++ b/vocabularies/DirectEdit.md @@ -19,4 +19,4 @@ After a change to a property whose path is contained in `Triggers`, the client s Property|Type|Description :-------|:---|:---------- [Triggers](./DirectEdit.xml#L48:~:text=The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:

    • Qualifier of type Core.SimpleIdentifier or cast-compatible: the qualifier of the SideEffects annotation
    • Trigger of type Edm.String: the trigger of the side-effects determination, see Triggers property
    • Data of either the entity type of the annotated entity set or a complex type that is structure-compatible with it

    The return type of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for Data.

    Structure-compatible means:

    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • it may contain properties without a corresponding property in the entity type
    • it may omit properties of the entity type
    +[CalculationFunction](./DirectEdit.xml#L52:~:text=The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means: - each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, - each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - it may contain properties without a corresponding property in the entity type - it may omit properties of the entity type diff --git a/vocabularies/Hierarchy.md b/vocabularies/Hierarchy.md index 1d71774f..c1818f08 100644 --- a/vocabularies/Hierarchy.md +++ b/vocabularies/Hierarchy.md @@ -127,7 +127,7 @@ the following collections of hierarchy nodes are distinguished: Property|Type|Description :-------|:---|:---------- [ExternalKey](./Hierarchy.xml#L87:~:text=If a `NodeType` exists, the external key is unique only in combination with it. Or the external key can coincide with the [`Aggregation.RecursiveHierarchy/NodeProperty`](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchyType). -[NodeType](./Hierarchy.xml#L94:~:text=

    In a recursive hierarchy with mixed types, nodes can

    • have a type-specific (navigation) property whose name is the node type or
    • be represented by entities of different subtypes of a common entity type that is

    annotated with the RecursiveHierarchy annotation. The qualified name of the subtype is the node type.

    +[NodeType](./Hierarchy.xml#L94:~:text=In a recursive hierarchy with mixed types, nodes can - have a type-specific (navigation) property whose name is the node type or - be represented by entities of different subtypes of a common entity type that is
    annotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type. [ChildCount](./Hierarchy.xml#L104:~:text=Language-dependent description of the role of the data subjects in this set (e.g. employee, customer)
    Values are application-specific. Can be a static value or a `Path` expression If the role varies per entity [FieldSemantics](./PersonalData.xml#L111:~:text=Primary meaning of the personal data contained in the annotated property
    Changes to values of annotated properties are tracked in the audit log. Use this annotation also on fields that are already marked as contact or address data. [IsPotentiallyPersonal](./PersonalData.xml#L195:~:text=Property contains potentially personal data
    Personal data is information relating to an identified or identifiable natural person (data subject).
    Note: properties annotated with [`FieldSemantics`](#FieldSemantics) need not be additionally annotated with this term.
    See also: [What is personal data?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/what-personal-data_en) -[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data

    Sensitive data is a colloquial term usually including the following data:

    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    • Personal data subject to professional secrecy
    • Personal data relating to criminal or administrative offences
    • Personal data concerning bank or credit card accounts

    See also: What personal data is considered sensitive?

    +[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data: - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation - Personal data subject to professional secrecy - Personal data relating to criminal or administrative offences - Personal data concerning bank or credit card accounts
    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) ## [EntitySemanticsType](./PersonalData.xml#L76:~:text=

    Signature:

    • Binding parameter is collection of type of annotated entity set
    • No non-binding parameters
    • No return type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action initiates a sticky session.
    • On failure no sticky session is initiated.
    +[NewAction](./Session.xml#L88:~:text=Signature: - Binding parameter is collection of type of annotated entity set - No non-binding parameters - No return type
    If called within a sticky session the sticky session continues.
    Otherwise: - On success this action initiates a sticky session. - On failure no sticky session is initiated. [AdditionalNewActions](./Session.xml#L103:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters -[EditAction](./Session.xml#L108:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action returns the targeted entity and initiates a sticky session.
    • On failure no sticky session is initiated.
    -[SaveAction](./Session.xml#L123:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.

    On failure the sticky session is kept alive.

    -[DiscardAction](./Session.xml#L136:~:text=

    Signature:

    • No parameters
    • No return type

    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.

    If called outside of a sticky session the action fails and does not initiate a session.

    +[EditAction](./Session.xml#L108:~:text=Signature: - Binding parameter is type of annotated entity set - No non-binding parameters - Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise: - On success this action returns the targeted entity and initiates a sticky session. - On failure no sticky session is initiated. +[SaveAction](./Session.xml#L123:~:text=Signature: - Binding parameter is type of annotated entity set - No non-binding parameters - Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. +[DiscardAction](./Session.xml#L136:~:text=Signature: - No parameters - No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. diff --git a/vocabularies/UI.md b/vocabularies/UI.md index 13efe540..e96ae9a9 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -54,7 +54,7 @@ Term|Type|Description [IsImage](./UI.xml#L1383:~:text=Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
    Can be annotated with:
    • [IsNaturalPerson](Common.md#IsNaturalPerson)
    [MultiLineText](./UI.xml#L1394:~:text=Properties and parameters annotated with this annotation should be rendered as multi-line text (e.g. text area) [Placeholder](./UI.xml#L1399:~:text=A short, human-readable text that gives a hint or an example to help the user with data entry -[TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text

    This term annotates one of the following:

    1. a Common.Text annotation of the code or ID property where the annotation value is the text
    2. an entity type, this has the same effect as annotating all Common.Text annotations of properties of that entity type.
    +[TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text
    This term annotates one of the following: 1. a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text 2. an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type. [Note](./UI.xml#L1427:~:text=Visualization of a note attached to an entity
    Administrative data is given by the annotations [`Common.CreatedBy`](Common.md#CreatedBy), [`Common.CreatedAt`](Common.md#CreatedAt), [`Common.ChangedBy`](Common.md#ChangedBy), [`Common.ChangedAt`](Common.md#ChangedAt) on the same entity type. [Importance](./UI.xml#L1480:~:text=Expresses the importance of e.g. a DataField or an annotation [Hidden](./UI.xml#L1495:~:text=Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.
    Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature. If a navigation property is annotated with `Hidden` true, all subsequent parts are hidden - independent of their own potential `Hidden` annotations. From f5163c73a025bb828d7deb74777f4d0af0ac31c2 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 16:35:27 +0200 Subject: [PATCH 18/22] Bring back _site/.gitignore --- _site/.gitignore | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 _site/.gitignore diff --git a/_site/.gitignore b/_site/.gitignore new file mode 100644 index 00000000..d6b7ef32 --- /dev/null +++ b/_site/.gitignore @@ -0,0 +1,2 @@ +* +!.gitignore From c179f682d5369688af22a7e0a477204419f5b92a Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 16:40:09 +0200 Subject: [PATCH 19/22] Use temporary commit --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 5241d30f..9e7763d6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1365,7 +1365,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#d431c2f2abb2078f83b56f0ef1d42d3b75731306", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#0334669ad35f87212afd1b979e4f4a1bf313a83b", "dependencies": { "colors": "^1.4.0", "odata-csdl": "^0.9.5", From d0c18703742ee43d7df22250809484fc6e5b33ce Mon Sep 17 00:00:00 2001 From: HeikoTheissen Date: Thu, 11 Apr 2024 14:40:38 +0000 Subject: [PATCH 20/22] auto-refreshed --- vocabularies/Common.md | 4 ++-- vocabularies/DirectEdit.md | 2 +- vocabularies/Hierarchy.md | 2 +- vocabularies/PersonalData.md | 2 +- vocabularies/Session.md | 8 ++++---- vocabularies/UI.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/vocabularies/Common.md b/vocabularies/Common.md index 9292f1fb..6ebca216 100644 --- a/vocabularies/Common.md +++ b/vocabularies/Common.md @@ -46,7 +46,7 @@ Term|Type|Description [Timestamp](./Common.xml#L458:~:text=... [TransactionId](./Common.xml#L463:~:text=... [ErrorResolution](./Common.xml#L468:~:text=Hints for resolving this error -[Messages](./Common.xml#L486:~:text=Collection of end-user messages
    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.
    The minimum structure is - `code: Edm.String` - `message: Edm.String` - `target: Edm.String nullable` - `additionalTargets: Collection(Edm.String)` - `transition: Edm.Boolean` - `numericSeverity: Edm.Byte` - `longtextUrl: Edm.String nullable` +[Messages](./Common.xml#L486:~:text=Collection of end-user messages

    The name of the message type is service-specific, its structure components are identified by naming convention, following the names of the OData error response structure.

    The minimum structure is

    • code: Edm.String
    • message: Edm.String
    • target: Edm.String nullable
    • additionalTargets: Collection(Edm.String)
    • transition: Edm.Boolean
    • numericSeverity: Edm.Byte
    • longtextUrl: Edm.String nullable
    [additionalTargets](./Common.xml#L502:~:text=Additional targets for the message
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response [longtextUrl](./Common.xml#L508:~:text=Location of the message long text
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response [numericSeverity](./Common.xml#L514:~:text=Classifies an end-user message as info, success, warning, or error
    This instance annotation can be applied to the `error` object and the objects within the `details` array of an OData error response @@ -147,7 +147,7 @@ When changes are requested, the value of this annotation in the before-image or Member|Value|Description :-----|----:|:---------- -[Mandatory](./Common.xml#L387:~:text=A request that - sets the property to null or an empty value or - creates a non-[draft](#DraftRoot) entity and omits the property or - activates a draft entity while the property is null or empty
    fails entirely if this annotation is `Mandatory` in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet `Nullable` or terms from the [Validation vocabulary](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Validation.V1.md). +[Mandatory](./Common.xml#L387:~:text=

    A request that

    • sets the property to null or an empty value or
    • creates a non-draft entity and omits the property or
    • activates a draft entity while the property is null or empty

    fails entirely if this annotation is Mandatory in the after-image of the request. The empty string is an empty value. Service-specific rules may consider other values, also of non-string type, empty. Values in draft entities are never considered empty. Mandatory properties SHOULD be decorated in the UI with an asterisk. Null or empty values can also be disallowed by restricting the property value range with the standard type facet Nullable or terms from the Validation vocabulary.

    [Optional](./Common.xml#L403:~:text=This value does not make sense as a static annotation value. [ReadOnly](./Common.xml#L407:~:text=A request to change the property to a value that differs from the before-image fails entirely according to [OData-Protocol, section 11.4.3](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) if this annotation is given dynamically as `ReadOnly` in the before-image of the request.
    To statically mark a property as read-only use term [Core.Computed](https://github.com/oasis-tcs/odata-vocabularies/blob/main/vocabularies/Org.OData.Core.V1.md#Computed) instead. [Inapplicable](./Common.xml#L417:~:text=A request that sets the property to a non-initial non-null value fails entirely if this annotation is `Inapplicable` in the after-image of the request.
    This value does not make sense as a static annotation value.
    Example for dynamic use: in a travel expense report the property `DestinationCountry` is inapplicable if trip type is domestic, and mandatory if trip type is international. diff --git a/vocabularies/DirectEdit.md b/vocabularies/DirectEdit.md index 8ab4b473..940f2468 100644 --- a/vocabularies/DirectEdit.md +++ b/vocabularies/DirectEdit.md @@ -19,4 +19,4 @@ After a change to a property whose path is contained in `Triggers`, the client s Property|Type|Description :-------|:---|:---------- [Triggers](./DirectEdit.xml#L48:~:text=The **return type** of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for `Data`.
    Structure-compatible means: - each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable, - each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property - it may contain properties without a corresponding property in the entity type - it may omit properties of the entity type +[CalculationFunction](./DirectEdit.xml#L52:~:text=The operation calculating the side effects. While non-changing for the service, this technically is an action bound to the entity set so that the parameters can be sent in the POST request body. The action has the following non-binding parameters:

    • Qualifier of type Core.SimpleIdentifier or cast-compatible: the qualifier of the SideEffects annotation
    • Trigger of type Edm.String: the trigger of the side-effects determination, see Triggers property
    • Data of either the entity type of the annotated entity set or a complex type that is structure-compatible with it

    The return type of the action also needs to be either the entity type of the annotated entity set or structure-compatible with it, it can be the same type as for Data.

    Structure-compatible means:

    • each primitive property that has the same name as a corresponding primitive property of the entity type of the annotated entity set is cast-compatible with the corresponding property and is nullable,
    • each complex property that has the same name as a corresponding complex or navigation property of the entity type of the annotated entity set is structure-compatible with the corresponding property
    • it may contain properties without a corresponding property in the entity type
    • it may omit properties of the entity type
    diff --git a/vocabularies/Hierarchy.md b/vocabularies/Hierarchy.md index c1818f08..1d71774f 100644 --- a/vocabularies/Hierarchy.md +++ b/vocabularies/Hierarchy.md @@ -127,7 +127,7 @@ the following collections of hierarchy nodes are distinguished: Property|Type|Description :-------|:---|:---------- [ExternalKey](./Hierarchy.xml#L87:~:text=If a `NodeType` exists, the external key is unique only in combination with it. Or the external key can coincide with the [`Aggregation.RecursiveHierarchy/NodeProperty`](https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.html#RecursiveHierarchyType). -[NodeType](./Hierarchy.xml#L94:~:text=In a recursive hierarchy with mixed types, nodes can - have a type-specific (navigation) property whose name is the node type or - be represented by entities of different subtypes of a common entity type that is
    annotated with the `RecursiveHierarchy` annotation. The qualified name of the subtype is the node type. +[NodeType](./Hierarchy.xml#L94:~:text=

    In a recursive hierarchy with mixed types, nodes can

    • have a type-specific (navigation) property whose name is the node type or
    • be represented by entities of different subtypes of a common entity type that is

    annotated with the RecursiveHierarchy annotation. The qualified name of the subtype is the node type.

    [ChildCount](./Hierarchy.xml#L104:~:text=Language-dependent description of the role of the data subjects in this set (e.g. employee, customer)
    Values are application-specific. Can be a static value or a `Path` expression If the role varies per entity [FieldSemantics](./PersonalData.xml#L111:~:text=Primary meaning of the personal data contained in the annotated property
    Changes to values of annotated properties are tracked in the audit log. Use this annotation also on fields that are already marked as contact or address data. [IsPotentiallyPersonal](./PersonalData.xml#L195:~:text=Property contains potentially personal data
    Personal data is information relating to an identified or identifiable natural person (data subject).
    Note: properties annotated with [`FieldSemantics`](#FieldSemantics) need not be additionally annotated with this term.
    See also: [What is personal data?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/what-personal-data_en) -[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data
    Sensitive data is a colloquial term usually including the following data: - Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation - Personal data subject to professional secrecy - Personal data relating to criminal or administrative offences - Personal data concerning bank or credit card accounts
    See also: [What personal data is considered sensitive?](https://ec.europa.eu/info/law/law-topic/data-protection/reform/rules-business-and-organisations/legal-grounds-processing-data/sensitive-data/what-personal-data-considered-sensitive_en) +[IsPotentiallySensitive](./PersonalData.xml#L206:~:text=Property contains potentially sensitive personal data

    Sensitive data is a colloquial term usually including the following data:

    • Special categories of personal data such as data revealing racial or ethnic origin, political opinions, religious or philosophical beliefs, or trade union membership, and the processing of genetic data, biometric data, data concerning health or sex life or sexual orientation
    • Personal data subject to professional secrecy
    • Personal data relating to criminal or administrative offences
    • Personal data concerning bank or credit card accounts

    See also: What personal data is considered sensitive?

    ## [EntitySemanticsType](./PersonalData.xml#L76:~:text=Signature: - Binding parameter is collection of type of annotated entity set - No non-binding parameters - No return type
    If called within a sticky session the sticky session continues.
    Otherwise: - On success this action initiates a sticky session. - On failure no sticky session is initiated. +[NewAction](./Session.xml#L88:~:text=

    Signature:

    • Binding parameter is collection of type of annotated entity set
    • No non-binding parameters
    • No return type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action initiates a sticky session.
    • On failure no sticky session is initiated.
    [AdditionalNewActions](./Session.xml#L103:~:text=Actions have the same binding parameter as the `NewAction` and may have non-binding paramters -[EditAction](./Session.xml#L108:~:text=Signature: - Binding parameter is type of annotated entity set - No non-binding parameters - Return type is same as binding parameter type
    If called within a sticky session the sticky session continues.
    Otherwise: - On success this action returns the targeted entity and initiates a sticky session. - On failure no sticky session is initiated. -[SaveAction](./Session.xml#L123:~:text=Signature: - Binding parameter is type of annotated entity set - No non-binding parameters - Return type is same as binding parameter type
    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.
    On failure the sticky session is kept alive. -[DiscardAction](./Session.xml#L136:~:text=Signature: - No parameters - No return type
    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.
    If called outside of a sticky session the action fails and does not initiate a session. +[EditAction](./Session.xml#L108:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    If called within a sticky session the sticky session continues.

    Otherwise:

    • On success this action returns the targeted entity and initiates a sticky session.
    • On failure no sticky session is initiated.
    +[SaveAction](./Session.xml#L123:~:text=

    Signature:

    • Binding parameter is type of annotated entity set
    • No non-binding parameters
    • Return type is same as binding parameter type

    On success this action returns the newly created or edited entity. The sticky session is terminated after all entities that were newly created or edited in it have been saved.

    On failure the sticky session is kept alive.

    +[DiscardAction](./Session.xml#L136:~:text=

    Signature:

    • No parameters
    • No return type

    If called within a sticky session the sticky session is terminated, irrespective of whether the action succeeds or fails.

    If called outside of a sticky session the action fails and does not initiate a session.

    diff --git a/vocabularies/UI.md b/vocabularies/UI.md index e96ae9a9..13efe540 100644 --- a/vocabularies/UI.md +++ b/vocabularies/UI.md @@ -54,7 +54,7 @@ Term|Type|Description [IsImage](./UI.xml#L1383:~:text=Properties annotated with this term MUST be a stream property annotated with a MIME type image. Entity types annotated with this term MUST be a media entity type annotated with a MIME type image.
    Can be annotated with:
    • [IsNaturalPerson](Common.md#IsNaturalPerson)
    [MultiLineText](./UI.xml#L1394:~:text=Properties and parameters annotated with this annotation should be rendered as multi-line text (e.g. text area) [Placeholder](./UI.xml#L1399:~:text=A short, human-readable text that gives a hint or an example to help the user with data entry -[TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text
    This term annotates one of the following: 1. a [`Common.Text`](Common.md#Text) annotation of the code or ID property where the annotation value is the text 2. an entity type, this has the same effect as annotating all `Common.Text` annotations of properties of that entity type. +[TextArrangement](./UI.xml#L1404:~:text=Describes the arrangement of a code or ID value and its text

    This term annotates one of the following:

    1. a Common.Text annotation of the code or ID property where the annotation value is the text
    2. an entity type, this has the same effect as annotating all Common.Text annotations of properties of that entity type.
    [Note](./UI.xml#L1427:~:text=Visualization of a note attached to an entity
    Administrative data is given by the annotations [`Common.CreatedBy`](Common.md#CreatedBy), [`Common.CreatedAt`](Common.md#CreatedAt), [`Common.ChangedBy`](Common.md#ChangedBy), [`Common.ChangedAt`](Common.md#ChangedAt) on the same entity type. [Importance](./UI.xml#L1480:~:text=Expresses the importance of e.g. a DataField or an annotation [Hidden](./UI.xml#L1495:~:text=Properties or facets (see UI.Facet) annotated with this term will not be rendered if the annotation evaluates to true.
    Hidden properties usually carry technical information that is used for application control and is of no direct interest to end users. The annotation value may be an expression to dynamically hide or render the annotated feature. If a navigation property is annotated with `Hidden` true, all subsequent parts are hidden - independent of their own potential `Hidden` annotations. From 9a2ca647654a9adc91a902ff72db43a1733813e7 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 17:54:19 +0200 Subject: [PATCH 21/22] npm run serve-pages --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 6fd48b34..afdc05dd 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,8 @@ }, "scripts": { "build": "node lib/transform.js", - "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"" + "pages": "node -e \"require('odata-vocabularies/pages')\" \"OData @ SAP\"", + "serve-pages": "node -e \"require('odata-vocabularies/serve-pages')\"" }, "author": "", "license": "" From cf980f52765a31fead972b10dce44a55752f6073 Mon Sep 17 00:00:00 2001 From: D024504 Date: Thu, 11 Apr 2024 17:55:16 +0200 Subject: [PATCH 22/22] Bump dependency --- package-lock.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index 9e7763d6..4deaf9e6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1365,7 +1365,7 @@ }, "node_modules/odata-vocabularies": { "version": "0.5.2", - "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#0334669ad35f87212afd1b979e4f4a1bf313a83b", + "resolved": "git+ssh://git@github.com/oasis-tcs/odata-vocabularies.git#9596c6a66f992ce7f33f950976a252e945bc91bb", "dependencies": { "colors": "^1.4.0", "odata-csdl": "^0.9.5",