Skip to content

Commit 978599e

Browse files
author
Oleksandr Dzhychko
committed
feat(mps-model-adapters): remove documentation for mps-model-server-plugin
Fixes: MODELIX-996
1 parent de7673d commit 978599e

10 files changed

+20
-196
lines changed

docs/global/modules/core/pages/howto/modelql.adoc

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,36 @@
33
== Independent ModelQLClient
44

55
ModelQL defines its own HTTP endpoint and provides server/client implementations for it.
6-
The `model-server` and the `mps-model-server-plugin` already implement this endpoint.
7-
The client can be created like this:
6+
A xref:reference/component-model-server.adoc[model server] already implements this endpoint.
7+
8+
It is recommended
9+
to use the ModelQL client integrated in to the xref:howto/usage-model-client-v2.adoc[model client V2]
10+
when working with the model server:
811

912
[source,kotlin]
1013
--
11-
val client = ModelQLClient.builder().url("http://localhost/query").httpClient(httpClient).build()
14+
val client = ModelClientV2.builder()
15+
.url("http://localhost:28101/v2")
16+
.build()
17+
1218
val result: List<String?> = client.query { root ->
1319
root.children("modules").property("name").toList()
1420
}
1521
--
1622

17-
== Integration with LightModelClient
18-
19-
When creating a `LightModelClient` you can optionally provide a `ModelQLClient` instance,
20-
which allows invoking `.query { ... }` (see below) on a node returned by the `LightModelClient`.
23+
[NOTE]
24+
--
25+
An independent ModelQL client can be created like this:
2126

2227
[source,kotlin]
23-
--
24-
val modelqlClient = ModelQLClient.builder().build()
25-
val client = LightModelClient.builder().modelQLClient(modelqlClient).build()
26-
val result: List<String?> = client.getRootNode()!!.query {
27-
it.children("modules").property("name").toList()
28+
----
29+
val client = ModelQLClient.builder().url("http://localhost/query").httpClient(httpClient).build()
30+
val result: List<String?> = client.query { root ->
31+
root.children("modules").property("name").toList()
2832
}
33+
----
34+
35+
This is only useful when some custom implementation of a ModelQL server needs to be used.
2936
--
3037

3138
== Type-safe ModelQL API

docs/global/modules/core/pages/howto/mps-model-server-plugin.adoc

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/global/modules/core/pages/howto/testing-against-model-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
= How-To test `model-api` client code without a model-server
22
:navtitle: Test `model-api` client code without a model-server
33

4-
If you want to test code that processes `model-api` instances, you can do this in-process without a running (light-) model-server.
4+
If you want to test code that processes `model-api` instances, you can do this in-process without a running model-server.
55
Use the following pattern to set up your test fixture containing `model-api` instances:
66

77
[source,kotlin]

docs/global/modules/core/pages/howto/usage-light-model-client.adoc

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/global/modules/core/pages/howto/usage-model-server.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33

44
NOTE: If you are interested in a more practical usage of what is presented here, check out the https://github.com/modelix/modelix.samples[samples project^]
55

6-
NOTE: To run a light version of the `model-sever`, check out xref:core:howto/mps-model-server-plugin.adoc[]
7-
86
== Backends: In Memory vs. Database
97

108
The `model-server` will by default require a database backend.

docs/global/modules/core/pages/reference/component-light-model-client.adoc

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/global/modules/core/pages/reference/component-mps-model-server-plugin.adoc

Lines changed: 0 additions & 68 deletions
This file was deleted.
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
* xref:core:howto/usage-model-server.adoc[]
2-
* xref:core:howto/mps-model-server-plugin.adoc[]
32
* xref:core:howto/metrics.adoc[]
43
* xref:core:howto/usage-model-api-gen-gradle.adoc[]
54
* xref:core:howto/usage-model-client-v2.adoc[]
6-
* xref:core:howto/usage-light-model-client.adoc[]
75
* xref:core:howto/testing-against-model-api.adoc[]
86
* xref:core:howto/modelql.adoc[]
97
* xref:core:howto/modelql-writing.adoc[]

docs/global/modules/core/partials/nav-reference.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,4 @@
44
* xref:core:reference/component-model-api-gen.adoc[]
55
* xref:core:reference/component-model-api-gen-gradle.adoc[]
66
* xref:core:reference/component-bulk-model-sync-gradle.adoc[]
7-
* xref:core:reference/component-light-model-client.adoc[]
8-
* xref:core:reference/component-mps-model-server-plugin.adoc[]
97
* xref:core:reference/component-vue-model-api.adoc[]

docs/global/modules/core/partials/short-description.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ These components include among others the
44
- xref:core:reference/component-model-server.adoc[`model-server`],
55
- xref:core:reference/component-model-api-gen.adoc[`model-api-gen`],
66
- xref:core:reference/component-model-api-gen-gradle.adoc[`model-api-gen-gradle`], and
7-
- xref:core:reference/component-light-model-client.adoc[`light-model-client`].
87
98
All components in this repository have no dependencies to JetBrains MPS.
109
//TODO add correct link here

0 commit comments

Comments
 (0)