Skip to content

Commit 2294833

Browse files
committed
Update versions
1 parent 0adc2cc commit 2294833

File tree

3 files changed

+32
-32
lines changed

3 files changed

+32
-32
lines changed

Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ EXPOSE 8080
1919

2020
# execute it
2121
# CMD ["mvn", "exec:java"]
22-
CMD ["java", "-jar", "target/cqlTranslationServer-2.4.0.jar", "-d"]
22+
CMD ["java", "-jar", "target/cqlTranslationServer-2.5.0.jar", "-d"]

README.md

+30-30
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Build:
88

99
Execute via the command line:
1010

11-
java -jar target/cqlTranslationServer-2.4.0.jar
11+
java -jar target/cqlTranslationServer-2.5.0.jar
1212

1313
_NOTE: The cqlTranslationServer jar assumes that all dependency jars are located in a `libs` directory relative to the jar's location. If you move the jar from the `target` directory, you will need to move the `target/libs` directory as well. This project no longer produces an "uber-jar", as the CQL-to-ELM classes do not function properly when repackaged into a single jar file._
1414

@@ -17,7 +17,8 @@ _NOTE: The cqlTranslationServer jar assumes that all dependency jars are located
1717
CQL Translation Service versions prior to version 2.0.0 always mirrored the CQL Tools (CQL-to-ELM translator) version they exposed. Starting with version 2.0.0, semantic versioning is now used. As a result, the version of the CQL Translation Service differs from the version of the CQL Tools that it exposes. The following table shows the relationship between [CQL Translation Service releases](https://github.com/cqframework/cql-translation-service/releases) and [CQL Tools releases](https://github.com/cqframework/clinical_quality_language/releases). Note that prior releases from the [MITRE repo](https://github.com/mitre/cql-translation-service/releases) are not included here.
1818

1919
| CQL Translation Service | CQL Tools |
20-
|-------------------------|-----------------------------------------|
20+
| ----------------------- | --------------------------------------- |
21+
| 2.5.0 | 3.15.0 |
2122
| 2.4.0 | 3.7.1 |
2223
| 2.3.0 | 3.3.2 |
2324
| 2.2.0 | 2.11.0 |
@@ -167,32 +168,33 @@ Will return:
167168

168169
### CQL-to-ELM Translator Options
169170

170-
The CQL-to-ELM translator supports many options to control the output. These options can be passed to the service as query parameters when you post CQL to the service (e.g., `POST http://localhost:8080/cql/translator?annotations=true&result-types=true`). These query parameters are supported for both simple requests and multipart requests. See the table below for the available options:
171-
172-
|Option|Values|Default|
173-
|----|----|----|
174-
|date-range-optimization|true\|false|false|
175-
|annotations|true\|false|false|
176-
|locators|true\|false|false|
177-
|result-types|true\|false|false|
178-
|signatures|None\|Differing\|Overloads\|All|None|
179-
|detailed-errors|true\|false|false|
180-
|disable-list-traversal|true\|false|false|
181-
|disable-list-demotion|true\|false|false|
182-
|disable-list-promotion|true\|false|false|
183-
|enable-interval-demotion|true\|false|false|
184-
|enable-interval-promotion|true\|false|false|
185-
|disable-method-invocation|true\|false|false|
186-
|require-from-keyword|true\|false|false|
187-
|strict|true\|false|false|
188-
|debug|true\|false|false|
189-
|validate-units|true\|false|false|
171+
The CQL-to-ELM translator supports many options to control the output. These options can be passed to the service as query parameters when you post CQL to the service (e.g., `POST http://localhost:8080/cql/translator?annotations=true&result-types=true`). These query parameters are supported for both simple requests and multipart requests. See the table below for the available options:
172+
173+
| Option | Values | Default |
174+
| ------------------------- | ------------------------------- | ------- |
175+
| date-range-optimization | true\|false | false |
176+
| annotations | true\|false | false |
177+
| locators | true\|false | false |
178+
| result-types | true\|false | false |
179+
| signatures | None\|Differing\|Overloads\|All | None |
180+
| detailed-errors | true\|false | false |
181+
| disable-list-traversal | true\|false | false |
182+
| disable-list-demotion | true\|false | false |
183+
| disable-list-promotion | true\|false | false |
184+
| enable-interval-demotion | true\|false | false |
185+
| enable-interval-promotion | true\|false | false |
186+
| disable-method-invocation | true\|false | false |
187+
| require-from-keyword | true\|false | false |
188+
| strict | true\|false | false |
189+
| debug | true\|false | false |
190+
| validate-units | true\|false | false |
190191

191192
For more information on each of these options, see the [CQL-to-ELM Overview](https://github.com/cqframework/clinical_quality_language/blob/master/Src/java/cql-to-elm/OVERVIEW.md#usage).
192193

193194
_**NOTE:**_
194-
* _Previous versions of the CQL-to-ELM Translation Service defaulted **annotations** to true. To align better with the CQL-to-ELM console client, the translation service now defaults annotations to false._
195-
* _Previous versions of the CQL-to-ELM Translation Service allowed list-promotion to be disabled via an extra multipart form field named **disablePromotion**. This is no longer supported, as it was ambiguous and inconsistent with the CQL-to-ELM console client. The **disable-list-promotion** query parameter should be used instead._
195+
196+
- _Previous versions of the CQL-to-ELM Translation Service defaulted **annotations** to true. To align better with the CQL-to-ELM console client, the translation service now defaults annotations to false._
197+
- _Previous versions of the CQL-to-ELM Translation Service allowed list-promotion to be disabled via an extra multipart form field named **disablePromotion**. This is no longer supported, as it was ambiguous and inconsistent with the CQL-to-ELM console client. The **disable-list-promotion** query parameter should be used instead._
196198

197199
## Formatter Endpoint
198200

@@ -231,7 +233,6 @@ formatted part for each CQL part in the submitted package.
231233

232234
Example usage via HTTP request:
233235

234-
235236
POST /cql/formatter HTTP/1.1
236237
Host: localhost:8080
237238
Content-Type: multipart/form-data; boundary=X-INSOMNIA-BOUNDARY
@@ -284,22 +285,21 @@ Will return:
284285
42
285286
--Boundary_2_1638692479_1658770032240--
286287

287-
288288
## Docker Deployment
289289

290290
You may deploy pre-built Docker images into your existing hosting environment with:
291291

292-
docker run -d -p 8080:8080 --restart unless-stopped cqframework/cql-translation-service:latest # or any official tag
292+
docker run -d -p 8080:8080 --restart unless-stopped cqframework/cql-translation-service:latest # or any official tag
293293

294294
And you're done. No environment variables or further configuration are needed. Jedis may use your existing Kubernetes, Open Shift etc installations as you see fit. :)
295295

296296
To build your own image for your current architecture:
297297

298-
docker build -t cqframework/cql-translation-service:latest . # but use your your own repo and tag strings!
298+
docker build -t cqframework/cql-translation-service:latest . # but use your your own repo and tag strings!
299299

300300
To build your own image for multiple architectures (e.g., Intel and Mac M1):
301301

302-
docker buildx build --platform linux/amd64,linux/arm64 -t cqframework/cql-translation-service:latest . # but use your your own repo and tag strings!
302+
docker buildx build --platform linux/amd64,linux/arm64 -t cqframework/cql-translation-service:latest . # but use your your own repo and tag strings!
303303

304304
Note that Docker doesn't support loading multi-platform builds locally, so the above multi-platform build commmand is only helpful when used with `--push`. See: [https://github.com/docker/buildx/issues/59](https://github.com/docker/buildx/issues/59).
305305

@@ -315,7 +315,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
315315
you may not use this file except in compliance with the License.
316316
You may obtain a copy of the License at
317317

318-
http://www.apache.org/licenses/LICENSE-2.0
318+
http://www.apache.org/licenses/LICENSE-2.0
319319

320320
Unless required by applicable law or agreed to in writing, software
321321
distributed under the License is distributed on an "AS IS" BASIS,

pom.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<groupId>org.mitre.bonnie</groupId>
77
<artifactId>cqlTranslationServer</artifactId>
88
<packaging>jar</packaging>
9-
<version>2.4.0</version>
9+
<version>2.5.0</version>
1010
<name>cqlTranslationServer</name>
1111

1212
<repositories>

0 commit comments

Comments
 (0)