Release v5.1.2

Author: socadk

.travis.yml

@@ -1,9 +1,9 @@
-Microservice Domain-Specific Language (MDSL) 5.0
+Microservice Domain-Specific Language (MDSL) 5.1
 ================================================
 
-[![Build Status](https://travis-ci.com/Microservice-API-Patterns/MDSL-Specification.svg?branch=master)](https://travis-ci.com/Microservice-API-Patterns/MDSL-Specification) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
-Author: Olaf Zimmermann, (c) 2018-2020. All rights reserved.
+Author: Olaf Zimmermann, (c) 2018-2021. All rights reserved.
 
 ## What is MDSL?
 
@@ -39,10 +39,10 @@ These two languages can be used independently of each other; for instance, data
 
 ## Getting Started
 
-* Presentations featuring Context Mapper, MAP and MDSL can be found [here](https://ozimmer.ch/papers/).
-* The [GitHub Pages for MDSL](https://microservice-api-patterns.github.io/MDSL-Specification) provide a tutorial and language reference information.
+* The [GitHub Pages for MDSL](https://microservice-api-patterns.github.io/MDSL-Specification) provide a tutorial and language reference information.<!-- * There is a [Project Wiki](https://github.com/Microservice-API-Patterns/MDSL-Specification/wiki/Getting-Started-with-MDSL), which is not populated much (yet) and not kept up to date as much as the GitHub pages. -->
 * There is an [Eclipse update site](https://microservice-api-patterns.github.io/MDSL-Specification/updates/) for the MDSL editor. 
-* All generators are available via a Command Line Interface (CLI) now; see [this readme](./dsl-core/io.mdsl.cli/README.md) and [these examples](./examples/mdsl-standalone-example).
+* All generators are available via a Command Line Interface (CLI); see [this readme](./dsl-core/io.mdsl.cli/README.md) and [these examples](./examples/mdsl-standalone-example).
+* Presentations featuring Context Mapper, MAP and MDSL can be found [here](https://ozimmer.ch/papers/), and an [end-to-end demo](https://medium.com/olzzio/domain-driven-service-design-with-context-mapper-and-mdsl-d5a0fc6091c2) is available on Medium.
 * As a contributor, please consult the [readme file of the dsl-core](./dsl-core/README.md) project for getting started information and prerequisites.
 
 
@@ -54,7 +54,7 @@ These two languages can be used independently of each other; for instance, data
 * [Data types](https://microservice-api-patterns.github.io/MDSL-Specification/datacontract) (a.k.a. published language)
 * [Instance-level concepts](https://microservice-api-patterns.github.io/MDSL-Specification/optionalparts) (provider, client, gateway)
 
-<!-- An implemented proposal of a language extension supporting queue-based messaging endpoints is [AsyncMDSL](https://github.com/giacomodeliberali/MDSL/tree/master/examples/asyncMDSL).-->
+<!-- A language extension supporting queue-based messaging endpoints is [AsyncMDSL](https://github.com/giacomodeliberali/MDSL/tree/master/examples/asyncMDSL).-->
 
 
 ## Repository Structure 
@@ -74,15 +74,10 @@ If you want to contribute to MDSL, you have to clone this repo and generate the
 
 ## Change Log
 
-The current version of the MDSL language is 5.0; the tool version is 5.0.1. This MDSL version extends service contracts with support for events, states, flows, compensation. It also supports true REST level 3 concepts both on the abstract endpoint type level and in the redesigned bindings.
+The current version of the MDSL language is 5.1; the tool version is 5.1.2. This MDSL version extends service contracts with support for events, states, flows, compensation (as experimental technology previews). It also supports true REST level 3 concepts both on the abstract endpoint type level and in the redesigned bindings and comes with additional Fremarker generators (Markdown reports, ALPS).
 
 See [change log](changelog.md) for an evolution history; see GitHub [release notes](https://github.com/Microservice-API-Patterns/MDSL-Specification/releases) for additional update information.
 
-<!--
-A possible roadmap for language and tools is (subject to change at any time): 
-
-* to be continued
--->
 
 ## Context Information: MAP and Xtext
 
@@ -103,15 +98,16 @@ Feedback and contributions welcome!
 
 ##  Acknowledgements 
 
-The creation and release of MDSL 4 was supported by the [Hasler Foundation](https://haslerstiftung.ch/en/welcome-to-the-hasler-foundation/).
-
 Contributors (input, DevOps support, feedback): 
 
-* [Olaf Zimmermann (ZIO)](https://ozimmer.ch)
+* Giacomo De Liberali (AsyncMDSL language, AsyncAPI generator)
 * Stefan Kapferer (also the author of the [MDSL generator in Context Mapper](https://contextmapper.org/docs/mdsl/))
 * MAP co-authors: Mirko Stocker, Daniel Lübke, Cesare Pautasso, Uwe Zdun
-* Giacomo De Liberali and bachelor/master students at HSR/OST  
-* Microservices 2019 and VSS 2019 conference participants 
+* Bachelor/master students at HSR/OST  
+* Microservices 2019 and [VSS 2019](https://www.computer.org/csdl/magazine/so/2020/01/08938118/1fUSO0QBDnW) conference participants 
+* Early adopters and reviewers
+
+The creation and release of MDSL 4 in 2020 was supported by the [Hasler Foundation](https://haslerstiftung.ch/en/welcome-to-the-hasler-foundation/).
 
 
 ## Getting involved 
@@ -127,4 +123,6 @@ https://github.com/cloudevents/spec/blob/master/CONTRIBUTING.md
 
 -->
 
-*Copyright: Olaf Zimmermann, 2019-2020. All rights reserved. See [license information](/LICENSE).*
+-- [Olaf Zimmermann (ZIO)](https://ozimmer.ch)
+
+*Copyright: The author, 2019-2021. All rights reserved. See [license information](/LICENSE).*

README.md

@@ -0,0 +1,44 @@
+<!--
+# SPDX-FileCopyrightText: 2020 Copyright Olaf Zimmermann https://ozimmer.ch/about/
+#
+# SPDX-License-Identifier: CC-BY-4.0
+-->
+
+<h2>1. Terms</h2>
+
+<p>By accessing this website and repository, accessible from https://github.com/Microservice-API-Patterns/MDSL-Specification/, you are agreeing to be bound by these Terms and Conditions of Use and agree that you are responsible for the agreement with any applicable local laws. If you disagree with any of these terms, you are prohibited from accessing this site. The materials contained in this Website and repository are protected by copyright and trade mark law.</p>
+
+<h2>2. Use License</h2>
+
+<p>See separate <a href="./LICENSE">LICENSE</a> file and bottom of this page.</p>
+
+<h2>3. Disclaimer</h2>
+
+<p>All the materials are provided "as is". The authors make no warranties, may it be expressed or implied, therefore negates all other warranties. Furthermore, the authors do not make any representations concerning the accuracy or reliability of the use of the materials or otherwise relating to such materials or any sites linked.</p>
+
+<h2>4. Limitations</h2>
+
+<p>The author(s) of this website and repository will not be hold accountable for any damages that will arise with the use or inability to use the materials on it, even if they or an authorized representative of the authors has been notified, orally or written, of the possibility of such damage. Some jurisdiction does not allow limitations on implied warranties or limitations of liability for incidental damages, these limitations may not apply to you.</p>
+
+<h2>5. Revisions and Errata</h2>
+
+<p>The materials appearing in this website and repository may include technical, typographical, or photographic errors. The author(s) will not promise that any of the materials in this website and repository are accurate, complete, or current. Author(s) may change the materials contained on this website and repository at any time without notice. The author(s) does not make any commitment to update the materials.</p>
+
+<h2>6. Links</h2>
+
+<p>The authors have not reviewed all of the sites linked to this website and repository and are not responsible for the contents of any such linked site. The presence of any link does not imply endorsement of the site. The use of any linked website is at the user’s own risk.</p>
+
+<h2>7. Site Terms of Use Modifications</h2>
+
+<p>The authors may revise these Terms of Use for its website and repository at any time without prior notice. By using this website and repository, you are agreeing to be bound by the current version of these Terms and Conditions of Use.</p>
+
+<h2>8. Governing Law</h2>
+
+<p>Any claim related to this website and repository shall be governed by the laws of Switzerland without regards to its conflict of law provisions.</p>
+
+<p>These Terms and Conditions are based on the <a href="https://termsofservicegenerator.net"> World's Free Terms Of Service Generator.</a></p>
+
+
+### License
+
+See separate [LICENSE](LICENSE) file.

TERMS.md

@@ -2,6 +2,13 @@
 
 Also see GitHub [release notes](https://github.com/Microservice-API-Patterns/MDSL-Specification/releases).
 
+V5.1, March to May 2021
+
+* Freemarker template for ALPS and API Description (Markdown)
+* GitPages for AsyncMDSL
+* CLI enhancements
+* CI/CD adjustments
+
 V5.0, December 2020
 
 * Extended HTTP binding: new resource concept, media types, security policies, (error, status) reporting, HATEOAS links (technology preview)

changelog.md

@@ -1,5 +1,5 @@
 ---
-title: Asynchronous Microservice Domain-Specific Language (AsynchMDSL)
+title: Asynchronous Microservice Domain-Specific Language (AsyncMDSL)
 author: Giacomo Di Liberali, Olaf Zimmermann
 copyright: The authors, 2020-2021.  All rights reserved.
 ---
@@ -9,7 +9,7 @@ copyright: The authors, 2020-2021.  All rights reserved.
 AsyncMDSL
 =========
 
-_Note:_ The status of the Asynchronous Microservice Domain Specific Language (AsynchMDSL), created by Giacomo Di Liberali, is [*Technology Preview*](https://microservice-api-patterns.org/patterns/evolution/ExperimentalPreview.html), standing at Version 1.1 at present.
+_Note:_ The status of the Asynchronous Microservice Domain Specific Language (AsyncMDSL), created by Giacomo Di Liberali, is [*Technology Preview*](https://microservice-api-patterns.org/patterns/evolution/ExperimentalPreview.html), standing at Version 1.1 at present.
 
 AsyncMDSL aims at modeling asynchronous, messaging APIs while exploiting the [design goals of core MDSL](./index). Extending core MDSL, AsyncMDSL derives its abstract syntax from the state-of-the-art patterns and concepts described in the [Enterprise Integration Patterns](https://www.enterpriseintegrationpatterns.com/) book. The language is fully specified in Giacomo Di Liberali's  [master thesis](UNIPI-AsyncMDSL-MasterThesis-2020-GiacomoDeLiberali-v1.3.pdf).
 
@@ -79,13 +79,13 @@ bindings for [protocol] {
     Invalid combinations will be notified by the API Linter that comes with the [editor and generator plugin](./generators/async-api) for ASyncMDSL.
 
 - 
-    A channel deliveryGuarantee can be any of:
+    A channel delivery guarantee can be any of:
     > UNKNOWN | AT_LEAST_ONCE | AT_MOST_ONCE | EXACTLY_ONCE
 
 #### Channel path
 
 - 
-    A path param type can assume any of teh basic data types of MDSL:
+    A path param type can assume any of the basic data types of MDSL:
     > bool | int | long | double | string
 
 #### Message
@@ -108,7 +108,7 @@ bindings for [protocol] {
 
 - Protocol can assume one of the [supported protocols](./bindings). As the list of properties is protocol-specific, a single flat JSON object is expected as configuration.
 
-An example of a _binding_ definition can be found in [examples/AsyncMDSL/bindings.mdsl](../examples/AsyncMDSL/bindings.mdsl).
+An example of a _binding_ definition can be found in [examples/AsyncMDSL/bindings.mdsl](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/examples/asyncMDSL/bindings.mdsl).
 
 #### Channel definition example
 
@@ -199,7 +199,7 @@ exposes
     > Notice that no protocol-specific validation is applied.
 
 - 
-    Security policy type. MDSL security policies are not yet fully supported. The available values are:
+    Security policy type. MDSL security policies are not fully supported yet. The available values are:
     > JWT | API_KEY 
 
     <!-- TODO OAS binding does a lot more since core MDSL 5.0, could bring some of that support here -->
@@ -239,4 +239,4 @@ Valid AsyncMDSL specifications can be mapped to [AsyncAPI](https://www.asyncapi.
 
 *See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
 
-<!-- *EOF* -->
+<!-- *EOF* -->

docs/async-mdsl.md

@@ -1,7 +1,7 @@
 ---
 title: Microservice Domain Specific Language (MDSL) Bindings
 author: Olaf Zimmermann
-copyright: Olaf Zimmermann, 2019-2020. All rights reserved.
+copyright: Olaf Zimmermann, 2019-2021. All rights reserved.
 ---
 
 [Home](./index) — [Endpoint Type](./servicecontract) — [Data Types](./datacontract) — [Provider and Client](./optionalparts) — [Tutorial](./tutorial) — [Cheat Sheet](./quickreference) — [Tools](./tools)
@@ -156,6 +156,6 @@ Language specification pages:
 * [Data contracts (schemas)](./datacontract)
 * Other [runtime concepts](./optionalparts)
 
-*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
+*Copyright: Olaf Zimmermann, 2018-2021. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
 
 <!-- *EOF* -->

docs/bindings.md

@@ -1,7 +1,7 @@
 ---
 title: Microservice Domain Specific Language (MDSL) Data Contracts
 author: Olaf Zimmermann
-copyright: Olaf Zimmermann, 2019-2020. All rights reserved.
+copyright: Olaf Zimmermann, 2019-2021. All rights reserved.
 ---
 
 [Home](./index) — [Endpoint Type](./servicecontract) — [Provider and Client](./optionalparts) — [Bindings](./bindings) — [Tutorial](./tutorial) — [Cheat Sheet](./quickreference) — [Tools](./tools)
@@ -265,6 +265,6 @@ Note that some combinations are syntactically possible at present (to simplify t
 * [Quick reference](./quickreference), [tutorial](./tutorial) and [tools](./tools)
 * Back to [MDSL homepage](./index).
 
-*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
+*Copyright: Olaf Zimmermann, 2018-2021. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
 
 <!-- *EOF* -->

docs/datacontract.md

@@ -93,6 +93,6 @@ Back to [MDSL homepage](./index).
 
 More examples in [public](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples) and in [private](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples) repository.
 
-*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
+*Copyright: Olaf Zimmermann, 2018-2021. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
 
 <!-- *EOF* -->

docs/examples.md

@@ -294,4 +294,4 @@ Also checkout our other generators:
     * [Bindings](./../bindings) and [instance-level concepts](./../optionalparts). 
 * Back to [MDSL homepage](./../index).
 
-*Copyright: See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
+*Copyright: See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*

docs/generators/async-api.md

@@ -1,9 +1,11 @@
 ---
 title: Microservice Domain Specific Language (MDSL) to Arbitrary Text (via Freemarker Template)
 author: Stefan Kapferer
-copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved.
+copyright: Stefan Kapferer and Olaf Zimmermann, 2020-2021. All rights reserved.
 ---
 
+[Tools Overview](./../tools), [OpenAPI](./open-api), [Protocol Buffers](./protocol-buffers), [GraphQL](./graphql), [Jolie](./jolie), [Java](./java), [AsyncAPI](./async-api)
+
 Arbitrary Text Generation with Freemarker Templates
 ===================================================
 The MDSL Eclipse plugin and the CLI allow API designers to generate arbitrary text files out of MDSL by using a [Freemarker](https://freemarker.apache.org/) template.
@@ -30,7 +32,7 @@ The following example illustrates what the generator can produce for an exemplar
 
 You find the complete sources (incl. generated text file) of this example [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/freemarker-example).
 
-We use the following MDSL model which was an outcome of this [blogpost](https://ozimmer.ch/practices/2020/06/10/ICWEKeynoteAndDemo.html) to illustrate our generator outputs:
+The following MDSL model, taken from this [blogpost](https://ozimmer.ch/practices/2020/06/10/ICWEKeynoteAndDemo.html), illustrates the generator usage:
 
 ```
 API description ReferenceManagementServiceAPI
@@ -61,7 +63,7 @@ endpoint type PaperArchiveFacade
         payload D<string>
 ```
 
-We further use the following Freemarker template to generate some exemplary output:
+Let us use the following very basic Freemarker template to generate some exemplary output from the above MDSL:
 
 ```ftl
 # Report for MDSL specification ${fileName}
@@ -75,9 +77,9 @@ The API description ${genModel.apiName} features the following endpoint types (a
 </#list>
 ```
 
-The template aims at generating a markdown report listing the available endpoints.
+The template simply generates a markdown report listing the available endpoints.
 
-Applied to the model above, the generator produces the following markdown file:
+Applied to the `ReferenceManagementServiceAPI` description above, the generator produces the following markdown file:
 
 ```markdown
 # Report for MDSL specification ReferenceManagementAPI.mdsl
@@ -89,11 +91,12 @@ The API description ReferenceManagementServiceAPI features the following endpoin
 * PaperArchiveFacade
 ```
 
-You find the complete sources (incl. generated text file) of this example [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/freemarker-example).
+You find the complete sources (incl. generated text file) of this and other examples [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/freemarker-example).
 
 The entire MDSL grammar is available as a data model to the Freemarker templating feature.  
 
-More examples of Freemarker templates can be found [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/generator-templates).
+<!-- removed in V.511 (example folders merged):
+More examples of Freemarker templates can be found [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/generator-templates). -->
 
 
 ## Generator Model for Freemarker Templating and Model Exports
@@ -112,7 +115,7 @@ This model can also be exported for offline processing (for instance, to feed ot
 
 # Other Generators
 Also checkout our other generators:
-* [Open API generator](./open-api)
+* [OpenAPI generator](./open-api)
 * [Protocol Buffers generator](./protocol-buffers)
 * [GraphQL generator](./graphql)
 * [Jolie generator](./jolie)
@@ -126,4 +129,4 @@ Also checkout our other generators:
     * [Bindings](./../bindings) and [instance-level concepts](./../optionalparts). 
 * Back to [MDSL homepage](./../index).
 
-*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
+*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020-2021. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*