From 0d02290dd66f904df2f282def5ca69fb599b1476 Mon Sep 17 00:00:00 2001 From: Roshni Naveena S Date: Fri, 28 Jun 2024 17:29:31 +0530 Subject: [PATCH 1/5] Create ord.md --- ord.md | 140 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 ord.md diff --git a/ord.md b/ord.md new file mode 100644 index 0000000..c729e81 --- /dev/null +++ b/ord.md @@ -0,0 +1,140 @@ +# cap-js ORD (Open Resource Discovery) Plugin + +The cap-js ORD plugin has a default behavior where all the values of the ORD document are generated automatically by the plugin without the user giving them explicitly. + +If this default behavior is to be overwritten , then there are two ways in which it could be done. + +For all the application level felids it is done using present configuration ( in `./cdsrc.json` under `ord` section). + +Example: + +```js + "ord": { + "namespace": "sap.sample", + "description": "this is my custom description", + "policyLevel": "sap:core:v1" + } + +``` + +For all the service level felids it is done using annotations ( in the `.cds` files as `@ORD.Extensions`). + +Example: + +```js +annotate ProcessorService with @ORD.Extensions : { + title : 'This is Processor Service title', + shortDescription: 'short description for Processor Service', + visibility : 'public', + extensible : { + supported : 'no' + } +}; + +``` + +The below is the table for all the supported ORD Fields containing defaults and how to overwrite the same. + + +| ORD Filed | Type | Defaults | Preset/Annotation | Usage Example | Description | +|----------|----------|----------|----------|----------|----------| +| openResourceDiscovery | string |- | - | - | 1.9 (generated by plugin) | +| Row 2 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 3 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 4 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 5 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 6 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 7 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 8 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 9 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 10 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 11 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 12 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 13 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 14 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 15 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 16 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 17 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 18 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 19 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 20 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 21 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 22 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 23 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 24 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 25 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 26 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 27 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 28 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 29 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 30 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 31 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 32 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 33 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 34 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 35 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 36 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 37 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 38 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 39 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 40 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 41 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 42 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 43 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 44 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 45 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 46 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 47 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 48 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 49 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 50 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 51 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 52 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 53 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 54 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 55 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 56 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 57 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 58 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 59 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 60 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 61 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 62 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 63 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 64 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 65 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 66 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 67 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 68 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 69 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 70 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 71 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 72 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 73 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 74 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 75 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 76 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 77 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 78 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 79 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 80 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 81 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 82 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 83 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 84 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 85 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 86 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 87 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 88 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 89 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 90 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 91 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 92 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 93 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 94 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 95 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 96 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 97 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 98 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 99 | Data1 | Data2 | Data3 | Data4 | Data5 | +| Row 100 | Data1 | Data2 | Data3 | Data4 | Data5 | From 15f0602de3b257715a9fdcaed341e33bbaaff39c Mon Sep 17 00:00:00 2001 From: Roshni Naveena S Date: Mon, 8 Jul 2024 14:22:20 +0530 Subject: [PATCH 2/5] Update ord.md --- ord.md | 204 +++++++++++++++++++++++++++++---------------------------- 1 file changed, 103 insertions(+), 101 deletions(-) diff --git a/ord.md b/ord.md index c729e81..074e849 100644 --- a/ord.md +++ b/ord.md @@ -2,9 +2,9 @@ The cap-js ORD plugin has a default behavior where all the values of the ORD document are generated automatically by the plugin without the user giving them explicitly. -If this default behavior is to be overwritten , then there are two ways in which it could be done. +If this default behavior is to be overwritten , then there are two ways in which it could be done. -For all the application level felids it is done using present configuration ( in `./cdsrc.json` under `ord` section). +For all the application level felids it is done using `present configuration` ( in `./cdsrc.json` under `ord` section). Example: @@ -35,106 +35,108 @@ annotate ProcessorService with @ORD.Extensions : { The below is the table for all the supported ORD Fields containing defaults and how to overwrite the same. +Note: `namespace` is usually taken from `.cdsrc.json` if not we take the `package.json` name. + | ORD Filed | Type | Defaults | Preset/Annotation | Usage Example | Description | |----------|----------|----------|----------|----------|----------| | openResourceDiscovery | string |- | - | - | 1.9 (generated by plugin) | -| Row 2 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 3 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 4 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 5 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 6 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 7 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 8 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 9 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 10 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 11 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 12 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 13 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 14 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 15 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 16 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 17 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 18 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 19 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 20 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 21 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 22 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 23 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 24 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 25 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 26 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 27 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 28 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 29 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 30 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 31 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 32 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 33 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 34 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 35 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 36 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 37 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 38 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 39 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 40 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 41 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 42 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 43 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 44 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 45 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 46 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 47 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 48 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 49 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 50 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 51 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 52 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 53 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 54 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 55 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 56 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 57 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 58 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 59 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 60 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 61 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 62 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 63 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 64 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 65 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 66 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 67 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 68 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 69 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 70 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 71 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 72 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 73 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 74 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 75 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 76 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 77 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 78 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 79 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 80 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 81 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 82 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 83 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 84 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 85 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 86 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 87 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 88 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 89 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 90 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 91 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 92 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 93 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 94 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 95 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 96 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 97 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 98 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 99 | Data1 | Data2 | Data3 | Data4 | Data5 | -| Row 100 | Data1 | Data2 | Data3 | Data4 | Data5 | +| policyLevel | string | ```"none"``` | Preset |```"policyLevel": "sap:core:v1"``` | The policy level (aka. compliance level) that this ORD Document or part of it needs to be compliant with. | +| description | string | ```"description": "this is an application description"``` | Preset | ```"description": "this is a custom description"``` | The description of the ORD Document itself. | +| Products Array | Array of JSON objects | ---------- | Preset ( as a full package list which will be overwritten) | ----------------- | A product in ORD is understood as a commercial product or service. | +| ordId | string | ```"ordId": "customer:product::"``` | | ```"ordId": "customer:product:sampleORDdemo:``` | The ORD ID is a stable, globally unique ID for ORD resources or taxonomy. | +| title | string | ```"title": "ORD App Title for "``` | | ```"title": "ORD App Title for sampleORDdemo"``` | Human-readable title. MUST NOT exceed 255 chars. MUST NOT contain line breaks. | +| shortDescription | string | ```"shortDescription": " shortDescription for products"``` | | ```"shortDescription": " shortDescription for products"``` | Plain text short description.MUST NOT exceed 255 chars. MUST NOT contain line breaks. | +| vendor | string | ```"vendor": "customer:vendor:SAPCustomer:"``` | | ```"vendor": "sap:vendor:SAPCustomer:"``` | Vendor / organization that is responsible for the Product. | +| Row9 | string | Data2 | | Data4 | Data5 | +| Row10 | string | Data2 | | Data4 | Data5 | +| Row11 | string | Data2 | Data3 | Data4 | Data5 | +| Row12 | string | Data2 | Data3 | Data4 | Data5 | +| Row13 | string | Data2 | Data3 | Data4 | Data5 | +| Row14 | string | Data2 | Data3 | Data4 | Data5 | +| Row15 | string | Data2 | Data3 | Data4 | Data5 | +| Row16 | string | Data2 | Data3 | Data4 | Data5 | +| Row17 | string | Data2 | Data3 | Data4 | Data5 | +| Row18 | string | Data2 | Data3 | Data4 | Data5 | +| Row19 | string | Data2 | Data3 | Data4 | Data5 | +| Row20 | string | Data2 | Data3 | Data4 | Data5 | +| Row21 | string | Data2 | Data3 | Data4 | Data5 | +| Row22 | string | Data2 | Data3 | Data4 | Data5 | +| Row23 | string | Data2 | Data3 | Data4 | Data5 | +| Row24 | string | Data2 | Data3 | Data4 | Data5 | +| Row25 | string | Data2 | Data3 | Data4 | Data5 | +| Row26 | string | Data2 | Data3 | Data4 | Data5 | +| Row27 | string | Data2 | Data3 | Data4 | Data5 | +| Row28 | string | Data2 | Data3 | Data4 | Data5 | +| Row29 | string | Data2 | Data3 | Data4 | Data5 | +| Row30 | string | Data2 | Data3 | Data4 | Data5 | +| Row31 | string | Data2 | Data3 | Data4 | Data5 | +| Row32 | string | Data2 | Data3 | Data4 | Data5 | +| Row33 | string | Data2 | Data3 | Data4 | Data5 | +| Row34 | string | Data2 | Data3 | Data4 | Data5 | +| Row35 | string | Data2 | Data3 | Data4 | Data5 | +| Row36 | string | Data2 | Data3 | Data4 | Data5 | +| Row37 | string | Data2 | Data3 | Data4 | Data5 | +| Row38 | string | Data2 | Data3 | Data4 | Data5 | +| Row39 | string | Data2 | Data3 | Data4 | Data5 | +| Row40 | string | Data2 | Data3 | Data4 | Data5 | +| Row41 | string | Data2 | Data3 | Data4 | Data5 | +| Row42 | string | Data2 | Data3 | Data4 | Data5 | +| Row43 | string | Data2 | Data3 | Data4 | Data5 | +| Row44 | string | Data2 | Data3 | Data4 | Data5 | +| Row45 | string | Data2 | Data3 | Data4 | Data5 | +| Row46 | string | Data2 | Data3 | Data4 | Data5 | +| Row47 | string | Data2 | Data3 | Data4 | Data5 | +| Row48 | string | Data2 | Data3 | Data4 | Data5 | +| Row49 | string | Data2 | Data3 | Data4 | Data5 | +| Row50 | string | Data2 | Data3 | Data4 | Data5 | +| Row51 | string | Data2 | Data3 | Data4 | Data5 | +| Row52 | string | Data2 | Data3 | Data4 | Data5 | +| Row53 | string | Data2 | Data3 | Data4 | Data5 | +| Row54 | string | Data2 | Data3 | Data4 | Data5 | +| Row55 | string | Data2 | Data3 | Data4 | Data5 | +| Row56 | string | Data2 | Data3 | Data4 | Data5 | +| Row57 | string | Data2 | Data3 | Data4 | Data5 | +| Row58 | string | Data2 | Data3 | Data4 | Data5 | +| Row59 | string | Data2 | Data3 | Data4 | Data5 | +| Row60 | string | Data2 | Data3 | Data4 | Data5 | +| Row61 | string | Data2 | Data3 | Data4 | Data5 | +| Row62 | string | Data2 | Data3 | Data4 | Data5 | +| Row63 | string | Data2 | Data3 | Data4 | Data5 | +| Row64 | string | Data2 | Data3 | Data4 | Data5 | +| Row65 | string | Data2 | Data3 | Data4 | Data5 | +| Row66 | string | Data2 | Data3 | Data4 | Data5 | +| Row67 | string | Data2 | Data3 | Data4 | Data5 | +| Row68 | string | Data2 | Data3 | Data4 | Data5 | +| Row69 | string | Data2 | Data3 | Data4 | Data5 | +| Row70 | string | Data2 | Data3 | Data4 | Data5 | +| Row71 | string | Data2 | Data3 | Data4 | Data5 | +| Row72 | string | Data2 | Data3 | Data4 | Data5 | +| Row73 | string | Data2 | Data3 | Data4 | Data5 | +| Row74 | string | Data2 | Data3 | Data4 | Data5 | +| Row75 | string | Data2 | Data3 | Data4 | Data5 | +| Row76 | string | Data2 | Data3 | Data4 | Data5 | +| Row77 | string | Data2 | Data3 | Data4 | Data5 | +| Row78 | string | Data2 | Data3 | Data4 | Data5 | +| Row79 | string | Data2 | Data3 | Data4 | Data5 | +| Row80 | string | Data2 | Data3 | Data4 | Data5 | +| Row81 | string | Data2 | Data3 | Data4 | Data5 | +| Row82 | string | Data2 | Data3 | Data4 | Data5 | +| Row83 | string | Data2 | Data3 | Data4 | Data5 | +| Row84 | string | Data2 | Data3 | Data4 | Data5 | +| Row85 | string | Data2 | Data3 | Data4 | Data5 | +| Row86 | string | Data2 | Data3 | Data4 | Data5 | +| Row87 | string | Data2 | Data3 | Data4 | Data5 | +| Row88 | string | Data2 | Data3 | Data4 | Data5 | +| Row89 | string | Data2 | Data3 | Data4 | Data5 | +| Row90 | string | Data2 | Data3 | Data4 | Data5 | +| Row91 | string | Data2 | Data3 | Data4 | Data5 | +| Row92 | string | Data2 | Data3 | Data4 | Data5 | +| Row93 | string | Data2 | Data3 | Data4 | Data5 | +| Row94 | string | Data2 | Data3 | Data4 | Data5 | +| Row95 | string | Data2 | Data3 | Data4 | Data5 | +| Row96 | string | Data2 | Data3 | Data4 | Data5 | +| Row97 | string | Data2 | Data3 | Data4 | Data5 | +| Row98 | string | Data2 | Data3 | Data4 | Data5 | +| Row99 | string | Data2 | Data3 | Data4 | Data5 | +| Row100 | string | Data2 | Data3 | Data4 | Data5 | From 9f130b8eb35a92e3d7ef91f5a55df1e7a0d9bf12 Mon Sep 17 00:00:00 2001 From: Roshni Naveena S Date: Tue, 9 Jul 2024 13:49:09 +0530 Subject: [PATCH 3/5] Update ord.md --- ord.md | 119 ++++++++++++--------------------------------------------- 1 file changed, 25 insertions(+), 94 deletions(-) diff --git a/ord.md b/ord.md index 074e849..50298e9 100644 --- a/ord.md +++ b/ord.md @@ -33,110 +33,41 @@ annotate ProcessorService with @ORD.Extensions : { ``` +Also note that annotations like `@Core.Description` and `@description` are also read. +The overwriting happens in the following priority : ord.extensions annotations > cap annotations > defaults. + The below is the table for all the supported ORD Fields containing defaults and how to overwrite the same. Note: `namespace` is usually taken from `.cdsrc.json` if not we take the `package.json` name. -| ORD Filed | Type | Defaults | Preset/Annotation | Usage Example | Description | +| ORD Field | Type | Defaults | Preset/Annotation | Usage Example | Description | |----------|----------|----------|----------|----------|----------| | openResourceDiscovery | string |- | - | - | 1.9 (generated by plugin) | | policyLevel | string | ```"none"``` | Preset |```"policyLevel": "sap:core:v1"``` | The policy level (aka. compliance level) that this ORD Document or part of it needs to be compliant with. | | description | string | ```"description": "this is an application description"``` | Preset | ```"description": "this is a custom description"``` | The description of the ORD Document itself. | -| Products Array | Array of JSON objects | ---------- | Preset ( as a full package list which will be overwritten) | ----------------- | A product in ORD is understood as a commercial product or service. | +| Products Array | Array of JSON objects | ---------- | Preset ( as a full product list which will be overwritten) | ----------------- | A product in ORD is understood as a commercial product or service. | | ordId | string | ```"ordId": "customer:product::"``` | | ```"ordId": "customer:product:sampleORDdemo:``` | The ORD ID is a stable, globally unique ID for ORD resources or taxonomy. | | title | string | ```"title": "ORD App Title for "``` | | ```"title": "ORD App Title for sampleORDdemo"``` | Human-readable title. MUST NOT exceed 255 chars. MUST NOT contain line breaks. | | shortDescription | string | ```"shortDescription": " shortDescription for products"``` | | ```"shortDescription": " shortDescription for products"``` | Plain text short description.MUST NOT exceed 255 chars. MUST NOT contain line breaks. | | vendor | string | ```"vendor": "customer:vendor:SAPCustomer:"``` | | ```"vendor": "sap:vendor:SAPCustomer:"``` | Vendor / organization that is responsible for the Product. | -| Row9 | string | Data2 | | Data4 | Data5 | -| Row10 | string | Data2 | | Data4 | Data5 | -| Row11 | string | Data2 | Data3 | Data4 | Data5 | -| Row12 | string | Data2 | Data3 | Data4 | Data5 | -| Row13 | string | Data2 | Data3 | Data4 | Data5 | -| Row14 | string | Data2 | Data3 | Data4 | Data5 | -| Row15 | string | Data2 | Data3 | Data4 | Data5 | -| Row16 | string | Data2 | Data3 | Data4 | Data5 | -| Row17 | string | Data2 | Data3 | Data4 | Data5 | -| Row18 | string | Data2 | Data3 | Data4 | Data5 | -| Row19 | string | Data2 | Data3 | Data4 | Data5 | -| Row20 | string | Data2 | Data3 | Data4 | Data5 | -| Row21 | string | Data2 | Data3 | Data4 | Data5 | -| Row22 | string | Data2 | Data3 | Data4 | Data5 | -| Row23 | string | Data2 | Data3 | Data4 | Data5 | -| Row24 | string | Data2 | Data3 | Data4 | Data5 | -| Row25 | string | Data2 | Data3 | Data4 | Data5 | -| Row26 | string | Data2 | Data3 | Data4 | Data5 | -| Row27 | string | Data2 | Data3 | Data4 | Data5 | -| Row28 | string | Data2 | Data3 | Data4 | Data5 | -| Row29 | string | Data2 | Data3 | Data4 | Data5 | -| Row30 | string | Data2 | Data3 | Data4 | Data5 | -| Row31 | string | Data2 | Data3 | Data4 | Data5 | -| Row32 | string | Data2 | Data3 | Data4 | Data5 | -| Row33 | string | Data2 | Data3 | Data4 | Data5 | -| Row34 | string | Data2 | Data3 | Data4 | Data5 | -| Row35 | string | Data2 | Data3 | Data4 | Data5 | -| Row36 | string | Data2 | Data3 | Data4 | Data5 | -| Row37 | string | Data2 | Data3 | Data4 | Data5 | -| Row38 | string | Data2 | Data3 | Data4 | Data5 | -| Row39 | string | Data2 | Data3 | Data4 | Data5 | -| Row40 | string | Data2 | Data3 | Data4 | Data5 | -| Row41 | string | Data2 | Data3 | Data4 | Data5 | -| Row42 | string | Data2 | Data3 | Data4 | Data5 | -| Row43 | string | Data2 | Data3 | Data4 | Data5 | -| Row44 | string | Data2 | Data3 | Data4 | Data5 | -| Row45 | string | Data2 | Data3 | Data4 | Data5 | -| Row46 | string | Data2 | Data3 | Data4 | Data5 | -| Row47 | string | Data2 | Data3 | Data4 | Data5 | -| Row48 | string | Data2 | Data3 | Data4 | Data5 | -| Row49 | string | Data2 | Data3 | Data4 | Data5 | -| Row50 | string | Data2 | Data3 | Data4 | Data5 | -| Row51 | string | Data2 | Data3 | Data4 | Data5 | -| Row52 | string | Data2 | Data3 | Data4 | Data5 | -| Row53 | string | Data2 | Data3 | Data4 | Data5 | -| Row54 | string | Data2 | Data3 | Data4 | Data5 | -| Row55 | string | Data2 | Data3 | Data4 | Data5 | -| Row56 | string | Data2 | Data3 | Data4 | Data5 | -| Row57 | string | Data2 | Data3 | Data4 | Data5 | -| Row58 | string | Data2 | Data3 | Data4 | Data5 | -| Row59 | string | Data2 | Data3 | Data4 | Data5 | -| Row60 | string | Data2 | Data3 | Data4 | Data5 | -| Row61 | string | Data2 | Data3 | Data4 | Data5 | -| Row62 | string | Data2 | Data3 | Data4 | Data5 | -| Row63 | string | Data2 | Data3 | Data4 | Data5 | -| Row64 | string | Data2 | Data3 | Data4 | Data5 | -| Row65 | string | Data2 | Data3 | Data4 | Data5 | -| Row66 | string | Data2 | Data3 | Data4 | Data5 | -| Row67 | string | Data2 | Data3 | Data4 | Data5 | -| Row68 | string | Data2 | Data3 | Data4 | Data5 | -| Row69 | string | Data2 | Data3 | Data4 | Data5 | -| Row70 | string | Data2 | Data3 | Data4 | Data5 | -| Row71 | string | Data2 | Data3 | Data4 | Data5 | -| Row72 | string | Data2 | Data3 | Data4 | Data5 | -| Row73 | string | Data2 | Data3 | Data4 | Data5 | -| Row74 | string | Data2 | Data3 | Data4 | Data5 | -| Row75 | string | Data2 | Data3 | Data4 | Data5 | -| Row76 | string | Data2 | Data3 | Data4 | Data5 | -| Row77 | string | Data2 | Data3 | Data4 | Data5 | -| Row78 | string | Data2 | Data3 | Data4 | Data5 | -| Row79 | string | Data2 | Data3 | Data4 | Data5 | -| Row80 | string | Data2 | Data3 | Data4 | Data5 | -| Row81 | string | Data2 | Data3 | Data4 | Data5 | -| Row82 | string | Data2 | Data3 | Data4 | Data5 | -| Row83 | string | Data2 | Data3 | Data4 | Data5 | -| Row84 | string | Data2 | Data3 | Data4 | Data5 | -| Row85 | string | Data2 | Data3 | Data4 | Data5 | -| Row86 | string | Data2 | Data3 | Data4 | Data5 | -| Row87 | string | Data2 | Data3 | Data4 | Data5 | -| Row88 | string | Data2 | Data3 | Data4 | Data5 | -| Row89 | string | Data2 | Data3 | Data4 | Data5 | -| Row90 | string | Data2 | Data3 | Data4 | Data5 | -| Row91 | string | Data2 | Data3 | Data4 | Data5 | -| Row92 | string | Data2 | Data3 | Data4 | Data5 | -| Row93 | string | Data2 | Data3 | Data4 | Data5 | -| Row94 | string | Data2 | Data3 | Data4 | Data5 | -| Row95 | string | Data2 | Data3 | Data4 | Data5 | -| Row96 | string | Data2 | Data3 | Data4 | Data5 | -| Row97 | string | Data2 | Data3 | Data4 | Data5 | -| Row98 | string | Data2 | Data3 | Data4 | Data5 | -| Row99 | string | Data2 | Data3 | Data4 | Data5 | -| Row100 | string | Data2 | Data3 | Data4 | Data5 | +| groups Array | Array of JSON objects | - | - | - | Group (instance) that resources can be assigned to.hey express a "part of" relationship to the chosen group concept. | +| groupId | string | ```"groupId": "sap.cds:service:customer.:sap.capire.incidents.ProcessorService"``` | - | - | The Group ID consists of two Concept IDs separated by a `:`. | +| groupTypeId | string | ```"groupTypeId": "sap.cds:service"``` | - | - | Group Type ID. | +| title | string | ```"title": "This is Processor Service title"```| Annotation | ```annotate AdminService with @ORD.Extensions : {title : 'This is Admin Service title'};``` | Human readable title of the group assignment (for UI). | +| packages | Array of JSON objects | - | Present (as a full product list which will be overwritten) | - | A Package organizes a set of related resources together, by publishing and catalog presentation concerns. | +| ordId | string | ```"ordId":"customer.:package::v1"``` | | | The ORD ID is a stable, globally unique ID for ORD resources or taxonomy. | +| title | string | ```"title": "sample title for "``` | - | - | Human-readable title.MUST NOT exceed 255 chars. MUST NOT contain line breaks. | +| shortDescription | string | ```"shortDescription": "Here is the shortDescription for packages"``` | - | - | Plain text short description.MUST NOT exceed 255 chars. MUST NOT contain line breaks. | +| description | string | ```"description": "Here is the description for packages",``` | - | - | Full description, notated in CommonMark (Markdown). | +| version | string | ```"version": "1.0.0"``` | - | - | The complete SemVer version string. | +| partOfProducts | Array of strings | ```"partOfProducts": ["customer:product::"]``` | - | - | List of products this resource is a part of. | +| vendor | string | ```"vendor": "customer:vendor:SAP:"``` | - | - | Vendor / organization that is the creator (or responsible party) of the resources that are part of the Package. | +| consumptionBundles | string | Array of JSON objects | Present (as a full consumptionBundles list which will be overwritten) | - | A Consumption Bundle groups APIs and Events together that can be consumed with the credentials and auth mechanism. Ideally it also includes instructions and details how to request access and credentials for resources. | +| ordId | string | ```"ordId": "customer.:consumptionBundle:unknown:v1"``` | - | - | The ORD ID is a stable, globally unique ID for ORD resources or taxonomy. | +| version | string | ```"version": "1.0.0"``` | - | - | The complete SemVer version string. | +| title | string | ```"title": "Unprotected resources"``` | - | - | Human-readable title.MUST NOT exceed 255 chars. MUST NOT contain line breaks. | +| shortDescription | string | ```"shortDescription": "If we have another protected API then it will be another object"``` | - | - | Plain text short description.MUST NOT exceed 255 chars.MUST NOT contain line breaks. | +| description | string | ```"description": "This Consumption Bundle contains all resources of the reference app which are unprotected and do not require authentication"``` | - | - | Full description, notated in CommonMark (Markdown) | +| apiResources | Array of JSON Objects | | Cannot be modified by the user ( The plugin generates based on the number of services defined in the CAP Application) | | The API Resource provides a high-level description of an exposed API. | +| eventResources | Array of JSON Objects | - | Cannot be modified by the user ( The plugin generates based on the number of services that have events defined in the CAP Application) | | The event resource provides a high-level description of a collection of related Events. More detailed information, such as the event resource definitions. | From fb5a64a206869381df3572e42c24f2c84c0f37cf Mon Sep 17 00:00:00 2001 From: Roshni Naveena S Date: Tue, 9 Jul 2024 15:07:15 +0530 Subject: [PATCH 4/5] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7589441..8743364 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,10 @@ cds compile --to ord [-o] [destinationFilePath] Sample Application Demo +### Customizing ORD Document + +You can find more information, such as how to customize the ORD Document, in this [document](ord.md). + ## Support, Feedback, Contributing From 36f3fee68c9308de61c9d91a8bd3331e03d3340f Mon Sep 17 00:00:00 2001 From: Roshni Naveena S Date: Wed, 10 Jul 2024 16:09:40 +0530 Subject: [PATCH 5/5] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8743364..ceebd7d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/cds-plugin-for-ord)](https://api.reuse.software/info/github.com/cap-js/cds-plugin-for-ord) +[![REUSE status](https://api.reuse.software/badge/github.com/cap-js/ord)](https://api.reuse.software/info/github.com/cap-js/cds-plugin-for-ord) # CDS Plugin for ORD