Skip to content

Commit 11b53e1

Browse files
author
socadk
committed
Doc and repo links updated for public Version 4.2
1 parent 57118f2 commit 11b53e1

17 files changed

+46
-99
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,19 +40,19 @@ These two languages can be used independently of each other; for instance, data
4040
## Getting Started
4141

4242
* Presentations featuring Context Mapper, MAP and MDSL can be found [here](https://ozimmer.ch/papers/).
43-
* The [GitHub Pages for MDSL](https://socadk.github.io/MDSL) provide a tutorial and language reference information.<!-- * There is a [Project Wiki](https://github.com/socadk/MDSL/wiki/Getting-Started-with-MDSL), which is not populated much (yet) and not kept up to date as much as the GitHub pages. -->
44-
* There is an [Eclipse update site](https://socadk.github.io/MDSL/updates/) for the MDSL editor.
43+
* 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. -->
44+
* There is an [Eclipse update site](https://microservice-api-patterns.github.io/MDSL-Specification/updates/) for the MDSL editor.
4545
* 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).
4646
* As a contributor, please consult the [readme file of the dsl-core](./dsl-core/README.md) project for getting started information and prerequisites.
4747

4848

4949
## Language Specification
5050

51-
* [Overview](https://socadk.github.io/MDSL)
52-
* [Endpoint types](https://socadk.github.io/MDSL/servicecontract) (a.k.a. ports)
53-
* [Bindings](https://socadk.github.io/MDSL/bindings) (a.k.a. adapters)
54-
* [Data types](https://socadk.github.io/MDSL/datacontract) (a.k.a. published language)
55-
* [Instance-level concepts](https://socadk.github.io/MDSL/optionalparts) (provider, client, gateway)
51+
* [Overview](https://microservice-api-patterns.github.io/MDSL-Specification/)
52+
* [Endpoint types](https://microservice-api-patterns.github.io/MDSL-Specification/servicecontract) (a.k.a. ports)
53+
* [Bindings](https://microservice-api-patterns.github.io/MDSL-Specification/bindings) (a.k.a. adapters)
54+
* [Data types](https://microservice-api-patterns.github.io/MDSL-Specification/datacontract) (a.k.a. published language)
55+
* [Instance-level concepts](https://microservice-api-patterns.github.io/MDSL-Specification/optionalparts) (provider, client, gateway)
5656

5757
<!-- An implemented proposal of a language extension supporting queue-based messaging endpoints is [AsyncMDSL](https://github.com/giacomodeliberali/MDSL/tree/master/examples/asyncMDSL).-->
5858

@@ -62,7 +62,6 @@ These two languages can be used independently of each other; for instance, data
6262
This repository contains:
6363

6464
* [dsl-core](dsl-core), the DSL project, Xtext grammar and everything else needed to build an Eclipse plugin providing a MDSL editor.
65-
* An older, not fully equivalent version of the grammar in [this folder](antlr4).
6665
* Various [examples](examples).
6766
* The [sources of the GitHub pages](docs) for MDSL.
6867
* Some [background information](background) on other IDLs and related projects.
@@ -74,7 +73,7 @@ If you want to contribute to MDSL, you have to clone this repo and generate the
7473

7574
## Change Log
7675

77-
The current version of MDSL is 4.2. See [change log](changelog.md) for an evolution history; see GitHub [release notes](https://github.com/socadk/MDSL/releases) for additional update information.
76+
The current version of MDSL is 4.2. 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.
7877

7978
<!-->
8079
A possible roadmap for language and tools is (subject to change at any time):
@@ -91,7 +90,7 @@ All [Microservice API Patterns (MAP)](https://microservice-api-patterns.org/) ar
9190
* As enums for roles and responsibilities
9291
* As stereotypes annotating representation elements
9392

94-
See ["MAP Decorators" section of the MDSL tutorial](https://socadk.github.io/MDSL/tutorial) for more information. <!-- TODO copy one-pager in SummerSoC paper to GitHub pages or elsewhere in repo -->
93+
See ["MAP Decorators" section of the MDSL tutorial](https://github.com/Microservice-API-Patterns/MDSL-Specification/tutorial) for more information. <!-- TODO copy one-pager in SummerSoC paper to GitHub pages or elsewhere in repo -->
9594

9695
The MDSL grammar, to be found in src folder of the `dsl-core/io.mdsl` project, was originally developed with Eclipse Photon (4.8.0) and Xtext (2.14) as provided by the Eclipse Modeling Platform. MDSL makes use of the referencing feature in Xtext ('name' attribute). Future work is required to also support this technology in other IDEs (such as Visual Studio Code).
9796

changelog.md

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## MDSL change log (and release notes)
22

3-
Also see GitHub [release notes](https://github.com/socadk/MDSL/releases).
3+
Also see GitHub [release notes](https://github.com/Microservice-API-Patterns/MDSL-Specification/releases).
44

55
V4.2, October 2020
66

@@ -23,8 +23,6 @@ V3.4, July 2020
2323
* Cleanup
2424
* Additional generators: gRPC protocol buffers, Jolie (and, indirectly, WSDL/XML Schema)
2525

26-
<!--V 3.2, V3.3? -->
27-
2826
V3.1.1, June 2, 2020
2927

3028
* Added three EIPs as stereotypes on message level: `'Command_Message' | 'Document_Message' | 'Event_Message'`
@@ -58,7 +56,7 @@ V2.0, May 5, 2020
5856
V1.2.0, March 17, 2020
5957

6058
* Extended proposal for asynch. messaging support on binding level (provider, client, gateway -> sender, receiver, broker)
61-
* March 25: project [wiki](https://github.com/socadk/MDSL/wiki) updated (presentations, getting started page)
59+
6260

6361
V1.1.0, February 8, 2020
6462

@@ -89,48 +87,4 @@ V1.0, July 19, 2019
8987
* Removed unnecessary () in treeNode rule (line 130)
9088
* Grammar rules edited for better antlr4 compatibility (no changes to language)
9189
* Endpoint parameters were experimental so far, and are now deprecated (but not featured in examples anyway)
92-
* Repository/examples cleanup (TODOs)
93-
94-
V0.99, June 26, 2019 (backward compatible except for `blob` -> `raw` and typo fix: `AGGRESSIVE_OBSOLESCENCE`)
95-
96-
* Housekeeping
97-
* Mappy demo support (examples)
98-
* Renamed byte array base type from `blob` to `raw`
99-
* Type in EvolutionStrategy rule fixed: from `AGGRESSIVE_OBSOLESCENSE` to `AGGRESSIVE_OBSOLESCENCE`
100-
101-
V0.98, May 22, 2019 (backward compatible)
102-
103-
* Data types and operations can now be versioned as well:
104-
* `data type VersionedDataType version 0.0.1 {ID, V}`
105-
* `operation sampleOperation version 0.0.1 with responsibility EVENT_PROCESSOR`
106-
107-
V0.97, May 15, 2019
108-
109-
* Removed '|' from Cardinality rule, no longer needed and not featured in examples anyway
110-
* Some new comments and TODOs
111-
112-
V0.95 and v.096, May 13, 2019
113-
114-
* `V<"SomeUnknownType">` is now illegal, same effect can be achieved with plain identifier or `data type SomeUnknownType P`
115-
* Refactored data type grammar to make it more precise and to make code completion more useful (to be tested)
116-
* External SLAs now supported
117-
* Many other tweaks in API provider part (e.g. SimpleMeasurement)
118-
119-
V0.94, May 13, 2019
120-
121-
* Added `V<void>` due to user feedback and test results
122-
* Changed base types to include 'long' and 'double' (instead of 'float')
123-
* Enabled support for choice modeling on PT level data type ChoiceDemo `{"optionA":V|"optionB":V}`
124-
* Updated pattern stereotype enum to reflect latest MAP status
125-
126-
V0.93a, May 10, 2019:
127-
128-
* Removed "contract" from "endpoint contact type" for brevity
129-
* Removed "instance" from "endpoint instance location" for brevity
130-
* `<<Value>>` no longer available as pattern stereotype (undone later)
131-
* Entity and E no longer available as parameter roles (but D and Data)
132-
133-
V0.93b, May 10, 2019 (experimental):
134-
135-
* Only `V<int>` supported as parameter role/type pair, `Value<int>` removed to avoid confusion with `<<stereotypes>>`
136-
* `<<Identifier>>` and `<<Link>>` and `<<Metadata>>` now available as pattern stereotypes (`<<Entity>>` was supported already)
90+
* Repository/examples cleanup (TODOs)

docs/bindings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,6 @@ Language specification pages:
143143

144144
[Quick reference](./quickreference). [Tutorial](./tutorial). [Tools](./tools). Back to [MDSL homepage](./index).
145145

146-
*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
146+
*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
147147

148148
<!-- *EOF* -->

docs/datacontract.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,6 @@ Note that some combinations are syntactically possible at present (to simplify t
262262
* [Quick reference](./quickreference), [tutorial](./tutorial) and [tools](./tools)
263263
* Back to [MDSL homepage](./index).
264264

265-
*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
265+
*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
266266

267267
<!-- *EOF* -->

docs/examples.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ MDSL Grammar Example
99

1010

1111
## Service Contract
12-
The following exemplary API specification compiles against the [MDSL grammar](https://github.com/socadk/MDSL/blob/master/dsl-core/io.mdsl/src/io/mdsl/APIDescription.xtext):
12+
The following exemplary API specification compiles against the [MDSL grammar](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/dsl-core/io.mdsl/src/io/mdsl/APIDescription.xtext):
1313

1414
<!-- TODO feature error reporting and versioning of data types -->
1515

@@ -84,8 +84,8 @@ Optional [Instance-level language constructs](./optionalparts).
8484

8585
Back to [MDSL homepage](./index).
8686

87-
More examples in [public](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples) and in [private](https://github.com/socadk/MDSL/tree/master/examples) repository.
87+
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.
8888

89-
*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
89+
*Copyright: Olaf Zimmermann, 2018-2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
9090

9191
<!-- *EOF* -->

docs/generators/freemarker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,4 @@ Also checkout our other generators:
126126
* [Bindings](./../bindings) and [instance-level concepts](./../optionalparts).
127127
* Back to [MDSL homepage](./../index).
128128

129-
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
129+
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*

docs/generators/graphql.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ scalar Raw
135135
scalar VoidResponse
136136
```
137137

138-
You can find the sources for this example [here](https://github.com/socadk/MDSL/tree/master/examples/graphql-example).
138+
You can find the sources for this example [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/graphql-example).
139139

140140
**Note:** The GraphQL generator is an experimental prototype and implemented in a straightforward fashion. We generate an "input" and an "output" type for all MDSL types available; not all of these generated types might not be required. We also wrap lists into objects, which could often be simplified after generation.
141141

@@ -246,7 +246,7 @@ const resolvers = {
246246
};
247247
```
248248

249-
Find the complete server example [here](https://github.com/socadk/MDSL/tree/master/examples/graphql-example/apollo-server-example/index.js).
249+
Find the complete server example [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/graphql-example/apollo-server-example/index.js).
250250

251251
Once you created the `index.js` with the generated GraphQL schema and at least one resolver, you can start the server with the following command:
252252

@@ -415,7 +415,7 @@ You can now open the browser and `localhost:3000` will start the app and list ou
415415

416416
<a target="_blank" href="/media/apollo-client-test-screenshot.png">![Locally test Apollo client](/media/apollo-client-test-screenshot.png)</a>
417417

418-
Find the complete client example [here](https://github.com/socadk/MDSL/tree/master/examples/graphql-example/apollo-client-example/).
418+
Find the complete client example [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/graphql-example/apollo-client-example/).
419419

420420

421421
### Generating Code for other GraphQL Implementations
@@ -427,7 +427,7 @@ An easy way to get an impression of how the code generator works is by using the
427427

428428
<a target="_blank" href="/media/code-generator-live-demo.png">![Code Generator Live Demo](/media/code-generator-live-demo.png)</a>
429429

430-
We created an example Java (Spring Boot) application that uses the code generator. You find the complete example project [here](https://github.com/socadk/MDSL/tree/master/examples/graphql-example/spring-boot-example/).
430+
We created an example Java (Spring Boot) application that uses the code generator. You find the complete example project [here](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/graphql-example/spring-boot-example/).
431431

432432
#### Create Spring Boot (Java) Application
433433
First, we created a classic Spring Boot project with [Spring initializr](https://start.spring.io/) (Gradle project).
@@ -565,7 +565,7 @@ public class GraphQLProvider {
565565
}
566566
```
567567

568-
**Note** that we had to provide implementations for our custom scalars (_Void_ and _Raw_). You find it in our [example project](https://github.com/socadk/MDSL/tree/master/examples/graphql-example/spring-boot-example/).
568+
**Note** that we had to provide implementations for our custom scalars (_Void_ and _Raw_). You find it in our [example project](https://github.com/Microservice-API-Patterns/MDSL-Specification/tree/master/examples/graphql-example/spring-boot-example/).
569569

570570
The Spring Boot application can now be started with `./gradlew clean bootRun` (please adopt the command invocation to your OS). As soon as the application is started, you can run the same query as we did before with Apollo. The following screenshot shows our test with Postman:
571571

@@ -593,6 +593,6 @@ Also checkout our other generators:
593593
* [Bindings](./../bindings) and [instance-level concepts](./../optionalparts).
594594
* Back to [MDSL homepage](./../index).
595595

596-
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
596+
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*
597597

598598
<!-- *EOF* -->

docs/generators/java.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,4 +336,4 @@ Also checkout our other generators:
336336
* [Bindings](./../bindings) and [instance-level concepts](./../optionalparts).
337337
* Back to [MDSL homepage](./../index).
338338

339-
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
339+
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*

docs/generators/jolie.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,4 +169,4 @@ Also checkout our other generators:
169169
* [Bindings](./../bindings) and [instance-level concepts](./../optionalparts).
170170
* Back to [MDSL homepage](./../index).
171171

172-
*Copyright: Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
172+
*Copyright: Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*

docs/generators/open-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,4 @@ Also checkout our other generators:
223223
* [Bindings](./../bindings) and [instance-level concepts](./../optionalparts).
224224
* Back to [MDSL homepage](./../index).
225225

226-
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
226+
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*

docs/generators/protocol-buffers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,4 +130,4 @@ Also checkout our other generators:
130130
* [Bindings](./../bindings) and [instance-level concepts](./../optionalparts).
131131
* Back to [MDSL homepage](./../index).
132132

133-
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/socadk/MDSL/blob/master/LICENSE).*
133+
*Copyright: Stefan Kapferer and Olaf Zimmermann, 2020. All rights reserved. See [license information](https://github.com/Microservice-API-Patterns/MDSL-Specification/blob/master/LICENSE).*

0 commit comments

Comments
 (0)