fastman/lib/openapi-parser/validation/3.0/invalid-property-format.rule.ts

快速api测试及文档生成

/**
 * @license
 * Copyright 2017 Red Hat
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import {OasValidationRuleUtil} from "../validation";
import {Oas30ValidationRule} from "./common.rule";
import {OasNode} from "../../models/node.model";
import {Oas30Example, Oas30ExampleDefinition} from "../../models/3.0/example.model";
import {Oas30Contact} from "../../models/3.0/contact.model";
import {Oas30XML} from "../../models/3.0/xml.model";
import {Oas30Info} from "../../models/3.0/info.model";
import {Oas30License} from "../../models/3.0/license.model";
import {Oas30Operation} from "../../models/3.0/operation.model";
import {Oas30ExternalDocumentation} from "../../models/3.0/external-documentation.model";
import {Oas30Parameter, Oas30ParameterDefinition} from "../../models/3.0/parameter.model";
import {Oas30Header, Oas30HeaderDefinition} from "../../models/3.0/header.model";
import {Oas30Tag} from "../../models/3.0/tag.model";
import {Oas30SecurityScheme} from "../../models/3.0/security-scheme.model";
import {Oas30Response, Oas30ResponseBase, Oas30ResponseDefinition} from "../../models/3.0/response.model";
import {
    Oas30AuthorizationCodeOAuthFlow,
    Oas30ClientCredentialsOAuthFlow,
    Oas30ImplicitOAuthFlow,
    Oas30OAuthFlow,
    Oas30PasswordOAuthFlow
} from "../../models/3.0/oauth-flow.model";
import {Oas30PathItem} from "../../models/3.0/path-item.model";
import {Oas30RequestBody, Oas30RequestBodyDefinition} from "../../models/3.0/request-body.model";
import {Oas30Server} from "../../models/3.0/server.model";
import {Oas30ServerVariable} from "../../models/3.0/server-variable.model";
import {Oas30Link, Oas30LinkDefinition} from "../../models/3.0/link.model";

/**
 * Implements the Invalid Property Format validation rule.  This rule is responsible
 * for reporting whenever the value of a property fails to conform to the required
 * *format* for that property.
 */
export class Oas30InvalidPropertyFormatValidationRule extends Oas30ValidationRule {

    public visitInfo(node: Oas30Info): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("INF-3-003", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
        if (this.hasValue(node.termsOfService)) {
            this.reportIfInvalid("CTC-3-004", OasValidationRuleUtil.isValidUrl(node.termsOfService), node, `The "termsOfService" property must be a valid URL.`);
        }
    }

    protected visitResponseBase(node: Oas30ResponseBase): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("RES-3-002", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }
    public visitResponse(node: Oas30Response): void {
        this.visitResponseBase(node);
    }
    public visitResponseDefinition(node: Oas30ResponseDefinition): void {
        this.visitResponseBase(node);
    }

    public visitContact(node: Oas30Contact): void {
        if (this.hasValue(node.url)) {
            this.reportIfInvalid("CTC-3-001", OasValidationRuleUtil.isValidUrl(node.url), node, `The "url" property must be a valid URL.`);
        }
        if (this.hasValue(node.email)) {
            this.reportIfInvalid("CTC-3-002", OasValidationRuleUtil.isValidEmailAddress(node.email), node, `The "email" property must be a valid email address.`);
        }
    }

    public visitExample(node: Oas30Example): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("EX-3-001", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }
    public visitExampleDefinition(node: Oas30ExampleDefinition): void {
        this.visitExample(node);
    }

    public visitLink(node: Oas30Link): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("LINK-3-004", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }
    public visitLinkDefinition(node: Oas30LinkDefinition): void {
        this.visitLink(node);
    }

    protected visitFlow(node: Oas30OAuthFlow): void {
        if (this.hasValue(node.authorizationUrl)) {
            this.reportIfInvalid("FLOW-3-003", OasValidationRuleUtil.isValidUrl(node.authorizationUrl), node, `The "authorizationUrl" property must be a valid URL.`);
        }
        if (this.hasValue(node.tokenUrl)) {
            this.reportIfInvalid("FLOW-3-004", OasValidationRuleUtil.isValidUrl(node.tokenUrl), node, `The "tokenUrl" property must be a valid URL.`);
        }
        if (this.hasValue(node.refreshUrl)) {
            this.reportIfInvalid("FLOW-3-005", OasValidationRuleUtil.isValidUrl(node.refreshUrl), node, `The "refreshUrl" property must be a valid URL.`);
        }
    }
    public visitImplicitOAuthFlow(node: Oas30ImplicitOAuthFlow): void {
        this.visitFlow(node);
    }
    public visitPasswordOAuthFlow(node: Oas30PasswordOAuthFlow): void {
        this.visitFlow(node);
    }
    public visitClientCredentialsOAuthFlow(node: Oas30ClientCredentialsOAuthFlow): void {
        this.visitFlow(node);
    }
    public visitAuthorizationCodeOAuthFlow(node: Oas30AuthorizationCodeOAuthFlow): void {
        this.visitFlow(node);
    }

    public visitPathItem(node: Oas30PathItem): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("PATH-3-003", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }

    public visitRequestBody(node: Oas30RequestBody): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("RB-3-001", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }
    public visitRequestBodyDefinition(node: Oas30RequestBodyDefinition): void {
        this.visitRequestBody(node);
    }

    public visitLicense(node: Oas30License): void {
        if (this.hasValue(node.url)) {
            this.reportIfInvalid("LIC-3-002", OasValidationRuleUtil.isValidUrl(node.url), node, `The "url" property must be a valid URL.`);
        }
    }

    public visitOperation(node: Oas30Operation): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("OP-3-001", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }

    public visitExternalDocumentation(node: Oas30ExternalDocumentation): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("ED-3-001", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
        if (this.hasValue(node.url)) {
            this.reportIfInvalid("ED-3-003", OasValidationRuleUtil.isValidUrl(node.url), node, `The "url" property must be a valid URL.`);
        }
    }

    public visitParameter(node: Oas30Parameter): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("PAR-3-005", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }
    public visitParameterDefinition(node: Oas30ParameterDefinition): void {
        this.visitParameter(node);
    }

    public visitHeader(node: Oas30Header): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("HEAD-3-002", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }
    public visitHeaderDefinition(node: Oas30HeaderDefinition): void {
        this.visitHeader(node);
    }

    public visitTag(node: Oas30Tag): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("TAG-3-002", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }

    public visitSecurityScheme(node: Oas30SecurityScheme): void {
        if (this.hasValue(node.openIdConnectUrl)) {
            this.reportIfInvalid("SS-3-007", OasValidationRuleUtil.isValidUrl(node.openIdConnectUrl), node, "The \"openIdConnectUrl\" property must be a valid URL.");
        }
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("SS-3-009", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }

    public visitServer(node: Oas30Server): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("SRV-3-003", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
        if (this.hasValue(node.url)) {
            this.reportIfInvalid("SRV-3-002", OasValidationRuleUtil.isValidUrlTemplate(node.url), node, `The "url" property must be a valid URL.`);
        }
    }

    public visitServerVariable(node: Oas30ServerVariable): void {
        if (this.hasValue(node.description)) {
            this.reportIfInvalid("SVAR-3-002", OasValidationRuleUtil.isValidCommonMark(node.description), node, `The "description" property must be valid CommonMark syntax (or plain text).`);
        }
    }

    public visitXML(node: Oas30XML): void {
        if (this.hasValue(node.namespace)) {
            this.reportIfInvalid("XML-3-002", OasValidationRuleUtil.isValidUrl(node.namespace), node, `The "namespace" property must be a valid URL.`);
        }
    }

}