Skip to content

Commit a3dfa92

Browse files
stefan-kastefan-ka
committed
Update MDSL doc page (syntax change: V -> D)
1 parent 86dcaa6 commit a3dfa92

9 files changed

+34
-34
lines changed

‎_docs/generators/mdsl.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The base/primitive types are mapped as follows:
2828

2929
| CML type | MDSL type |
3030
|------------------|---------------------------------------------|
31-
| String | V<string> |
32-
| int or Integer | V<int> |
33-
| long or Long | V<long> |
34-
| double or Double | V<double> |
35-
| boolean | V<bool> |
36-
| Blob | V<blob> |
37-
| Date | V<string> (no date available in MDSL) |
31+
| String | D<string> |
32+
| int or Integer | D<int> |
33+
| long or Long | D<long> |
34+
| double or Double | D<double> |
35+
| boolean | D<bool> |
36+
| Blob | D<blob> |
37+
| Date | D<string> (no date available in MDSL) |
3838

3939
<div class="alert alert-custom">
4040
<strong>Note:</strong> Types in CML are case sensitive. For example: If you write "string" instead of "String", you create a new abstract
@@ -54,7 +54,7 @@ Entity Address {
5454
}
5555
```
5656
MDSL data type result:
57-
<div class="highlight"><pre><span></span><span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lockbox&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;?, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
57+
<div class="highlight"><pre><span></span><span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lockbox&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;?, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
5858
</pre></div>
5959

6060
All abstract data types which are not base types and not specified in CML (no references to objects) will produce an abstract,
@@ -68,9 +68,9 @@ An example [MDSL](https://socadk.github.io/MDSL/) API description looks as follo
6868
<span class="k">API description</span> CustomerManagementContextAPI
6969
<span class="k">usage context</span> <span class="k">PUBLIC_API</span> <span class="k">for</span> <span class="k">BACKEND_INTEGRATION</span>
7070

71-
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
71+
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
7272
<span class="k">data type</span> AddressId <span class="k">P</span>
73-
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
73+
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
7474

7575
<span class="k">endpoint type</span> CustomersAggregate
7676
<span class="k">serves as</span> <span class="k">INFORMATION_HOLDER_RESOURCE</span>
@@ -86,7 +86,7 @@ An example [MDSL](https://socadk.github.io/MDSL/) API description looks as follo
8686
<span class="k">expecting</span>
8787
<span class="k">payload</span> changeCustomerParameter
8888
<span class="k">delivering</span>
89-
<span class="k">payload</span> V&lt;<span class="k">bool</span>&gt;
89+
<span class="k">payload</span> D&lt;<span class="k">bool</span>&gt;
9090

9191
<span class="c">// Generated from DDD upstream Bounded Context &#39;CustomerManagementContext&#39; implementing OPEN_HOST_SERVICE (OHS) and PUBLISHED_LANGUAGE (PL).</span>
9292
<span class="k">API provider</span> CustomerManagementContextProvider
@@ -150,9 +150,9 @@ end the four different protected regions:
150150

151151
<span class="c">// ** END PROTECTED REGION for data types</span>
152152

153-
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
153+
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
154154
<span class="k">data type</span> AddressId <span class="k">P</span>
155-
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
155+
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
156156

157157
<span class="c">// ** BEGIN PROTECTED REGION for endpoint types</span>
158158

@@ -172,7 +172,7 @@ end the four different protected regions:
172172
<span class="k">expecting</span>
173173
<span class="k">payload</span> changeCustomerParameter
174174
<span class="k">delivering</span>
175-
<span class="k">payload</span> V&lt;<span class="k">bool</span>&gt;
175+
<span class="k">payload</span> <span class="k">D</span>&lt;<span class="k">bool</span>&gt;
176176

177177
<span class="c">// ** BEGIN PROTECTED REGION for API providers</span>
178178

@@ -213,12 +213,12 @@ if you changed the data types manually after generation and want to protect them
213213

214214
<span class="c">// ** BEGIN PROTECTED REGION for data types</span>
215215

216-
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;manuallyChangedThisDataType&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
216+
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;manuallyChangedThisDataType&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
217217

218218
<span class="c">// ** END PROTECTED REGION for data types</span>
219219

220220
<span class="k">data type</span> AddressId <span class="k">P</span>
221-
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
221+
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
222222

223223
<span class="c">// removed the rest here to save space ...</span>
224224

‎_mdsls/data-type-1.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
<div class="highlight"><pre><span></span><span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lockbox&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;?, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
1+
<div class="highlight"><pre><span></span><span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lockbox&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;?, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
22
</pre></div>

‎_mdsls/data-type-1.mdsl

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
data type Address { "street":V<string>, "lockbox":V<string>?, "postalCode":V<int>, "city":V<string> }
1+
data type Address { "street":D<string>, "lockbox":D<string>?, "postalCode":D<int>, "city":D<string> }

‎_mdsls/insurance-example-full.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
<span class="c">// ** END PROTECTED REGION for data types</span>
88

9-
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
9+
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
1010
<span class="k">data type</span> AddressId <span class="k">P</span>
11-
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
11+
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
1212

1313
<span class="c">// ** BEGIN PROTECTED REGION for endpoint types</span>
1414

@@ -28,7 +28,7 @@
2828
<span class="k">expecting</span>
2929
<span class="k">payload</span> changeCustomerParameter
3030
<span class="k">delivering</span>
31-
<span class="k">payload</span> V&lt;<span class="k">bool</span>&gt;
31+
<span class="k">payload</span> <span class="k">D</span>&lt;<span class="k">bool</span>&gt;
3232

3333
<span class="c">// ** BEGIN PROTECTED REGION for API providers</span>
3434

‎_mdsls/insurance-example-full.mdsl

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ usage context PUBLIC_API for BACKEND_INTEGRATION
66

77
// ** END PROTECTED REGION for data types
88

9-
data type Address { "street":V<string>, "postalCode":V<int>, "city":V<string> }
9+
data type Address { "street":D<string>, "postalCode":D<int>, "city":D<string> }
1010
data type AddressId P
11-
data type changeCustomerParameter { "firstname":V<string>, "lastname":V<string> }
11+
data type changeCustomerParameter { "firstname":D<string>, "lastname":D<string> }
1212

1313
// ** BEGIN PROTECTED REGION for endpoint types
1414

@@ -28,7 +28,7 @@ endpoint type CustomersAggregate
2828
expecting
2929
payload changeCustomerParameter
3030
delivering
31-
payload V<bool>
31+
payload D<bool>
3232

3333
// ** BEGIN PROTECTED REGION for API providers
3434

‎_mdsls/insurance-example-protected-types.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
<span class="c">// ** BEGIN PROTECTED REGION for data types</span>
66

7-
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;manuallyChangedThisDataType&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
7+
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;manuallyChangedThisDataType&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
88

99
<span class="c">// ** END PROTECTED REGION for data types</span>
1010

1111
<span class="k">data type</span> AddressId <span class="k">P</span>
12-
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
12+
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
1313

1414
<span class="c">// removed the rest here to save space ...</span>
1515

‎_mdsls/insurance-example-protected-types.mdsl

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ usage context PUBLIC_API for BACKEND_INTEGRATION
44

55
// ** BEGIN PROTECTED REGION for data types
66

7-
data type Address { "street":V<string>, "postalCode":V<int>, "city":V<string>, "manuallyChangedThisDataType":V<string> }
7+
data type Address { "street":D<string>, "postalCode":D<int>, "city":D<string>, "manuallyChangedThisDataType":D<string> }
88

99
// ** END PROTECTED REGION for data types
1010

1111
data type AddressId P
12-
data type changeCustomerParameter { "firstname":V<string>, "lastname":V<string> }
12+
data type changeCustomerParameter { "firstname":D<string>, "lastname":D<string> }
1313

1414
// removed the rest here to save space ...
1515

‎_mdsls/insurance-example.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<span class="k">API description</span> CustomerManagementContextAPI
33
<span class="k">usage context</span> <span class="k">PUBLIC_API</span> <span class="k">for</span> <span class="k">BACKEND_INTEGRATION</span>
44

5-
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">V</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
5+
<span class="k">data type</span> Address { <span class="s">&quot;street&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;postalCode&quot;</span>:<span class="k">D</span>&lt;<span class="k">int</span>&gt;, <span class="s">&quot;city&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
66
<span class="k">data type</span> AddressId <span class="k">P</span>
7-
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">V</span>&lt;<span class="k">string</span>&gt; }
7+
<span class="k">data type</span> changeCustomerParameter { <span class="s">&quot;firstname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt;, <span class="s">&quot;lastname&quot;</span>:<span class="k">D</span>&lt;<span class="k">string</span>&gt; }
88

99
<span class="k">endpoint type</span> CustomersAggregate
1010
<span class="k">serves as</span> <span class="k">INFORMATION_HOLDER_RESOURCE</span>
@@ -20,7 +20,7 @@
2020
<span class="k">expecting</span>
2121
<span class="k">payload</span> changeCustomerParameter
2222
<span class="k">delivering</span>
23-
<span class="k">payload</span> V&lt;<span class="k">bool</span>&gt;
23+
<span class="k">payload</span> D&lt;<span class="k">bool</span>&gt;
2424

2525
<span class="c">// Generated from DDD upstream Bounded Context &#39;CustomerManagementContext&#39; implementing OPEN_HOST_SERVICE (OHS) and PUBLISHED_LANGUAGE (PL).</span>
2626
<span class="k">API provider</span> CustomerManagementContextProvider

‎_mdsls/insurance-example.mdsl

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
API description CustomerManagementContextAPI
33
usage context PUBLIC_API for BACKEND_INTEGRATION
44

5-
data type Address { "street":V<string>, "postalCode":V<int>, "city":V<string> }
5+
data type Address { "street":D<string>, "postalCode":D<int>, "city":D<string> }
66
data type AddressId P
7-
data type changeCustomerParameter { "firstname":V<string>, "lastname":V<string> }
7+
data type changeCustomerParameter { "firstname":D<string>, "lastname":D<string> }
88

99
endpoint type CustomersAggregate
1010
serves as INFORMATION_HOLDER_RESOURCE
@@ -20,7 +20,7 @@ endpoint type CustomersAggregate
2020
expecting
2121
payload changeCustomerParameter
2222
delivering
23-
payload V<bool>
23+
payload D<bool>
2424

2525
// Generated from DDD upstream Bounded Context 'CustomerManagementContext' implementing OPEN_HOST_SERVICE (OHS) and PUBLISHED_LANGUAGE (PL).
2626
API provider CustomerManagementContextProvider

0 commit comments

Comments
 (0)