Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@

<dependency>
<groupId>org.apache.servicecomb.toolkit</groupId>
<artifactId>oas-validator-compliance</artifactId>
<artifactId>oas-validator-style</artifactId>
</dependency>

<dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
import org.apache.commons.io.FileUtils;
import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.common.OasObjectPropertyLocation;
import org.apache.servicecomb.toolkit.oasv.compliance.ComplianceCheckParser;
import org.apache.servicecomb.toolkit.oasv.compliance.factory.ValidatorFactoryComponents;
import org.apache.servicecomb.toolkit.oasv.style.StyleCheckParser;
import org.apache.servicecomb.toolkit.oasv.style.factory.ValidatorFactoryComponents;
import org.apache.servicecomb.toolkit.oasv.validation.api.OasSpecValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.OasValidationContext;
import org.apache.servicecomb.toolkit.oasv.validation.api.OasViolation;
Expand Down Expand Up @@ -72,7 +72,7 @@ public void run() {
throw new RuntimeException(e);
}

SwaggerParseResult parseResult = ComplianceCheckParser.parseYaml(yaml);
SwaggerParseResult parseResult = StyleCheckParser.parseYaml(yaml);
OpenAPI openAPI = parseResult.getOpenAPI();
if (openAPI == null) {
StringJoiner sj = new StringJoiner("\n");
Expand Down
2 changes: 1 addition & 1 deletion integration-tests/coverage-aggregate/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@

<dependency>
<groupId>org.apache.servicecomb.toolkit</groupId>
<artifactId>oas-validator-compliance</artifactId>
<artifactId>oas-validator-style</artifactId>
</dependency>

<dependency>
Expand Down
2 changes: 1 addition & 1 deletion oas-validator/README-ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OpenAPI V3 Spec校验工具。
* oas-validator-core,核心API及骨架实现
* oas-validator-core-spring,骨架的Spring Boot Starter
* oas-validator-test,核心API的测试帮助类
* oas-validator-compliance,合规性校验实现
* oas-validator-style,风格校验实现
* oas-validator-compatibility,兼容性校验实现
* oas-validator-compatibility-spring,兼容性校验实现的Spring Boot Starter
* oas-validator-web,校验工具的操作UI
Expand Down
2 changes: 1 addition & 1 deletion oas-validator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OpenAPI V3 Spec validation tools.
* oas-validator-core: core apis and skeletons implementations
* oas-validator-core-spring: Spring Boot Starter for core skeletons
* oas-validator-test: test helpers for core api
* oas-validator-compliance: check style validators
* oas-validator-style: check style validators
* oas-validator-compatibility: compatibility validators
* oas-validator-compatibility-spring: Spring Boot Starter for compatibility validators
* oas-validator-web: web ui
Expand Down
4 changes: 2 additions & 2 deletions oas-validator/doc/USAGE.MD
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@

### 验证器

分为 **合规性验证** 和 **兼容性检查**
分为 **风格校验** 和 **兼容性检查**

#### 合规性验证
#### 风格校验

对 OpenAPI Spec 文档进行规范验证,对违反规范的错误作出提示。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@

<modelVersion>4.0.0</modelVersion>

<artifactId>oas-validator-compliance</artifactId>
<artifactId>oas-validator-style</artifactId>

<properties>
<log4j2.version>2.11.0</log4j2.version>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance;
package org.apache.servicecomb.toolkit.oasv.style;

import io.swagger.v3.parser.OpenAPIV3Parser;
import io.swagger.v3.parser.core.models.ParseOptions;
import io.swagger.v3.parser.core.models.SwaggerParseResult;

public abstract class ComplianceCheckParser {
public abstract class StyleCheckParser {

private ComplianceCheckParser() {
private StyleCheckParser() {
// singleton
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.components.*;
import org.apache.servicecomb.toolkit.oasv.style.validator.components.*;
import org.apache.servicecomb.toolkit.oasv.validation.api.ComponentsValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.*;
import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.*;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.encoding.EncodingHeadersKeysCaseValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.encoding.EncodingHeadersKeysCaseValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.EncodingValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.EncodingValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.HeaderValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.header.HeaderDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.header.HeaderDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.HeaderValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.HeaderValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.SchemaValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.info.InfoDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.info.InfoDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.InfoValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.InfoValidatorFactory;
import org.springframework.stereotype.Component;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.validation.api.MediaTypeValidator;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.validation.api.DefaultOasSpecValidator;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.openapi.OpenApiSecuritySizeEqValidator;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.openapi.OpenApiTagsSizeGteValidator;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.openapi.OpenApiVersionGteValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.openapi.OpenApiSecuritySizeEqValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.openapi.OpenApiTagsSizeGteValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.openapi.OpenApiVersionGteValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.OpenApiValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.*;
import org.apache.servicecomb.toolkit.oasv.validation.skeleton.openapi.*;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.operation.*;
import org.apache.servicecomb.toolkit.oasv.style.validator.operation.*;
import org.apache.servicecomb.toolkit.oasv.validation.api.OperationValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.OperationValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.ParameterValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.parameter.*;
import org.apache.servicecomb.toolkit.oasv.style.validator.parameter.*;
import org.apache.servicecomb.toolkit.oasv.validation.api.ParameterValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.MediaTypeValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.ParameterValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.validation.api.PathItemValidator;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.paths.PathsKeyCaseValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.paths.PathsKeyCaseValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.PathsValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.PathItemValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.PathsValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.requestbody.RequestBodyDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.requestbody.RequestBodyDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.RequestBodyValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.MediaTypeValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.RequestBodyValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.response.ResponseHeadersKeysCaseValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.response.ResponseHeadersKeysCaseValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.ResponseValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.HeaderValidatorFactory;
import org.apache.servicecomb.toolkit.oasv.validation.factory.MediaTypeValidatorFactory;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.validation.api.ResponsesValidator;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.schema.SchemaPropertiesKeysCaseValidator;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.schema.SchemaTitleRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.schema.SchemaPropertiesKeysCaseValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.schema.SchemaTitleRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.SchemaValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.SchemaValidatorFactory;
import org.springframework.stereotype.Component;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.validation.api.SecuritySchemeValidator;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.validation.api.ServerValidator;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.apache.servicecomb.toolkit.oasv.FactoryOptions;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.tag.TagDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.tag.TagMustBeReferencedValidator;
import org.apache.servicecomb.toolkit.oasv.compliance.validator.tag.TagNameCaseValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.tag.TagDescriptionRequiredValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.tag.TagMustBeReferencedValidator;
import org.apache.servicecomb.toolkit.oasv.style.validator.tag.TagNameCaseValidator;
import org.apache.servicecomb.toolkit.oasv.validation.api.TagValidator;
import org.apache.servicecomb.toolkit.oasv.validation.factory.TagValidatorFactory;
import org.springframework.stereotype.Component;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.factory;
package org.apache.servicecomb.toolkit.oasv.style.factory;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsCallbacksKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsExamplesKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsHeadersKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsLinksKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsParametersKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsRequestBodiesKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsResponsesKeysValidator;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
* limitations under the License.
*/

package org.apache.servicecomb.toolkit.oasv.compliance.validator.components;
package org.apache.servicecomb.toolkit.oasv.style.validator.components;

import org.apache.servicecomb.toolkit.oasv.validation.skeleton.components.ComponentsSchemasKeysValidator;

Expand Down
Loading