Skip to content

Commit c084ca6

Browse files
committed
Update usage description
1 parent 38ea079 commit c084ca6

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Then you simply run:
1717
There are two CLI tools ``Generator`` and ``Converter``. ``Generator`` allows for generating Swagger from YANG modules thus it is similar to original
1818
https://github.com/bartoszm/yang2swagger CLI generator. However, the pruning mechanism was configured to reduce number of path generated for TAPI modules.
1919
In addition extra parameters were added.
20-
``Converter`` can convert _any_ Swagger definition. What it does it flatens hierarchy in the input Swagger.
20+
``Converter`` can convert _any_ Swagger definition. What it does it flattens hierarchy in the input Swagger.
2121

2222
#### Hierarchy flattening ####
2323
Swagger allows combining and extending model definitions using the ``allOf`` property of JSON Schema, in effect offering model composition. allOf takes in an array of object definitions that are validated independently but together compose a single object.
@@ -110,11 +110,13 @@ You can directly generate swagger with simple hierarch using ``-simplify-hierarc
110110
#### Usage ####
111111
You can easily run ```Generator``` from the command-line:
112112
```
113-
java -cp yang2swagger-tapi-cli-1.0-SNAPSHOT-cli.jar com.amartus.y2s.Generator --help
113+
java -cp yang2swagger-tapi-cli-1.1-cli.jar com.amartus.y2s.Generator --help
114114
module ... : List of YANG module names to generate
115115
in swagger output
116116
-api-version file : Version of api generated - default 1.0
117117
(default: 1.0)
118+
-authentication [BASIC | NONE] : Authentication definition (default:
119+
NONE)
118120
-content-type VAL : Content type the API generates /
119121
consumes - default application/yang-dat
120122
a+json (default: application/yang-data+
@@ -142,14 +144,14 @@ You can easily run ```Generator``` from the command-line:
142144

143145
For example:
144146
```
145-
java -cp yang2swagger-tapi-cli-1.0-SNAPSHOT-cli.jar com.amartus.y2s.Generator -yang-dir yang -use-namespaces -elements RPC -output test.yaml
147+
java -cp yang2swagger-tapi-cli-1.1-cli.jar com.amartus.y2s.Generator -yang-dir yang -use-namespaces -elements RPC -output test.yaml
146148
```
147149

148150
To run ``Converter``:
149151

150152

151153
```
152-
java -cp yang2swagger-tapi-cli-1.0-SNAPSHOT-cli.jar com.amartus.y2s.Converter --help
154+
java -cp yang2swagger-tapi-cli-1.1-cli.jar com.amartus.y2s.Converter --help
153155
-input file : File with original swagger, containing the input - defaults to
154156
stdin (default: )
155157
-output file : File to generate, containing the output - defaults to stdout

0 commit comments

Comments
 (0)