fix: Set proper values for titles and descriptions - Githubissues

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 3 forks source link

fix: Set proper values for titles and descriptions #46

Closed aramovic79 closed 1 week ago

aramovic79 commented 3 weeks ago

Addressing

groups

[x] "title": "Catalog Service” → i.e. without appending “ Title”

packages

[x] "title": "capire bookshop” → take what is there, don’t add extra text like “sample title for"
[x] “shortDescription" → take what is there, don’t add extra text like “Here’s the short description for ..."
[x] “description" → take what is there, don’t add extra text like “Here’s the short description for ..."

apiResources

[x] "title": "Catalog Service” → take what is there, don’t add extra text like “The service is for ..."
[x] “shortDescription": "Catalog Service”→ take what is there, don’t add extra text like “Here we have the shortDescription for ..."
[x] “description": "Catalog Service” → take what is there, don’t add extra text like “Here we have the description for ..."

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

aramovic79 commented 3 weeks ago

cc: @ductaily @Fannon

RamIndia commented 1 week ago

@aramovic79 : You can resolve the conflicts and merge this PR.