Skip to content

Commit 0c9a874

Browse files
committed
[#231] update documentation
Signed-off-by: Kartheeswaran Kalidass <[email protected]>
1 parent 9586540 commit 0c9a874

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

documentation/developer-guide/modules/tooling-guide/pages/bamm-cli.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,14 @@ The available options and their meaning can also be seen in the help text of the
8383
| _--paging-cursor-based, -pc_ : in case there is more than one paging possibility, it has to be cursor based paging|
8484
| _--paging-offset-based, -po_ : in case there is more than one paging possibility, it has to be offset based paging|
8585
| _--paging-time-based, -pt_ : in case there is more than one paging possibility, it has to be time based paging|
86+
| _--language, -l_ : The language from the model for which an OpenAPI specification should be generated (default: en) | `bamm aspect AspectModel.ttl to openapi -l de`|
8687
| _--custom-resolver_ : use an external resolver for the resolution of the model elements |
8788
.3+| aspect <model> to json | Generate OpenAPI JSON specification for an Aspect Model | `bamm aspect AspectModel.ttl to json`
8889
| _--output, -o_ : output file path (default: stdout) |
8990
| _--custom-resolver_ : use an external resolver for the resolution of the model elements |
9091
.3+| aspect <model> to schema | Generate JSON schema for an Aspect Model | `bamm aspect AspectModel.ttl to schema`
9192
| _--output, -o_ : output file path (default: stdout) |
93+
| _--language, -l_ : The language from the model for which a JSON schema should be generated (default: en) | `bamm aspect AspectModel.ttl to schema -l de`|
9294
| _--custom-resolver_ : use an external resolver for the resolution of the model elements |
9395
.4+| aspect <model> to aas | Generate Asset Administration Shell (AAS) submodel template for an Aspect Model | `bamm aspect AspectModel.ttl to aas`
9496
| _--output, -o_ : output file path (default: stdout) |

documentation/developer-guide/modules/tooling-guide/pages/maven-plugin.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ Configuration Properties:
194194
| `modelsRootDirectory` | The path to the root directory containing the Aspect Model file(s). | `String` | `${basedir}/src/main/resources/aspects` | {nok}
195195
| `includes` | A list of Aspect Model URNs identifying the Aspect Models to be included in the plugin execution. | `String` | none | {ok}
196196
| `outputDirectory` | The path to the directory where the generated JSON Schema will be written to. | `String` | none | {ok}
197+
| `language` | The language from the model for which a JSON Schema should be generated. | `String` | en | {nok}
197198
|===
198199

199200
== Generate an OpenAPI Specification from an Aspect Model
@@ -248,6 +249,7 @@ Configuration Properties:
248249
| `aspectOffsetBasedPaging` | Set the used paging strategy as offset-based paging. | `Boolean` | `false` | {nok}
249250
| `aspectTimeBasedPaging` | Set the used paging strategy as time-based paging. | `Boolean` | `false` | {nok}
250251
| `outputFormat` | The format of the resulting OpenAPI Specification. May be either JSON or YAML. | `String` | none | {ok}
252+
| `language` | The language from the model for which an OpenAPI specification should be generated. | `String` | en | {nok}
251253
|===
252254

253255
== Generate Documentation for an Aspect Model

0 commit comments

Comments
 (0)