You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@servicecomb.apache.org by ni...@apache.org on 2019/11/07 11:02:39 UTC

[servicecomb-toolkit] 04/07: SCB-1555 Integrate oas-validator compability check to cli Update readme

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

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

commit 830f73972446b6d2f919fd84dc77de84c2e58609
Author: Daniel Qian <ch...@gmail.com>
AuthorDate: Thu Nov 7 15:31:00 2019 +0800

    SCB-1555 Integrate oas-validator compability check to cli
    Update readme
---
 README-ZH.md | 16 +++++++++++++++-
 README.md    | 15 ++++++++++++++-
 2 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/README-ZH.md b/README-ZH.md
index e357f03..c8bd5a3 100644
--- a/README-ZH.md
+++ b/README-ZH.md
@@ -269,12 +269,26 @@ $ java -jar toolkit-cli-{version}.jar docgenerate -i swagger.yaml -o ./document
 #### 3.3.3 契约风格检查
 
 ```shell
-$ java -jar toolkit-cli-{version}.jar checkstyle openapi.yaml
+$ java -jar toolkit-cli-{version}.jar checkstyle oas.yaml
+或者
+$ java -jar toolkit-cli-{version}.jar cs oas.yaml
 ```
 
 > **checkstyle** Command argument
 * &lt;file&gt; OpenAPI v3 spec yaml文件
 
+#### 3.3.4 契约兼容性检查
+
+```shell
+$ java -jar toolkit-cli-{version}.jar checkcompatibility left-oas.yaml right-oas.yaml
+或者
+$ java -jar toolkit-cli-{version}.jar cc left-oas.yaml right-oas.yaml
+```
+
+> **checkcompatibility** Command argument
+* &lt;files&gt; Two OpenAPI v3 spec yaml file
+
+
 ### 3.4 使用案例
 可以在[这里](./samples/README-ZH.md)找到使用插件的一些示例 
 
diff --git a/README.md b/README.md
index 1a43352..ba07c98 100644
--- a/README.md
+++ b/README.md
@@ -270,12 +270,25 @@ e.g：-f swagger-ui
 #### 3.3.3 Service contract style checking
 
 ```shell
-$ java -jar toolkit-cli-{version}.jar checkstyle openapi.yaml
+$ java -jar toolkit-cli-{version}.jar checkstyle oas.yaml
+or
+$ java -jar toolkit-cli-{version}.jar cs oas.yaml
 ```
 
 > **checkstyle** Command argument
 * &lt;file&gt; OpenAPI v3 spec yaml file
 
+#### 3.3.4 Service contract compatibility checking
+
+```shell
+$ java -jar toolkit-cli-{version}.jar checkcompatibility left-oas.yaml right-oas.yaml
+or
+$ java -jar toolkit-cli-{version}.jar cc left-oas.yaml right-oas.yaml
+```
+
+> **checkcompatibility** Command argument
+* &lt;files&gt; Two OpenAPI v3 spec yaml file
+
 
 ### 3.4 Use case