open-ux-tools icon indicating copy to clipboard operation
open-ux-tools copied to clipboard

Add cds specific vocabularies for analytics support

Open UweSchwerk opened this issue 1 year ago • 3 comments
trafficstars

POC for supporting non-OData annotations in CDS LSP.

Still to do (by cds/analytics colleagues):

  • add decent descriptions in the three new vocabularies (search for TODOs)
  • check feasibility of the content that has been drafted so far (for Terms: $AppliesTo, usage of Edm.PropertyPath and Edm.NavigationPropertyPath)
  • (Done by now) verify modeling of enum values as string with @Validation.AllowedValues - alternative is "real" OData EnumType (see @Aggreagtion.defaulthttps://github.com/SAP/open-ux-tools/pull/1522/files#r1410695634)

Here is some background explanation and also a demo on how this looks in action: https://github.com/SAP/open-ux-tools/assets/107176531/121edf7c-73b1-4abf-8377-36f5abc625df

After converting allowed values to odata enumTypes it looks as follows: image

for @Aggregartion.default (both value lists are added up): image

Regarding conflicting vocabulary alias Aggregation (there is an Odata vocabulary and now a cds specific one with the same name): current workaround is that the cds terms are logically added to the OData vocabulary. This way we could restrict the code changes to the vocabulary package only. Drawback (I hope acceptable) is that hover/cc item text for @Aggregation.default show wrong namespace: image

UweSchwerk avatar Nov 30 '23 10:11 UweSchwerk

⚠️ No Changeset found

Latest commit: 8c448b980ee1e9aa1138b4187d7310a488a640ad

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Nov 30 '23 10:11 changeset-bot[bot]

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

:white_check_mark: UweSchwerk
:x: d023852


d023852 seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

cla-assistant[bot] avatar Nov 30 '23 10:11 cla-assistant[bot]