1- # yaml -doc-tool
1+ # openapi -doc-tool
22
33Tool for auto documentation of yaml / openapi
44
55[ ![ Keep a Changelog v1.1.0 badge] ( https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735 )] ( CHANGELOG.md )
6- [ ![ Maven Central] ( https://img.shields.io/maven-central/v/org.fugerit.java/yaml -doc-tool.svg )] ( https://mvnrepository.com/artifact/org.fugerit.java/yaml -doc-tool )
6+ [ ![ Maven Central] ( https://img.shields.io/maven-central/v/org.fugerit.java/openapi -doc-tool.svg )] ( https://mvnrepository.com/artifact/org.fugerit.java/openapi -doc-tool )
77[ ![ license] ( https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg )] ( https://opensource.org/licenses/Apache-2.0 )
88[ ![ code of conduct] ( https://img.shields.io/badge/conduct-Contributor%20Covenant-purple.svg )] ( https://github.com/fugerit-org/fj-universe/blob/main/CODE_OF_CONDUCT.md )
9- [ ![ Quality Gate Status] ( https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml -doc-tool&metric=alert_status )] ( https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml -doc-tool )
10- [ ![ Coverage] ( https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_yaml -doc-tool&metric=coverage )] ( https://sonarcloud.io/summary/new_code?id=fugerit-org_yaml -doc-tool )
9+ [ ![ Quality Gate Status] ( https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_openapi -doc-tool&metric=alert_status )] ( https://sonarcloud.io/summary/new_code?id=fugerit-org_openapi -doc-tool )
10+ [ ![ Coverage] ( https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_openapi -doc-tool&metric=coverage )] ( https://sonarcloud.io/summary/new_code?id=fugerit-org_openapi -doc-tool )
1111
1212[ ![ Java runtime version] ( https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge&logo=openjdk&logoColor=white )] ( https://universe.fugerit.org/src/docs/versions/java11.html )
1313[ ![ Java build version] ( https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white )] ( https://universe.fugerit.org/src/docs/versions/java11.html )
@@ -22,7 +22,7 @@ mvn clean install -P singlepackage
2222## Quickstart (mode: single):
2323
2424```
25- java -jar dist-yaml -doc-tool-*.jar --input-yaml [path-to-openapi] \
25+ java -jar dist-openapi -doc-tool-*.jar --input-yaml [path-to-openapi] \
2626 --output-file [output-file] \
2727 --language [language] \
2828 --labels-override [path-to-labels-properties]
@@ -31,7 +31,7 @@ java -jar dist-yaml-doc-tool-*.jar --input-yaml [path-to-openapi] \
3131** example :**
3232
3333```
34- java -jar dist-yaml -doc-tool-*.jar --input-yaml sample.yaml --output-file sample.pdf --language it
34+ java -jar dist-openapi -doc-tool-*.jar --input-yaml sample.yaml --output-file sample.pdf --language it
3535```
3636
3737** output-file**
@@ -51,7 +51,7 @@ A [Maven Plugin](https://github.com/fugerit-org/yaml-doc-maven-plugin) is also a
5151## Quickstart (mode: config):
5252
5353```
54- java -jar dist-yaml -doc-tool-*.jar --mode [config] \
54+ java -jar dist-openapi -doc-tool-*.jar --mode [config] \
5555 --config-path [path-to-config] \
5656 --id-catalog [id-catalog-in-config]
5757```
@@ -68,7 +68,7 @@ id of the catalog in config to use
6868Node : the type to check need to be in classpath.
6969
7070```
71- java -jar dist-yaml -doc-tool-*.jar --mode [check-model] \
71+ java -jar dist-openapi -doc-tool-*.jar --mode [check-model] \
7272 --input-yaml [path-to-openapi] \
7373 --output-file [output-file] \
7474 --check-type [java type to check] \
0 commit comments