1
- # yaml -doc-tool
1
+ # openapi -doc-tool
2
2
3
3
Tool for auto documentation of yaml / openapi
4
4
5
5
[ ![ 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 )
7
7
[ ![ license] ( https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg )] ( https://opensource.org/licenses/Apache-2.0 )
8
8
[ ![ 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 )
11
11
12
12
[ ![ 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 )
13
13
[ ![ 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
22
22
## Quickstart (mode: single):
23
23
24
24
```
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] \
26
26
--output-file [output-file] \
27
27
--language [language] \
28
28
--labels-override [path-to-labels-properties]
@@ -31,7 +31,7 @@ java -jar dist-yaml-doc-tool-*.jar --input-yaml [path-to-openapi] \
31
31
** example :**
32
32
33
33
```
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
35
35
```
36
36
37
37
** output-file**
@@ -51,7 +51,7 @@ A [Maven Plugin](https://github.com/fugerit-org/yaml-doc-maven-plugin) is also a
51
51
## Quickstart (mode: config):
52
52
53
53
```
54
- java -jar dist-yaml -doc-tool-*.jar --mode [config] \
54
+ java -jar dist-openapi -doc-tool-*.jar --mode [config] \
55
55
--config-path [path-to-config] \
56
56
--id-catalog [id-catalog-in-config]
57
57
```
@@ -68,7 +68,7 @@ id of the catalog in config to use
68
68
Node : the type to check need to be in classpath.
69
69
70
70
```
71
- java -jar dist-yaml -doc-tool-*.jar --mode [check-model] \
71
+ java -jar dist-openapi -doc-tool-*.jar --mode [check-model] \
72
72
--input-yaml [path-to-openapi] \
73
73
--output-file [output-file] \
74
74
--check-type [java type to check] \
0 commit comments