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/11 12:27:44 UTC
[servicecomb-toolkit] 01/02: SCB-1570 Translate javadocs of
oas-validator
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 32f044cff007005c08abcb782b2ddcba69112b4c
Author: Daniel Qian <ch...@gmail.com>
AuthorDate: Sat Nov 9 17:10:35 2019 +0800
SCB-1570 Translate javadocs of oas-validator
---
...derAddInRequestBodyNotAllowedDiffValidator.java | 2 +-
...HeaderDelInResponseNotAllowedDiffValidator.java | 2 +-
...aTypeAddInParameterNotAllowedDiffValidator.java | 2 +-
...aTypeDelInParameterNotAllowedDiffValidator.java | 2 +-
...ypeDelInRequestBodyNotAllowedDiffValidator.java | 2 +-
...iaTypeDelInResponseNotAllowedDiffValidator.java | 2 +-
...arameterAllowEmptyValueChangeDiffValidator.java | 2 +-
.../ParameterAllowReservedChangeDiffValidator.java | 2 +-
.../ParameterRequiredChangeDiffValidator.java | 2 +-
.../RequestBodyRequiredChangeDiffValidator.java | 2 +-
.../ResponseAddNotAllowedDiffValidator.java | 2 +-
.../header/HeaderDescriptionRequiredValidator.java | 4 ++--
.../info/InfoDescriptionRequiredValidator.java | 6 ++---
.../openapi/OpenApiSecurityEmptyValidator.java | 2 +-
.../openapi/OpenApiTagNotEmptyValidator.java | 5 ++--
.../validator/openapi/OpenApiVersionValidator.java | 4 ++--
.../OperationIdLowerCamelCaseValidator.java | 4 +++-
.../operation/OperationServersEmptyValidator.java | 2 +-
.../OperationSummaryRequiredValidator.java | 4 ++--
.../operation/OperationTagsOnlyOneValidator.java | 5 ++--
.../operation/OperationTagsReferenceValidator.java | 4 ++--
.../ParameterCookieLowerCamelCaseValidator.java | 4 ++--
.../ParameterDescriptionRequiredValidator.java | 4 ++--
.../ParameterHeaderUpperHyphenCaseValidator.java | 4 ++--
.../ParameterPathLowerCamelCaseValidator.java | 4 ++--
.../ParameterQueryLowerCamelCaseValidator.java | 4 ++--
.../paths/PathsLowerCamelCaseValidator.java | 9 +++++--
.../RequestBodyDescriptionRequiredValidator.java | 4 ++--
.../validator/schema/SchemaTitleValidator.java | 8 ++++---
.../tag/TagDescriptionRequiredValidator.java | 4 ++--
.../tag/TagNameUpperCamelCaseValidator.java | 4 ++--
.../validator/tag/TagReferenceValidator.java | 7 ++++--
.../config/OasValidatorsSkeletonConfiguration.java | 4 +++-
.../toolkit/oasv/common/OasObjectProperty.java | 6 ++---
.../oasv/common/OasObjectPropertyLocation.java | 28 ++++++++++++----------
.../toolkit/oasv/common/OasObjectType.java | 4 ++--
.../oasv/diffvalidation/api/OasDiffViolation.java | 4 ++--
.../diffvalidation/api/OasObjectDiffValidator.java | 18 +++++++-------
.../api/OasObjectDiffValidatorTemplate.java | 7 +++---
.../diffvalidation/api/OasSpecDiffValidator.java | 2 +-
.../api/ObjectPropertyDiffValidator.java | 8 +++----
.../diffvalidation/api/SchemaAddValidator.java | 4 ++--
.../diffvalidation/api/SchemaCompareValidator.java | 6 ++---
.../diffvalidation/api/SchemaDelValidator.java | 4 ++--
.../skeleton/schema/SchemaDiffValidatorEngine.java | 3 ++-
.../util/OasObjectDiffValidatorUtils.java | 2 +-
.../oasv/validation/api/CallbackValidator.java | 2 +-
.../oasv/validation/api/ComponentsValidator.java | 2 +-
.../oasv/validation/api/EncodingValidator.java | 2 +-
.../oasv/validation/api/ExampleValidator.java | 2 +-
.../oasv/validation/api/HeaderValidator.java | 2 +-
.../toolkit/oasv/validation/api/InfoValidator.java | 2 +-
.../toolkit/oasv/validation/api/LinkValidator.java | 2 +-
.../oasv/validation/api/MediaTypeValidator.java | 2 +-
.../oasv/validation/api/OasObjectValidator.java | 9 ++++---
.../oasv/validation/api/OasSpecValidator.java | 2 +-
.../oasv/validation/api/OasValidationContext.java | 3 +++
.../toolkit/oasv/validation/api/OasViolation.java | 6 ++---
.../api/ObjectPropertyRequiredValidator.java | 12 ++++++----
.../validation/api/ObjectPropertyValidator.java | 6 ++---
.../oasv/validation/api/OpenApiValidator.java | 2 +-
.../oasv/validation/api/OperationValidator.java | 2 +-
.../oasv/validation/api/ParameterValidator.java | 2 +-
.../oasv/validation/api/PathItemValidator.java | 2 +-
.../oasv/validation/api/PathsValidator.java | 2 +-
.../oasv/validation/api/RequestBodyValidator.java | 2 +-
.../oasv/validation/api/ResponseValidator.java | 2 +-
.../oasv/validation/api/ResponsesValidator.java | 2 +-
.../oasv/validation/api/SchemaValidator.java | 2 +-
.../validation/api/SecuritySchemeValidator.java | 2 +-
.../oasv/validation/api/ServerValidator.java | 2 +-
.../toolkit/oasv/validation/api/TagValidator.java | 2 +-
.../ComponentsCallbacksKeysValidator.java | 2 +-
.../ComponentsExamplesKeysValidator.java | 2 +-
.../encoding/EncodingHeadersKeysValidator.java | 2 +-
.../skeleton/header/HeaderSchemaValidator.java | 2 +-
.../mediatype/MediaTypeEncodingValidator.java | 2 +-
.../mediatype/MediaTypeSchemaValidator.java | 2 +-
.../openapi/OpenApiComponentsValidator.java | 3 ++-
.../skeleton/openapi/OpenApiInfoValidator.java | 3 ++-
.../skeleton/openapi/OpenApiPathsValidator.java | 3 ++-
.../skeleton/openapi/OpenApiServersValidator.java | 3 ++-
.../skeleton/openapi/OpenApiTagsValidator.java | 3 ++-
.../operation/OperationParametersValidator.java | 2 +-
.../operation/OperationRequestBodyValidator.java | 2 +-
.../operation/OperationResponsesValidator.java | 2 +-
.../parameter/ParameterContentValidator.java | 2 +-
.../parameter/ParameterSchemaValidator.java | 2 +-
.../pathitem/PathItemOperationsValidator.java | 5 ++--
.../pathitem/PathItemParametersValidator.java | 3 ++-
.../skeleton/paths/PathsPathItemsValidator.java | 3 ++-
.../requestbody/RequestBodyContentValidator.java | 2 +-
.../response/ResponseContentValidator.java | 2 +-
.../response/ResponseHeadersKeysValidator.java | 2 +-
.../responses/ResponsesResponsesValidator.java | 2 +-
.../schema/SchemaPropertiesKeysValidator.java | 2 +-
.../schema/SchemaRecursiveValidatorTemplate.java | 2 +-
.../validation/util/OasObjectValidatorUtils.java | 16 ++++++-------
.../servicecomb/toolkit/oasv/OasSpecLoader.java | 6 ++---
.../test/OasDiffValidatorTestBase.java | 2 +-
.../oasv/web/api/controller/ImportError.java | 6 ++---
.../oasv/web/api/controller/ImportError2.java | 2 +-
102 files changed, 209 insertions(+), 179 deletions(-)
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderAddInRequestBodyNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderAddInRequestBodyNotAllowedDiffValidator.java
index 7a8c4dd..47ba5d1 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderAddInRequestBodyNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderAddInRequestBodyNotAllowedDiffValidator.java
@@ -28,7 +28,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 不允许在requestBody.content.'mediaType'.encoding.'encoding'.headers 下添加Header Object
+ * Add Header Object under requestBody.content.'mediaType'.encoding.'encoding'.headers is not allowed
*/
public class HeaderAddInRequestBodyNotAllowedDiffValidator extends OasObjectDiffValidatorTemplate<Header>
implements HeaderDiffValidator {
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderDelInResponseNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderDelInResponseNotAllowedDiffValidator.java
index 8232d22..a509ef8 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderDelInResponseNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/header/HeaderDelInResponseNotAllowedDiffValidator.java
@@ -28,7 +28,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 不允许在responses.'response'.headers.headers 下删除Header Object
+ * Delete Header Object under responses.'response'.headers.headers is not allowed
*/
public class HeaderDelInResponseNotAllowedDiffValidator extends OasObjectDiffValidatorTemplate<Header>
implements HeaderDiffValidator {
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeAddInParameterNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeAddInParameterNotAllowedDiffValidator.java
index 877694f..fb6a533 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeAddInParameterNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeAddInParameterNotAllowedDiffValidator.java
@@ -28,7 +28,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 不允许在Parameter.content下添加MediaType
+ * Add MediaType Object under Parameter.content is not allowed
*/
public class MediaTypeAddInParameterNotAllowedDiffValidator
extends OasObjectDiffValidatorTemplate<MediaType>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInParameterNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInParameterNotAllowedDiffValidator.java
index eca4ac3..deb5a4e 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInParameterNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInParameterNotAllowedDiffValidator.java
@@ -28,7 +28,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 不允许在Parameter.content下删除MediaType
+ * Delete MediaType Object under Parameter.content is not allowed
*/
public class MediaTypeDelInParameterNotAllowedDiffValidator
extends OasObjectDiffValidatorTemplate<MediaType>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInRequestBodyNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInRequestBodyNotAllowedDiffValidator.java
index 6a50f83..3937468 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInRequestBodyNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInRequestBodyNotAllowedDiffValidator.java
@@ -28,7 +28,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 不允许在RequestBody.content下删除MediaType
+ * Delete MediaType Object under RequestBody.content is not allowed
*/
public class MediaTypeDelInRequestBodyNotAllowedDiffValidator
extends OasObjectDiffValidatorTemplate<MediaType>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInResponseNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInResponseNotAllowedDiffValidator.java
index 243a60b..36085f8 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInResponseNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/mediatype/MediaTypeDelInResponseNotAllowedDiffValidator.java
@@ -28,7 +28,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 不允许在responses.'response'.content.'mediaType' 下删除Header Object
+ * Delete MediaType Object under responses.'response'.content.'mediaType' is not allowed
*/
public class MediaTypeDelInResponseNotAllowedDiffValidator
extends OasObjectDiffValidatorTemplate<MediaType>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowEmptyValueChangeDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowEmptyValueChangeDiffValidator.java
index d181744..c4a3375 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowEmptyValueChangeDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowEmptyValueChangeDiffValidator.java
@@ -34,7 +34,7 @@ import static java.util.Collections.singletonList;
import static org.apache.commons.lang3.ObjectUtils.defaultIfNull;
/**
- * 仅允许false->true的修改
+ * Parameter.allowEmpty only allow change false->true
*/
public class ParameterAllowEmptyValueChangeDiffValidator
extends OasObjectDiffValidatorTemplate<Parameter>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowReservedChangeDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowReservedChangeDiffValidator.java
index 537c4ba..82a97ba 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowReservedChangeDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterAllowReservedChangeDiffValidator.java
@@ -34,7 +34,7 @@ import static java.util.Collections.singletonList;
import static org.apache.commons.lang3.ObjectUtils.defaultIfNull;
/**
- * 仅允许false->true的修改
+ * Parameter.allowReserved only allow change false->true
*/
public class ParameterAllowReservedChangeDiffValidator
extends OasObjectDiffValidatorTemplate<Parameter>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterRequiredChangeDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterRequiredChangeDiffValidator.java
index 36b4bd9..0fe57f6 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterRequiredChangeDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/parameter/ParameterRequiredChangeDiffValidator.java
@@ -34,7 +34,7 @@ import static java.util.Collections.singletonList;
import static org.apache.commons.lang3.ObjectUtils.defaultIfNull;
/**
- * 仅允许true->false的修改
+ * Parameter.required only allow change true->false
*/
public class ParameterRequiredChangeDiffValidator
extends OasObjectDiffValidatorTemplate<Parameter>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/requestbody/RequestBodyRequiredChangeDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/requestbody/RequestBodyRequiredChangeDiffValidator.java
index 28c6e70..ea3e496 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/requestbody/RequestBodyRequiredChangeDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/requestbody/RequestBodyRequiredChangeDiffValidator.java
@@ -33,7 +33,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 仅允许true->false的修改
+ * RequestBody.required only allow change true->false
*/
public class RequestBodyRequiredChangeDiffValidator
extends OasObjectDiffValidatorTemplate<RequestBody>
diff --git a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/response/ResponseAddNotAllowedDiffValidator.java b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/response/ResponseAddNotAllowedDiffValidator.java
index dacb282..6cc30a6 100755
--- a/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/response/ResponseAddNotAllowedDiffValidator.java
+++ b/oas-validator/oas-validator-compatibility/src/main/java/org/apache/servicecomb/toolkit/oasv/compatibility/validators/response/ResponseAddNotAllowedDiffValidator.java
@@ -27,7 +27,7 @@ import static org.apache.servicecomb.toolkit.oasv.diffvalidation.api.OasDiffViol
import static java.util.Collections.singletonList;
/**
- * 不允许在responses.'http status code'.下新增 Response Object
+ * Add Response Object under responses.'http status code' is not allowed
*/
public class ResponseAddNotAllowedDiffValidator
extends OasObjectDiffValidatorTemplate<ApiResponse>
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/header/HeaderDescriptionRequiredValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/header/HeaderDescriptionRequiredValidator.java
index 31f2016..c6be660 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/header/HeaderDescriptionRequiredValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/header/HeaderDescriptionRequiredValidator.java
@@ -24,9 +24,9 @@ import io.swagger.v3.oas.models.headers.Header;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject">Header Object</a>
- * .description属性校验器
+ * .description property validator
* <ul>
- * <li>必须填写</li>
+ * <li>must not be null</li>
* </ul>
*/
public class HeaderDescriptionRequiredValidator
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/info/InfoDescriptionRequiredValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/info/InfoDescriptionRequiredValidator.java
index d30ce4e..fa25a60 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/info/InfoDescriptionRequiredValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/info/InfoDescriptionRequiredValidator.java
@@ -23,10 +23,10 @@ import org.apache.servicecomb.toolkit.oasv.validation.api.ObjectPropertyRequired
import io.swagger.v3.oas.models.info.Info;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject">Info Object</a>属性校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject">Info Object</a>
+ * property validator
* <ul>
- * <li>description必须填写</li>
- * <li>version必须和Api版本一致</li>
+ * <li>description must not be null</li>
* </ul>
*/
public class InfoDescriptionRequiredValidator
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiSecurityEmptyValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiSecurityEmptyValidator.java
index 5655a87..dff5d40 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiSecurityEmptyValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiSecurityEmptyValidator.java
@@ -33,7 +33,7 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .security属性校验器
+ * .security property validator
* <ul>
* <li>This field is not allowed</li>
* </ul>
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiTagNotEmptyValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiTagNotEmptyValidator.java
index 803a691..b93b9ea 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiTagNotEmptyValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiTagNotEmptyValidator.java
@@ -32,9 +32,10 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .tags(List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>)大小校验器
+ * .tags(List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>)
+ * not empty validator
* <ul>
- * <li>数量至少为一</li>
+ * <li>at least one</li>
* </ul>
*/
public class OpenApiTagNotEmptyValidator implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiVersionValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiVersionValidator.java
index 3ea279a..79e4a6a 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiVersionValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/openapi/OpenApiVersionValidator.java
@@ -28,9 +28,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .openapi属性校验器
+ * .openapi property validator
* <ul>
- * <li>必须为3.0.x且>=3.0.2</li>
+ * <li>must be 3.0.x and >=3.0.2</li>
* </ul>
*/
public class OpenApiVersionValidator implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationIdLowerCamelCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationIdLowerCamelCaseValidator.java
index 8463915..1e25108 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationIdLowerCamelCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationIdLowerCamelCaseValidator.java
@@ -29,7 +29,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * operationId. 属性校验器lower camel case
+ * .operationId property validator
+ * <ul>
+ * <li>should be lower camel case</li>
* </ul>
*/
public class OperationIdLowerCamelCaseValidator implements OperationValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationServersEmptyValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationServersEmptyValidator.java
index 143cc80..1569596 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationServersEmptyValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationServersEmptyValidator.java
@@ -33,7 +33,7 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .servers属性校验器
+ * .servers property validator
* <ul>
* <li>This field is not allowed</li>
* </ul>
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationSummaryRequiredValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationSummaryRequiredValidator.java
index c3aac20..2b4cc97 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationSummaryRequiredValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationSummaryRequiredValidator.java
@@ -24,9 +24,9 @@ import io.swagger.v3.oas.models.Operation;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .summary属性校验器
+ * .summary property validator
* <ul>
- * <li>必填</li>
+ * <li>is field is required</li>
* </ul>
*/
public class OperationSummaryRequiredValidator
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsOnlyOneValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsOnlyOneValidator.java
index c4d76f8..b40c85a 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsOnlyOneValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsOnlyOneValidator.java
@@ -31,10 +31,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .tags属性校验器
+ * .tags property validator
* <ul>
- * <li>必须写一个</li>
- * <li>必须在OpenAPI Object的tags属性里有对应property: description，rule：必填</li>
+ * <li>at least one</li>
* </ul>
*/
public class OperationTagsOnlyOneValidator implements OperationValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsReferenceValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsReferenceValidator.java
index 122d97b..88079e5 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsReferenceValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/operation/OperationTagsReferenceValidator.java
@@ -36,9 +36,9 @@ import static java.util.stream.Collectors.toSet;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .tags属性校验器
+ * .tags property validator
* <ul>
- * <li>必须在OpenAPI Object的tags属性里有对应</li>
+ * <li>must be defined in OpenAPI Object tags property</li>
* </ul>
*/
public class OperationTagsReferenceValidator implements OperationValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterCookieLowerCamelCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterCookieLowerCamelCaseValidator.java
index 1a77169..99f4319 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterCookieLowerCamelCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterCookieLowerCamelCaseValidator.java
@@ -30,9 +30,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>
- * .name 属性校验器
+ * .name property validator
* <ul>
- * <li>如果in=cookie，必须lower camel case</li>
+ * <li>must be lower camel case</li>
* </ul>
*/
public class ParameterCookieLowerCamelCaseValidator implements ParameterValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterDescriptionRequiredValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterDescriptionRequiredValidator.java
index 86ad875..73f0d98 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterDescriptionRequiredValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterDescriptionRequiredValidator.java
@@ -24,9 +24,9 @@ import io.swagger.v3.oas.models.parameters.Parameter;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>
- * .description 属性校验器
+ * .description property validator
* <ul>
- * <li>Required</li>
+ * <li>this field is required</li>
* </ul>
*/
public class ParameterDescriptionRequiredValidator
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterHeaderUpperHyphenCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterHeaderUpperHyphenCaseValidator.java
index 8b0b5e5..e33ca04 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterHeaderUpperHyphenCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterHeaderUpperHyphenCaseValidator.java
@@ -30,9 +30,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>
- * .name 属性校验器
+ * .name property validator
* <ul>
- * <li>如果in=header，必须是upper hyphen case</li>
+ * <li>must be upper hyphen case</li>
* </ul>
*/
public class ParameterHeaderUpperHyphenCaseValidator implements ParameterValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterPathLowerCamelCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterPathLowerCamelCaseValidator.java
index 0d5f862..9d97905 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterPathLowerCamelCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterPathLowerCamelCaseValidator.java
@@ -30,9 +30,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>
- * .name 属性校验器
+ * .name property validator
* <ul>
- * <li>如果in=path，必须lower camel case</li>
+ * <li>must be lower camel case</li>
* </ul>
*/
public class ParameterPathLowerCamelCaseValidator implements ParameterValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterQueryLowerCamelCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterQueryLowerCamelCaseValidator.java
index 8352192..594209d 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterQueryLowerCamelCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/parameter/ParameterQueryLowerCamelCaseValidator.java
@@ -30,9 +30,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>
- * .name 属性校验器
+ * .name property validator
* <ul>
- * <li>如果in=query，必须lower camel case</li>
+ * <li>must be lower camel case</li>
* </ul>
*/
public class ParameterQueryLowerCamelCaseValidator implements ParameterValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/paths/PathsLowerCamelCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/paths/PathsLowerCamelCaseValidator.java
index 856e949..cb21bc2 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/paths/PathsLowerCamelCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/paths/PathsLowerCamelCaseValidator.java
@@ -35,9 +35,14 @@ import java.util.regex.Pattern;
import static org.apache.servicecomb.toolkit.oasv.util.StringCaseUtils.isLowerCamelCase;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a>lower camel case校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a>
+ * path name validator
+ * <ul>
+ * <li>path name must be lower camel case</li>
+ * </ul>
* <p>
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-templating">Path Templating</a>的变量也要是lower camel case的
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-templating">Path Templating</a>
+ * variable also must be lower camel case
* </p>
*/
public class PathsLowerCamelCaseValidator implements PathsValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/requestbody/RequestBodyDescriptionRequiredValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/requestbody/RequestBodyDescriptionRequiredValidator.java
index d80352f..d627ffd 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/requestbody/RequestBodyDescriptionRequiredValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/requestbody/RequestBodyDescriptionRequiredValidator.java
@@ -24,9 +24,9 @@ import io.swagger.v3.oas.models.parameters.RequestBody;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#request-body-object">Request Object</a>
- * .description 属性校验器
+ * .description property validator
* <ul>
- * <li>Required</li>
+ * <li>this field is required</li>
* </ul>
*/
public class RequestBodyDescriptionRequiredValidator
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/schema/SchemaTitleValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/schema/SchemaTitleValidator.java
index e224387..9ef3445 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/schema/SchemaTitleValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/schema/SchemaTitleValidator.java
@@ -32,13 +32,15 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject">Schema Object</a>.title属性校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject">Schema Object</a>
+ * .title property validator
* <ul>
- * <li>如果Schema Object的上级是
+ * <li>
+ * if this Schema Object's parent is
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject">Schema Object</a>
* /
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a>
- * ，那么必须写title</li>
+ * , then title property is required</li>
* </ul>
*/
public class SchemaTitleValidator extends SchemaRecursiveValidatorTemplate {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagDescriptionRequiredValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagDescriptionRequiredValidator.java
index 219b7eb..5f17613 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagDescriptionRequiredValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagDescriptionRequiredValidator.java
@@ -24,9 +24,9 @@ import io.swagger.v3.oas.models.tags.Tag;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>
- * .description 属性校验器
+ * .description property validator
* <ul>
- * <li>必填</li>
+ * <li>this field is required</li>
* </ul>
*/
public class TagDescriptionRequiredValidator
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagNameUpperCamelCaseValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagNameUpperCamelCaseValidator.java
index 2bb2a9a..4bdef79 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagNameUpperCamelCaseValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagNameUpperCamelCaseValidator.java
@@ -29,9 +29,9 @@ import static java.util.Collections.singletonList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>
- * .name属性校验器
+ * .name property validator
* <ul>
- * <li>upper camel case</li>
+ * <li>must be upper camel case</li>
* </ul>
*/
public class TagNameUpperCamelCaseValidator implements TagValidator {
diff --git a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagReferenceValidator.java b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagReferenceValidator.java
index 56f8220..f13c8b0 100755
--- a/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagReferenceValidator.java
+++ b/oas-validator/oas-validator-compliance/src/main/java/org/apache/servicecomb/toolkit/oasv/compliance/validator/tag/TagReferenceValidator.java
@@ -33,9 +33,12 @@ import java.util.*;
import static java.util.Collections.emptySet;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>引用情况校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>
+ * referencing validator
* <ul>
- * <li>不得存在没有被<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>引用的<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a></li>
+ * <li>
+ * Every tag object must be referenced by <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
+ * </li>
* </ul>
*/
public class TagReferenceValidator implements TagValidator {
diff --git a/oas-validator/oas-validator-core-spring/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/config/OasValidatorsSkeletonConfiguration.java b/oas-validator/oas-validator-core-spring/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/config/OasValidatorsSkeletonConfiguration.java
index 1e50064..aee568a 100755
--- a/oas-validator/oas-validator-core-spring/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/config/OasValidatorsSkeletonConfiguration.java
+++ b/oas-validator/oas-validator-core-spring/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/config/OasValidatorsSkeletonConfiguration.java
@@ -42,7 +42,9 @@ import org.springframework.context.annotation.Configuration;
import java.util.List;
/**
- * OAS骨架Validator配置，骨架Validator只那些自己没有验证逻辑，只是将OAS Object属性交给对应OAS Validator校验的Validator
+ * Skeleton OAS Validator configuration
+ * Skeleton Validators are those who don't have validation logic but just
+ * dispatch the property validation job to corresponding validators
*/
@Configuration
public class OasValidatorsSkeletonConfiguration {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectProperty.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectProperty.java
index 889dd5f..29b71c5 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectProperty.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectProperty.java
@@ -21,17 +21,17 @@ import java.util.Objects;
import java.util.StringJoiner;
/**
- * OpenAPI V3 对象属性信息
+ * OpenAPI V3 object property information
*/
public class OasObjectProperty {
/**
- * 属性名称
+ * property name
*/
private final String name;
/**
- * 属性的对象的类型，如果为null则代表基础类型，而不是OAS Object
+ * property object type, if null means primitive types, otherwise means OAS object
*/
private final OasObjectType objectType;
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectPropertyLocation.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectPropertyLocation.java
index a97ef0f..c2db622 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectPropertyLocation.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectPropertyLocation.java
@@ -24,13 +24,15 @@ import java.util.*;
import static java.util.Collections.singletonList;
/**
- * OpenAPI v3 对象所在的位置
+ * OpenAPI v3 object location
* <p>本对象immutable</p>
*/
public class OasObjectPropertyLocation {
/**
- * 第一个元素是根对象，最后一个元素为当前对象，组合起来形成一个找到当前对象的路径
+ * first element stands for root object
+ * last element stands for current object
+ * this list stands for the path from root to current object
*/
private final List<OasObjectProperty> path;
@@ -43,7 +45,7 @@ public class OasObjectPropertyLocation {
}
/**
- * 创建一个根Location
+ * Create a location for root object
*
* @return
*/
@@ -52,11 +54,11 @@ public class OasObjectPropertyLocation {
}
/**
- * 在当前路径下添加属性路径
+ * Add property to this location and return a new location
*
- * @param propertyName 属性名称
- * @param propertyType 属性的OAS对象类型
- * @return 获得新的 {@link OasObjectPropertyLocation}，原{@link OasObjectPropertyLocation}不变
+ * @param propertyName property name
+ * @param propertyType OAS object type of property
+ * @return a new {@link OasObjectPropertyLocation}，origin {@link OasObjectPropertyLocation} is untouched
*/
public OasObjectPropertyLocation property(String propertyName, OasObjectType propertyType) {
ArrayList<OasObjectProperty> oasObjectProperties = new ArrayList<>(path);
@@ -65,10 +67,10 @@ public class OasObjectPropertyLocation {
}
/**
- * 在当前路径下添加非OAS Object类型的属性路径
+ * Add a non-object(primitive) type property to this location, and return a new location
*
- * @param propertyName
- * @return 获得新的 {@link OasObjectPropertyLocation}，原{@link OasObjectPropertyLocation}不变
+ * @param propertyName property name
+ * @return a new {@link OasObjectPropertyLocation}，origin {@link OasObjectPropertyLocation} is untouched
*/
public OasObjectPropertyLocation property(String propertyName) {
ArrayList<OasObjectProperty> oasObjectProperties = new ArrayList<>(path);
@@ -77,16 +79,16 @@ public class OasObjectPropertyLocation {
}
/**
- * 从根到属性的路径
+ * Get a path from root to leaf
*
* @return
*/
public List<OasObjectProperty> getPath() {
- return path;
+ return Collections.unmodifiableList(path);
}
/**
- * 得到上级属性
+ * Get parent property
*
* @return
*/
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectType.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectType.java
index fd5ebee..041d859 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectType.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/common/OasObjectType.java
@@ -18,9 +18,9 @@
package org.apache.servicecomb.toolkit.oasv.common;
/**
- * OpenAPI v3 的Object类型
+ * OpenAPI v3 Object Type
* <p>
- * 对应<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schema">OpenAPI Specification - Schema</a>
+ * Corresponding to <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schema">OpenAPI Specification - Schema</a>
* </p>
*/
public enum OasObjectType {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasDiffViolation.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasDiffViolation.java
index 59c8c97..34838ac 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasDiffViolation.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasDiffViolation.java
@@ -25,12 +25,12 @@ import java.util.StringJoiner;
public class OasDiffViolation {
/**
- * 对象位置
+ * left OAS object location
*/
private final OasObjectPropertyLocation leftLocation;
/**
- * 对象位置
+ * right OAS object location
*/
private final OasObjectPropertyLocation rightLocation;
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidator.java
index 185334d..6645209 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidator.java
@@ -22,21 +22,21 @@ import org.apache.servicecomb.toolkit.oasv.common.OasObjectPropertyLocation;
import java.util.List;
/**
- * OAS Object差异校验器接口
+ * OAS Object difference validator interface
*
- * @param <T> <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>所定义的对象
+ * @param <T> <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a> Object
*/
public interface OasObjectDiffValidator<T> {
/**
- * leftOasObject 和 rightOasObject 不可同时为null
+ * leftOasObject and rightOasObject should not be null at the same time
*
- * @param context 差异校验上下文
- * @param leftLocation 左侧OAS Object位置（可能为空）
- * @param leftOasObject 左侧OAS Object（可能为空）
- * @param rightLocation 右侧OAS Object位置（可能为空）
- * @param rightOasObject 右侧OAS Object（可能为空）
- * @return 差异校验违例
+ * @param context difference validation context
+ * @param leftLocation left OAS Object location (maybe null)
+ * @param leftOasObject left OAS Object (maybe null)
+ * @param rightLocation right OAS Object location (maybe null)
+ * @param rightOasObject right OAS Object (maybe null)
+ * @return difference validation violations, maybe a empty list
*/
List<OasDiffViolation> validate(OasDiffValidationContext context,
OasObjectPropertyLocation leftLocation, T leftOasObject,
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidatorTemplate.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidatorTemplate.java
index c081574..4b8d336 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidatorTemplate.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasObjectDiffValidatorTemplate.java
@@ -42,7 +42,7 @@ public class OasObjectDiffValidatorTemplate<T> implements OasObjectDiffValidator
}
/**
- * 处理左边没有，右边有，即新增的情况。
+ * validate the adding situation, left side not exist but right side exists
*
* @param context
* @param rightLocation
@@ -55,7 +55,7 @@ public class OasObjectDiffValidatorTemplate<T> implements OasObjectDiffValidator
}
/**
- * 处理左边有，右边没有，即删除的情况。
+ * validate the delete situation, left side exists but right side not exist
*
* @param context
* @param leftLocation
@@ -68,7 +68,8 @@ public class OasObjectDiffValidatorTemplate<T> implements OasObjectDiffValidator
}
/**
- * 左右两边都有的情况。要注意，左右两边Object可能是equals==true的。
+ * validate the modification situation, both left side and right side right exists.
+ * notice that left maybe equals to right
*
* @param context
* @param leftLocation
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasSpecDiffValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasSpecDiffValidator.java
index ccd2164..0c3d6e7 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasSpecDiffValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/OasSpecDiffValidator.java
@@ -22,7 +22,7 @@ import io.swagger.v3.oas.models.OpenAPI;
import java.util.List;
/**
- * OAS Spec差异校验器
+ * OAS Spec difference validator
*/
public interface OasSpecDiffValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/ObjectPropertyDiffValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/ObjectPropertyDiffValidator.java
index 0eb6785..c05f6ea 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/ObjectPropertyDiffValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/ObjectPropertyDiffValidator.java
@@ -25,10 +25,10 @@ import java.util.List;
import static org.apache.servicecomb.toolkit.oasv.diffvalidation.util.OasObjectDiffValidatorUtils.doDiffValidateProperty;
/**
- * OAS Object对象的对象类型的属性差异校验器
+ * OAS Object object property difference validator
*
- * @param <T> <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>所定义的对象
- * @param <P> 属性的类型
+ * @param <T> Object defined in <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>
+ * @param <P> Property type
*/
public abstract class ObjectPropertyDiffValidator<T, P>
extends OasObjectDiffValidatorTemplate<T> {
@@ -58,7 +58,7 @@ public abstract class ObjectPropertyDiffValidator<T, P>
}
/**
- * @param oasObject 不用担心会是null
+ * @param oasObject will never be null
* @return
*/
protected abstract P getPropertyObject(T oasObject);
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaAddValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaAddValidator.java
index 3d6847a..905630b 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaAddValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaAddValidator.java
@@ -25,11 +25,11 @@ import java.util.List;
public interface SchemaAddValidator {
/**
- * 左侧没有，右侧有，即新增的情况。
+ * validate the adding situation, left side not exist but right side exists
*
* @param context
* @param rightLocation
- * @param rightOasObject 新增的Object
+ * @param rightOasObject added schema object
* @return
*/
List<OasDiffViolation> validate(OasDiffValidationContext context, OasObjectPropertyLocation rightLocation,
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaCompareValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaCompareValidator.java
index 38ff36e..a07a552 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaCompareValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaCompareValidator.java
@@ -26,11 +26,11 @@ import java.util.List;
public interface SchemaCompareValidator {
/**
- * 左右两侧都有的情况，比较左右两侧对象。
+ * validate the modification situation, both left side and right side right exists.
* <p>
- * 此方法不需要比较allOf、anyOf、oneOf、items、properties
+ * there is no need to check <code>allOf, anyOf, oneOf, items, properties</code>
* </p>
- * 这些field的递归工作由{@link SchemaDiffValidatorEngine}完成。
+ * they will be recursively checked by {@link SchemaDiffValidatorEngine}
*
* @param context
* @param leftLocation
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaDelValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaDelValidator.java
index def61cd..021dc48 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaDelValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/api/SchemaDelValidator.java
@@ -25,11 +25,11 @@ import java.util.List;
public interface SchemaDelValidator {
/**
- * 左侧有，右侧没有，即被删除的情况。
+ * validate the delete situation, left side exists but right side not exist
*
* @param context
* @param leftLocation
- * @param leftOasObject 被删除的Object
+ * @param leftOasObject deleted schema object
* @return
*/
List<OasDiffViolation> validate(
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/skeleton/schema/SchemaDiffValidatorEngine.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/skeleton/schema/SchemaDiffValidatorEngine.java
index 0f20af2..1290a72 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/skeleton/schema/SchemaDiffValidatorEngine.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/skeleton/schema/SchemaDiffValidatorEngine.java
@@ -32,7 +32,8 @@ import static java.util.Collections.singletonList;
import static java.util.stream.Collectors.toList;
/**
- * 递归校验
+ * Schema object difference validator engine.
+ * It does validation recursively
*/
public class SchemaDiffValidatorEngine
extends OasObjectDiffValidatorTemplate<Schema>
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/util/OasObjectDiffValidatorUtils.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/util/OasObjectDiffValidatorUtils.java
index 5e0f5cc..10f6e9c 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/util/OasObjectDiffValidatorUtils.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/util/OasObjectDiffValidatorUtils.java
@@ -39,7 +39,7 @@ public abstract class OasObjectDiffValidatorUtils {
}
/**
- * assert 参数null合规
+ * assert parameters is not null-malformed
*
* @param leftLocation
* @param leftOasObject
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/CallbackValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/CallbackValidator.java
index 4b56a42..52dbdac 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/CallbackValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/CallbackValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.callbacks.Callback;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject">Callback Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject">Callback Object</a> validator
*/
public interface CallbackValidator extends OasObjectValidator<Callback> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ComponentsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ComponentsValidator.java
index 980bff0..111515d 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ComponentsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ComponentsValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.Components;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a> validator
*/
public interface ComponentsValidator extends OasObjectValidator<Components> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/EncodingValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/EncodingValidator.java
index 63b2d4d..1e44c42 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/EncodingValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/EncodingValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.media.Encoding;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#encodingObject">Encoding Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#encodingObject">Encoding Object</a> validator
*/
public interface EncodingValidator extends OasObjectValidator<Encoding> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ExampleValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ExampleValidator.java
index 759e521..d02d195 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ExampleValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ExampleValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.examples.Example;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject">Example Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject">Example Object</a> validator
*/
public interface ExampleValidator extends OasObjectValidator<Example> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/HeaderValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/HeaderValidator.java
index 8f5ecfb..7f2e6d7 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/HeaderValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/HeaderValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.headers.Header;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject">Header Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject">Header Object</a> validator
*/
public interface HeaderValidator extends OasObjectValidator<Header> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/InfoValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/InfoValidator.java
index fe1e661..2824d39 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/InfoValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/InfoValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.info.Info;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject">Info Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject">Info Object</a> validator
*/
public interface InfoValidator extends OasObjectValidator<Info> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/LinkValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/LinkValidator.java
index 5eeb488..b52d49c 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/LinkValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/LinkValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.links.Link;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#link-object">Link Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#link-object">Link Object</a> validator
*/
public interface LinkValidator extends OasObjectValidator<Link> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/MediaTypeValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/MediaTypeValidator.java
index c24badf..579b6f3 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/MediaTypeValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/MediaTypeValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.media.MediaType;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#media-type-object">Media Type Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#media-type-object">Media Type Object</a> validator
*/
public interface MediaTypeValidator extends OasObjectValidator<MediaType> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasObjectValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasObjectValidator.java
index 139fde2..211960a 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasObjectValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasObjectValidator.java
@@ -22,16 +22,15 @@ import org.apache.servicecomb.toolkit.oasv.common.OasObjectPropertyLocation;
import java.util.List;
/**
- *
- * @param <T> <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>所定义的对象
+ * @param <T> Objects defined in <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>
*/
public interface OasObjectValidator<T> {
/**
- * @param context 校验上下文
- * @param location OpenAPI Object的位置
+ * @param context validation context
+ * @param location OpenAPI Object location
* @param oasObject OpenAPI Object
- * @return 校验违例
+ * @return validation violations, maybe empty list
*/
List<OasViolation> validate(OasValidationContext context, OasObjectPropertyLocation location, T oasObject);
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasSpecValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasSpecValidator.java
index 8f59ce3..96f51bd 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasSpecValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasSpecValidator.java
@@ -22,7 +22,7 @@ import io.swagger.v3.oas.models.OpenAPI;
import java.util.List;
/**
- * OAS Spec校验器
+ * OAS Spec validator
*/
public interface OasSpecValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasValidationContext.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasValidationContext.java
index 3bbaedc..b9f53d9 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasValidationContext.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasValidationContext.java
@@ -22,6 +22,9 @@ import io.swagger.v3.oas.models.OpenAPI;
import java.util.HashMap;
import java.util.Map;
+/**
+ * OAS object validation context
+ */
public class OasValidationContext {
private final OpenAPI openAPI;
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasViolation.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasViolation.java
index dd2b646..06f52d1 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasViolation.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OasViolation.java
@@ -23,17 +23,17 @@ import java.util.Objects;
import java.util.StringJoiner;
/**
- * OpenAPI v3 校验出的违反限制条件的错误
+ * OpenAPI v3 validation violation
*/
public class OasViolation {
/**
- * 对象位置
+ * Object location
*/
private final OasObjectPropertyLocation location;
/**
- * 错误信息
+ * Error message
*/
private final String error;
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyRequiredValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyRequiredValidator.java
index 2192b54..ff983a3 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyRequiredValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyRequiredValidator.java
@@ -17,9 +17,9 @@
package org.apache.servicecomb.toolkit.oasv.validation.api;
+import org.apache.commons.lang3.StringUtils;
import org.apache.servicecomb.toolkit.oasv.common.OasObjectPropertyLocation;
import org.apache.servicecomb.toolkit.oasv.common.OasObjectType;
-import org.apache.commons.lang3.StringUtils;
import java.util.List;
@@ -27,14 +27,16 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * @param <T> <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>所定义的对象
- * @param <P> 属性的类型
+ * Object property should not be null validator
+ *
+ * @param <T> Objects defined in <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>
+ * @param <P> Property type
*/
public abstract class ObjectPropertyRequiredValidator<T, P> implements OasObjectValidator<T> {
@Override
final public List<OasViolation> validate(OasValidationContext context, OasObjectPropertyLocation location,
- T oasObject) {
+ T oasObject) {
if (StringUtils.isNotBlank(get$ref(oasObject))) {
return emptyList();
}
@@ -44,7 +46,7 @@ public abstract class ObjectPropertyRequiredValidator<T, P> implements OasObject
return singletonList(new OasViolation(propertyLoc, ViolationMessages.REQUIRED));
}
if (propertyObject != null && String.class.equals(propertyObject.getClass())
- && StringUtils.isBlank((CharSequence) propertyObject)) {
+ && StringUtils.isBlank((CharSequence) propertyObject)) {
OasObjectPropertyLocation propertyLoc = location.property(getPropertyName(), getPropertyType());
return singletonList(new OasViolation(propertyLoc, ViolationMessages.REQUIRED));
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyValidator.java
index da9140e..3fe7d0a 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ObjectPropertyValidator.java
@@ -27,10 +27,10 @@ import static org.apache.servicecomb.toolkit.oasv.validation.util.OasObjectValid
import static java.util.Collections.emptyList;
/**
- * OAS Object对象的对象类型的属性校验器
+ * OAS Object object property validator
*
- * @param <T> <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>所定义的对象
- * @param <P> 属性的类型
+ * @param <T> Objects defined in <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#table-of-contents">OpenAPI Specification</a>
+ * @param <P> Property type
*/
public abstract class ObjectPropertyValidator<T, P> implements OasObjectValidator<T> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OpenApiValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OpenApiValidator.java
index ca13a39..4299fe7 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OpenApiValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OpenApiValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.OpenAPI;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a> validator
*/
public interface OpenApiValidator extends OasObjectValidator<OpenAPI> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OperationValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OperationValidator.java
index d11a756..1b0cb1b 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OperationValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/OperationValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.Operation;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a> validator
*/
public interface OperationValidator extends OasObjectValidator<Operation> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ParameterValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ParameterValidator.java
index 6f912c7..6b5514b 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ParameterValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ParameterValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.parameters.Parameter;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a> validator
*/
public interface ParameterValidator extends OasObjectValidator<Parameter> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathItemValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathItemValidator.java
index b37ae25..3fc2bd4 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathItemValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathItemValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.PathItem;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject">Path Item Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject">Path Item Object</a> validator
*/
public interface PathItemValidator extends OasObjectValidator<PathItem> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathsValidator.java
index a019a11..9b4f892 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/PathsValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.Paths;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a> validator
*/
public interface PathsValidator extends OasObjectValidator<Paths> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/RequestBodyValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/RequestBodyValidator.java
index b6c7501..59a0b5d 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/RequestBodyValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/RequestBodyValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.parameters.RequestBody;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#request-body-object">Request Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#request-body-object">Request Object</a> validator
*/
public interface RequestBodyValidator extends OasObjectValidator<RequestBody> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponseValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponseValidator.java
index a876275..1c34399 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponseValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponseValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.responses.ApiResponse;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject">Response Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject">Response Object</a> validator
*/
public interface ResponseValidator extends OasObjectValidator<ApiResponse> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponsesValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponsesValidator.java
index bb18909..e36e19d 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponsesValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ResponsesValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.responses.ApiResponses;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject">Responses Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject">Responses Object</a> validator
*/
public interface ResponsesValidator extends OasObjectValidator<ApiResponses> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SchemaValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SchemaValidator.java
index 6cab18d..0ea63ec 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SchemaValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SchemaValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.media.Schema;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject">Schema Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject">Schema Object</a> validator
*/
public interface SchemaValidator extends OasObjectValidator<Schema> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SecuritySchemeValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SecuritySchemeValidator.java
index 5691f7f..4d9712c 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SecuritySchemeValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/SecuritySchemeValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.security.SecurityScheme;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#security-scheme-object">Security Scheme Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#security-scheme-object">Security Scheme Object</a> validator
*/
public interface SecuritySchemeValidator extends OasObjectValidator<SecurityScheme> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ServerValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ServerValidator.java
index c08b0f8..526b6d0 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ServerValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/ServerValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.servers.Server;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject">Server Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject">Server Object</a> validator
*/
public interface ServerValidator extends OasObjectValidator<Server> {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/TagValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/TagValidator.java
index 79f5342..edd63d2 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/TagValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/api/TagValidator.java
@@ -20,7 +20,7 @@ package org.apache.servicecomb.toolkit.oasv.validation.api;
import io.swagger.v3.oas.models.tags.Tag;
/**
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>校验器
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a> validator
*/
public interface TagValidator extends OasObjectValidator<Tag> {
}
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsCallbacksKeysValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsCallbacksKeysValidator.java
index a796c7f..1a3989e 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsCallbacksKeysValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsCallbacksKeysValidator.java
@@ -27,7 +27,7 @@ import java.util.function.Predicate;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a>
- * .callbacks属性key校验器
+ * .callbacks property key validator
*/
public class ComponentsCallbacksKeysValidator extends MapPropertyKeysValidator<Components>
implements ComponentsValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsExamplesKeysValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsExamplesKeysValidator.java
index d08b4f8..8225058 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsExamplesKeysValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/components/ComponentsExamplesKeysValidator.java
@@ -27,7 +27,7 @@ import java.util.function.Predicate;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a>
- * .examples属性key校验器
+ * .examples property key validator
*/
public class ComponentsExamplesKeysValidator extends MapPropertyKeysValidator<Components>
implements ComponentsValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/encoding/EncodingHeadersKeysValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/encoding/EncodingHeadersKeysValidator.java
index db7977c..a5e9c1c 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/encoding/EncodingHeadersKeysValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/encoding/EncodingHeadersKeysValidator.java
@@ -27,7 +27,7 @@ import java.util.function.Predicate;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#encodingObject">Encoding Object</a>
- * .headers属性校验器
+ * .headers property key validator
*/
public class EncodingHeadersKeysValidator extends MapPropertyKeysValidator<Encoding>
implements EncodingValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/header/HeaderSchemaValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/header/HeaderSchemaValidator.java
index 6d7c6d5..96fcdde 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/header/HeaderSchemaValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/header/HeaderSchemaValidator.java
@@ -30,7 +30,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.SCHEMA;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject">Header Object</a>校验器
- * .schema属性校验器
+ * .schema property validator
*/
public class HeaderSchemaValidator extends ObjectPropertyValidator<Header, Schema> implements HeaderValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeEncodingValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeEncodingValidator.java
index 5ea54d0..526ae67 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeEncodingValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeEncodingValidator.java
@@ -31,7 +31,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.ENCODING;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#media-type-object">Media Type Object</a>
- * .encoding属性校验器
+ * .encoding property value validator
*/
public class MediaTypeEncodingValidator extends MapPropertyValuesValidator<MediaType, Encoding>
implements MediaTypeValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeSchemaValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeSchemaValidator.java
index cb3f00d..36f183f 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeSchemaValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/mediatype/MediaTypeSchemaValidator.java
@@ -30,7 +30,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.SCHEMA;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#media-type-object">Media Type Object</a>
- * .schema属性校验器
+ * .schema property validator
*/
public class MediaTypeSchemaValidator extends ObjectPropertyValidator<MediaType, Schema>
implements MediaTypeValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiComponentsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiComponentsValidator.java
index 670fc0e..e12ad55 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiComponentsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiComponentsValidator.java
@@ -30,7 +30,8 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.COMPONENT
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .components(<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a>)校验器
+ * .components(<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">Components Object</a>)
+ * validator
*/
public class OpenApiComponentsValidator extends ObjectPropertyValidator<OpenAPI, Components>
implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiInfoValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiInfoValidator.java
index 2febfd3..ad5c291 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiInfoValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiInfoValidator.java
@@ -28,7 +28,8 @@ import java.util.List;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .info (<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject">Info Object</a>)校验器
+ * .info (<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject">Info Object</a>)
+ * validator
*/
public class OpenApiInfoValidator extends ObjectPropertyValidator<OpenAPI, Info>
implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiPathsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiPathsValidator.java
index 0ed3dbc..8b49428 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiPathsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiPathsValidator.java
@@ -30,7 +30,8 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.PATHS;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .paths(<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a>)校验器
+ * .paths(<a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a>)
+ * validator
*/
public class OpenApiPathsValidator extends ObjectPropertyValidator<OpenAPI, Paths>
implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiServersValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiServersValidator.java
index 5dbe847..b3bf808 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiServersValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiServersValidator.java
@@ -30,7 +30,8 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.SERVER;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .servers(List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject">Server Object</a>)校验器
+ * .servers(List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject">Server Object</a>)
+ * validator
*/
public class OpenApiServersValidator extends ListPropertyValidator<OpenAPI, Server>
implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiTagsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiTagsValidator.java
index 43ba97b..4e0c291 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiTagsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/openapi/OpenApiTagsValidator.java
@@ -30,7 +30,8 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.TAG;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object">OpenAPI Object</a>
- * .tags(List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>)校验器
+ * .tags(List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject">Tag Object</a>)
+ * validator
*/
public class OpenApiTagsValidator extends ListPropertyValidator<OpenAPI, Tag>
implements OpenApiValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationParametersValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationParametersValidator.java
index bd0f641..2a7ea82 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationParametersValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationParametersValidator.java
@@ -30,7 +30,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.PARAMETER
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .parameters校验器
+ * .parameters property validator
*/
public class OperationParametersValidator extends ListPropertyValidator<Operation, Parameter>
implements OperationValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationRequestBodyValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationRequestBodyValidator.java
index e68a82f..16ddff2 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationRequestBodyValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationRequestBodyValidator.java
@@ -30,7 +30,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.REQUEST_B
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .requestBody校验器
+ * .requestBody property validator
*/
public class OperationRequestBodyValidator extends ObjectPropertyValidator<Operation, RequestBody>
implements OperationValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationResponsesValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationResponsesValidator.java
index e37c780..784a2e1 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationResponsesValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/operation/OperationResponsesValidator.java
@@ -30,7 +30,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.RESPONSES
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
- * .responses校验器
+ * .responses property validator
*/
public class OperationResponsesValidator extends ObjectPropertyValidator<Operation, ApiResponses>
implements OperationValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterContentValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterContentValidator.java
index 22d7e7c..f3c2d04 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterContentValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterContentValidator.java
@@ -31,7 +31,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.MEDIA_TYP
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>属性校验器
- * .content属性校验器
+ * .content property validator
*/
public class ParameterContentValidator extends MapPropertyValuesValidator<Parameter, MediaType>
implements ParameterValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterSchemaValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterSchemaValidator.java
index 04383f4..6999bcc 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterSchemaValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/parameter/ParameterSchemaValidator.java
@@ -30,7 +30,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.SCHEMA;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>属性校验器
- * .schema属性校验器
+ * .schema property validator
*/
public class ParameterSchemaValidator extends ObjectPropertyValidator<Parameter, Schema>
implements ParameterValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemOperationsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemOperationsValidator.java
index 2771f71..242d3df 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemOperationsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemOperationsValidator.java
@@ -33,8 +33,9 @@ import static java.util.Collections.emptyList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject">Path Item Object</a>
- * .get / .put / .post / .delete / .options / .head / .patch / .trace 各个
- * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>的校验器
+ * .get / .put / .post / .delete / .options / .head / .patch / .trace
+ * <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject">Operation Object</a>
+ * validator
*/
public class PathItemOperationsValidator implements PathItemValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemParametersValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemParametersValidator.java
index 7528bdf..bb145b2 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemParametersValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/pathitem/PathItemParametersValidator.java
@@ -30,7 +30,8 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.PARAMETER
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject">Path Item Object</a>
- * .parameters (List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>)的校验器
+ * .parameters (List of <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject">Parameter Object</a>)
+ * validator
*/
public class PathItemParametersValidator extends ListPropertyValidator<PathItem, Parameter>
implements PathItemValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/paths/PathsPathItemsValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/paths/PathsPathItemsValidator.java
index 10d76db..0ef3e7e 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/paths/PathsPathItemsValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/paths/PathsPathItemsValidator.java
@@ -34,7 +34,8 @@ import static org.apache.servicecomb.toolkit.oasv.validation.util.OasObjectValid
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject">Paths Object</a>
- * /{path} (Map [String, <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject">Path Item Object</a>])校验器
+ * /{path} (Map [String, <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject">Path Item Object</a>])
+ * validator
*/
public class PathsPathItemsValidator implements PathsValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/requestbody/RequestBodyContentValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/requestbody/RequestBodyContentValidator.java
index c7bdea3..c3e4bc1 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/requestbody/RequestBodyContentValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/requestbody/RequestBodyContentValidator.java
@@ -31,7 +31,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.MEDIA_TYP
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#request-body-object">Request Object</a>
- * .content属性校验器
+ * .content property value validator
*/
public class RequestBodyContentValidator
extends MapPropertyValuesValidator<RequestBody, MediaType>
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseContentValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseContentValidator.java
index 723bd0b..ae1b79a 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseContentValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseContentValidator.java
@@ -31,7 +31,7 @@ import static org.apache.servicecomb.toolkit.oasv.common.OasObjectType.MEDIA_TYP
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject">Response Object</a>
- * .content属性校验器
+ * .content property value validator
*/
public class ResponseContentValidator extends MapPropertyValuesValidator<ApiResponse, MediaType>
implements ResponseValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseHeadersKeysValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseHeadersKeysValidator.java
index 3f38124..1db4868 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseHeadersKeysValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/response/ResponseHeadersKeysValidator.java
@@ -27,7 +27,7 @@ import java.util.function.Predicate;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject">ApiResponse Object</a>
- * .callbacks属性key校验器
+ * .callbacks property key validator
*/
public class ResponseHeadersKeysValidator extends MapPropertyKeysValidator<ApiResponse>
implements ResponseValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/responses/ResponsesResponsesValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/responses/ResponsesResponsesValidator.java
index 209ae8e..5c92b65 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/responses/ResponsesResponsesValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/responses/ResponsesResponsesValidator.java
@@ -33,7 +33,7 @@ import java.util.Map;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject">Responses Object</a>
- * .default / .{Http Status Code} 属性校验器
+ * .default / .{Http Status Code} property validator
*/
public class ResponsesResponsesValidator implements ResponsesValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaPropertiesKeysValidator.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaPropertiesKeysValidator.java
index 7b81745..0ce0b83 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaPropertiesKeysValidator.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaPropertiesKeysValidator.java
@@ -33,7 +33,7 @@ import static java.util.Collections.emptyList;
/**
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject">Schema Object</a>
- * .properties属性keys校验器
+ * .properties property key validator
*/
public class SchemaPropertiesKeysValidator
extends SchemaRecursiveValidatorTemplate {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaRecursiveValidatorTemplate.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaRecursiveValidatorTemplate.java
index 96284e8..fe1477c 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaRecursiveValidatorTemplate.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/skeleton/schema/SchemaRecursiveValidatorTemplate.java
@@ -36,7 +36,7 @@ import static java.util.Collections.emptyList;
import static java.util.Collections.singletonList;
/**
- * 递归检查当前Schema Object及其properties下的所有Sub Schema Object
+ * Template for recursively validate current Schema Object and Schema Object appears in its properties
*/
public abstract class SchemaRecursiveValidatorTemplate implements SchemaValidator {
diff --git a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/util/OasObjectValidatorUtils.java b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/util/OasObjectValidatorUtils.java
index 3737977..f72894e 100755
--- a/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/util/OasObjectValidatorUtils.java
+++ b/oas-validator/oas-validator-core/src/main/java/org/apache/servicecomb/toolkit/oasv/validation/util/OasObjectValidatorUtils.java
@@ -61,10 +61,10 @@ public abstract class OasObjectValidatorUtils {
/**
* @param <T>
* @param context
- * @param ownerLocation 拥有listProperty属性的对象的Location
- * @param listPropertyName listProperty属性的名字
+ * @param ownerLocation location of owner OAS object who own this listProperty
+ * @param listPropertyName listProperty name appears in owner OAS object
* @param listProperty null-safe
- * @param elementType listProperty中element的类型
+ * @param elementType type of elements in listProperty
* @param validators
* @return
*/
@@ -92,8 +92,8 @@ public abstract class OasObjectValidatorUtils {
}
/**
- * @param ownerLocation 拥有mapProperty属性的对象的Location
- * @param mapPropertyName mapProperty属性的名字
+ * @param ownerLocation location of owner OAS object who own this mapProperty
+ * @param mapPropertyName mapProperty name appears in owner OAS object
* @param mapProperty null-safe
* @param keyPredicate
* @param errorMessage
@@ -132,10 +132,10 @@ public abstract class OasObjectValidatorUtils {
/**
* @param <T>
* @param context
- * @param ownerLocation 拥有mapProperty属性的对象的Location
- * @param mapPropertyName mapProperty属性的名字
+ * @param ownerLocation location of owner OAS object who own this mapProperty
+ * @param mapPropertyName mapProperty name appears in owner OAS object
* @param mapProperty null-safe
- * @param valueType mapProperty中value的类型
+ * @param valueType type of values in mapProperty
* @param validators
* @return
*/
diff --git a/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/OasSpecLoader.java b/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/OasSpecLoader.java
index 009c303..5f90508 100755
--- a/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/OasSpecLoader.java
+++ b/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/OasSpecLoader.java
@@ -28,7 +28,7 @@ import org.apache.commons.lang3.StringUtils;
public abstract class OasSpecLoader {
/**
- * 解析绝对路径下的文件
+ * Parse file at absolute path
*
* @param classpath
* @return
@@ -37,7 +37,7 @@ public abstract class OasSpecLoader {
/**
- * 加载绝对路径下的文件
+ * Load file at absolute path
*
* @param classpath
* @return
@@ -51,7 +51,7 @@ public abstract class OasSpecLoader {
}
/**
- * 加载相对路径下的文件
+ * Load file at relative path
*
* @param fileName
* @return
diff --git a/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/test/OasDiffValidatorTestBase.java b/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/test/OasDiffValidatorTestBase.java
index e9ac1c7..01dcc4a 100755
--- a/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/test/OasDiffValidatorTestBase.java
+++ b/oas-validator/oas-validator-test/src/main/java/org/apache/servicecomb/toolkit/oasv/diffvalidation/test/OasDiffValidatorTestBase.java
@@ -43,7 +43,7 @@ public abstract class OasDiffValidatorTestBase extends OasSpecLoader {
}
/**
- * 两边path一样
+ * create violation with location swhich are same on both side
*
* @param error
* @param path
diff --git a/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError.java b/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError.java
index be1dabc..c681351 100755
--- a/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError.java
+++ b/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError.java
@@ -42,7 +42,7 @@ public class ImportError {
}
/**
- * OAS Spec Yaml parse错误
+ * OAS Spec Yaml parse error
*
* @return
*/
@@ -51,7 +51,7 @@ public class ImportError {
}
/**
- * 违反合规性检查
+ * check style violations
*
* @return
*/
@@ -60,7 +60,7 @@ public class ImportError {
}
/**
- * 违反兼容性检查
+ * compatibility violations
*
* @return
*/
diff --git a/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError2.java b/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError2.java
index 202f328..cdd2141 100755
--- a/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError2.java
+++ b/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/api/controller/ImportError2.java
@@ -51,7 +51,7 @@ public class ImportError2 {
/**
- * 违反兼容性检查
+ * compatibility violations
*
* @return
*/