Skip to content

Commit 99e587c

Browse files
authored
Merge pull request #752 from bci-oss/extend-aspect-to-aas-output-file-path-description
Extend aspect-to-aas output file path description
2 parents 6af618f + eba51b9 commit 99e587c

File tree

1 file changed

+6
-6
lines changed
  • documentation/developer-guide/modules/tooling-guide/pages

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ In place of `<model>` in the command descriptions below, you can provide either
6565
6666
* a relative file name, such as `AspectModel.ttl` or `./somewhere/AspectModel.ttl` (on Linux and
6767
MacOS) or `.\somewhere\AspectModel.ttl` (on Windows),
68-
* an absolut file name, such as
68+
* an absolut file name (put it in quotes ("") if the path or file name contains blank spaces), such as
6969
`/home/me/aspect-models/org.eclipse.esmf.example/1.0.0/AspectModel.ttl` (on Linux and MacOS) or
7070
`C:\Users\me\aspect-models\org.eclipse.esmf.example\1.0.0\AspectModel.ttl` (on Windows),
7171
* a URL pointing to a .ttl file in a publically accessible GitHub repository, such as
@@ -135,10 +135,10 @@ of model resolution] for more information.
135135
| _--comment, -c_ : only in combination with --json; generates `$comment`
136136
OpenAPI 3.1 keyword for all `samm:see` attributes |
137137
| _--parameter-file, -p_ : the path to a file including the parameter for the Aspect
138-
API endpoints | For detailed description, see the section bellow
138+
API endpoints | For detailed description, see the section below
139139
| _--semantic-version, -sv_ : use the full semantic version from the Aspect Model as the
140140
version for the Aspect API |
141-
| _--resource-path, -r_ : the resource path for the Aspect API endpoints | For detailed description, see the section bellow
141+
| _--resource-path, -r_ : the resource path for the Aspect API endpoints | For detailed description, see the section below
142142
| _--include-query-api, -q_ : include the path for the Query Aspect API Endpoint in the
143143
https://spec.openapis.org/oas/v3.0.3[OpenAPI] specification |
144144
| _--include-crud, -cr_ : include the POST/PUT/PATCH methods in the OpenAPI specification |
@@ -156,7 +156,7 @@ of model resolution] for more information.
156156
| _--language, -l_ : The language from the model for which an OpenAPI specification should
157157
be generated (default: en) | `samm aspect AspectModel.ttl to openapi -l de`
158158
| _--template-file, -t_ : the path to a file including a template for
159-
the resulting specification, can be in JSON or YAML | For detailed description, see the section bellow
159+
the resulting specification, can be in JSON or YAML | For detailed description, see the section below
160160
| _--separate-files, -sf_ : Create separate files for each schema |
161161
| _--custom-resolver_ : use an external resolver for the resolution of the model elements |
162162
.8+| [[aspect-to-asyncapi]] aspect <model> to asyncapi | Generate https://www.asyncapi.com/docs/reference/specification/v3.0.0[AsyncAPI] specification for an Aspect Model| `samm aspect AspectModel.ttl to asyncapi`
@@ -199,8 +199,8 @@ of model resolution] for more information.
199199
| _--custom-column, -col_ : Additional custom column definition, e.g. for databricks following the pattern `column_name DATATYPE [NOT NULL] [COMMENT 'custom']`. This parameter can be repeated for multiple columns. | `samm aspect AspectModel.ttl to sql --custom-column "column_name STRING NOT NULL COMMENT 'custom'"`
200200
.5+| [[aspect-to-aas]] aspect <model> to aas | Generate an Asset Administration Shell (AAS) submodel template from an
201201
Aspect Model | `samm aspect AspectModel.ttl to aas`
202-
| _--output, -o_ : output file path (default: stdout) |
203-
| _--format, -f_ : output file format (XML, JSON, or AASX, default: XML) |
202+
| _--output, -o_ : output file path (default: stdout) | `samm aspect AspectModel.ttl to aas -o="somewhere\new-file-name.extension"`
203+
| _--format, -f_ : output file format (XML, JSON, or AASX, default: XML) | `samm aspect AspectModel.ttl to aas -f="aasx" -o="somewhere\newfile.aasx"`
204204
| _--custom-resolver_ : use an external resolver for the resolution of the model elements |
205205
| _--aspect-data, -a_ : path to a JSON file containing aspect data corresponding to the
206206
Aspect Model |

0 commit comments

Comments
 (0)