[servicecomb-toolkit] 13/26: SCB-1553 Integrate oas-validator compliance check to cli Add oas-validator style check usage to README

[ni...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ningjiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/servicecomb-toolkit.git

commit 5d64553aadb39cbc325a4e866ebf72be1dbe9ac0
Author: Daniel Qian <ch...@gmail.com>
AuthorDate: Fri Nov 1 17:03:07 2019 +0800

    SCB-1553 Integrate oas-validator compliance check to cli
    Add oas-validator style check usage to README
---
 README-ZH.md |  9 +++++++++
 README.md    | 17 ++++++++++++++---
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/README-ZH.md b/README-ZH.md
index 9514ce1..a791b7c 100644
--- a/README-ZH.md
+++ b/README-ZH.md
@@ -272,6 +272,15 @@ $ java -jar toolkit-cli-{version}.jar docgenerate -i swagger.yaml -o ./document
 * -f, --format : 指定输出文档风格,现支持swagger-ui
 例：-f swagger-ui
 
+#### 3.3.3 契约风格检查
+
+```shell
+$ java -jar toolkit-cli-{version}.jar checkstyle openapi.yaml
+```
+
+> **checkstyle** Command argument
+* &lt;file&gt; OpenAPI v3 spec yaml文件
+
 ### 3.4 使用案例
 可以在[这里](./samples/README-ZH.md)找到使用插件的一些示例 
 
diff --git a/README.md b/README.md
index 5a0aabf..1a43352 100644
--- a/README.md
+++ b/README.md
@@ -261,13 +261,24 @@ $ java -jar toolkit-cli-{version}.jar docgenerate -i swagger.yaml -o ./document
 ```
 > **docgenerate** Command option
 * -i, --input. Specifies contract files that follow the OpenAPI specification, supports yaml and json formats, and supports specifying local and network files.
-例：-i http://petstore.swagger.io/v2/swagger.json
+e.g：-i http://petstore.swagger.io/v2/swagger.json
 * -o, --output. Document output path.
-例：-o ./document
+e.g：-o ./document
 * -f, --format. Specifies the output document format, now supports swagger-ui
-例：-f swagger-ui
+e.g：-f swagger-ui
+
+#### 3.3.3 Service contract style checking
+
+```shell
+$ java -jar toolkit-cli-{version}.jar checkstyle openapi.yaml
+```
+
+> **checkstyle** Command argument
+* &lt;file&gt; OpenAPI v3 spec yaml file
+
 
 ### 3.4 Use case
+
 some example of using plugin can be found [here](./samples)
 
 ## 4 Contact us