cap-js / ord

Open Resource Discovery (ORD) is a protocol that allows applications and services to self-describe their exposed resources and capabilities. This plugin enables generation of ORD document for CAP based applications.
Apache License 2.0
3 stars 4 forks source link

feat: Use package name for product ORD IDs. #42

Closed ductaily closed 2 months ago

ductaily commented 2 months ago

Addressing

from https://github.com/cap-js/ord/issues/38

Fannon commented 2 months ago

Here if the title and short description are same the validator throws an error. @Fannon you could help us better too to decide what to we do about this.

image

This rule will only cause issues when publishing to the Business Accelerator Hub, if you just have sap:core:v1 or none as policyLevel, it does not apply.

But I think it would still be better to avoid this problem in the first place, so if SAP collagues use this plugin, they don't have to rework. Maybe we can prefix the shortDescription with something like CAP application? In the end, the shortDescription and description should be explicitly provided when publishing, so something more meaningful can be put there.

RoshniNaveenaS commented 2 months ago

Tested and looks good!