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 c65b72feaf1408aec2455e15f3a0a5f7d7a83954 Author: Daniel Qian <[email protected]> AuthorDate: Fri Nov 22 10:11:18 2019 +0800 SCB-1612 Rename oas-validator-compliance to oas-validator-style Modify oas-validator-web: 1. make doc links refer to github repo 2. change the html file name 3. change the javascript variable name --- oas-validator/doc/USAGE.MD | 4 +- .../web/page/controller/ValidatorController.java | 4 +- .../src/main/resources/static/doc/validator.html | 587 --------------------- .../src/main/resources/templates/index.html | 10 +- .../templates/validator/compatibility.html | 4 +- .../main/resources/templates/validator/style.html | 22 +- 6 files changed, 22 insertions(+), 609 deletions(-) diff --git a/oas-validator/doc/USAGE.MD b/oas-validator/doc/USAGE.MD index ffe2a0c..b10752b 100755 --- a/oas-validator/doc/USAGE.MD +++ b/oas-validator/doc/USAGE.MD @@ -25,9 +25,9 @@ ### 验证器 -分为 **合规性验证** 和 **兼容性检查** +分为 **风格校验** 和 **兼容性检查** -#### 合规性验证 +#### 风格校验 对 OpenAPI Spec 文档进行规范验证，对违反规范的错误作出提示。 diff --git a/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/page/controller/ValidatorController.java b/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/page/controller/ValidatorController.java index 862443f..87fff79 100755 --- a/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/page/controller/ValidatorController.java +++ b/oas-validator/oas-validator-web/src/main/java/org/apache/servicecomb/toolkit/oasv/web/page/controller/ValidatorController.java @@ -33,12 +33,12 @@ public class ValidatorController { return "validator/index"; } - @GetMapping(path = "/compliance") + @GetMapping(path = "/style") public String complianceValidator() { - return "validator/compliance"; + return "validator/style"; } @GetMapping(path = "/compatibility") diff --git a/oas-validator/oas-validator-web/src/main/resources/static/doc/validator.html b/oas-validator/oas-validator-web/src/main/resources/static/doc/validator.html deleted file mode 100755 index 4140f20..0000000 --- a/oas-validator/oas-validator-web/src/main/resources/static/doc/validator.html +++ /dev/null @@ -1,587 +0,0 @@ -<!-- - ~ Licensed to the Apache Software Foundation (ASF) under one or more - ~ contributor license agreements. See the NOTICE file distributed with - ~ this work for additional information regarding copyright ownership. - ~ The ASF licenses this file to You 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. - --> -<!doctype html> -<html> -<head> -<meta charset='UTF-8'><meta name='viewport' content='width=device-width initial-scale=1'> -<title>README</title><link href='https://fonts.loli.net/css?family=Open+Sans:400italic,700italic,700,400&subset=latin,latin-ext' rel='stylesheet' type='text/css' /><style type='text/css'>html {overflow-x: initial !important;}:root { --bg-color: #ffffff; --text-color: #333333; --select-text-bg-color: #B5D6FC; --select-text-font-color: auto; --monospace: "Lucida Console",Consolas,"Courier",monospace; } -html { font-size: 14px; background-color: var(--bg-color); color: var(--text-color); font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; -webkit-font-smoothing: antialiased; } -body { margin: 0px; padding: 0px; height: auto; bottom: 0px; top: 0px; left: 0px; right: 0px; font-size: 1rem; line-height: 1.42857143; overflow-x: hidden; background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; tab-size: 4; background-position: inherit inherit; background-repeat: inherit inherit; } -iframe { margin: auto; } -a.url { word-break: break-all; } -a:active, a:hover { outline: 0px; } -.in-text-selection, ::selection { text-shadow: none; background: var(--select-text-bg-color); color: var(--select-text-font-color); } -#write { margin: 0px auto; height: auto; width: inherit; word-break: normal; word-wrap: break-word; position: relative; white-space: normal; overflow-x: visible; padding-top: 40px; } -#write.first-line-indent p { text-indent: 2em; } -#write.first-line-indent li p, #write.first-line-indent p * { text-indent: 0px; } -#write.first-line-indent li { margin-left: 2em; } -.for-image #write { padding-left: 8px; padding-right: 8px; } -body.typora-export { padding-left: 30px; padding-right: 30px; } -.typora-export .footnote-line, .typora-export li, .typora-export p { white-space: pre-wrap; } -@media screen and (max-width: 500px) { - body.typora-export { padding-left: 0px; padding-right: 0px; } - #write { padding-left: 20px; padding-right: 20px; } - .CodeMirror-sizer { margin-left: 0px !important; } - .CodeMirror-gutters { display: none !important; } -} -#write li > figure:last-child { margin-bottom: 0.5rem; } -#write ol, #write ul { position: relative; } -img { max-width: 100%; vertical-align: middle; } -button, input, select, textarea { color: inherit; font-family: inherit; font-size: inherit; font-style: inherit; font-variant-caps: inherit; font-weight: inherit; font-stretch: inherit; line-height: inherit; } -input[type="checkbox"], input[type="radio"] { line-height: normal; padding: 0px; } -*, ::after, ::before { box-sizing: border-box; } -#write h1, #write h2, #write h3, #write h4, #write h5, #write h6, #write p, #write pre { width: inherit; } -#write h1, #write h2, #write h3, #write h4, #write h5, #write h6, #write p { position: relative; } -h1, h2, h3, h4, h5, h6 { break-after: avoid-page; break-inside: avoid; orphans: 2; } -p { orphans: 4; } -h1 { font-size: 2rem; } -h2 { font-size: 1.8rem; } -h3 { font-size: 1.6rem; } -h4 { font-size: 1.4rem; } -h5 { font-size: 1.2rem; } -h6 { font-size: 1rem; } -.md-math-block, .md-rawblock, h1, h2, h3, h4, h5, h6, p { margin-top: 1rem; margin-bottom: 1rem; } -.hidden { display: none; } -.md-blockmeta { color: rgb(204, 204, 204); font-weight: 700; font-style: italic; } -a { cursor: pointer; } -sup.md-footnote { padding: 2px 4px; background-color: rgba(238, 238, 238, 0.701961); color: rgb(85, 85, 85); border-top-left-radius: 4px; border-top-right-radius: 4px; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px; cursor: pointer; } -sup.md-footnote a, sup.md-footnote a:hover { color: inherit; text-transform: inherit; text-decoration: inherit; } -#write input[type="checkbox"] { cursor: pointer; width: inherit; height: inherit; } -figure { overflow-x: auto; margin: 1.2em 0px; max-width: calc(100% + 16px); padding: 0px; } -figure > table { margin: 0px !important; } -tr { break-inside: avoid; break-after: auto; } -thead { display: table-header-group; } -table { border-collapse: collapse; border-spacing: 0px; width: 100%; overflow: auto; break-inside: auto; text-align: left; } -table.md-table td { min-width: 32px; } -.CodeMirror-gutters { border-right-width: 0px; background-color: inherit; } -.CodeMirror-linenumber { } -.CodeMirror { text-align: left; } -.CodeMirror-placeholder { opacity: 0.3; } -.CodeMirror pre { padding: 0px 4px; } -.CodeMirror-lines { padding: 0px; } -div.hr:focus { cursor: none; } -#write pre { white-space: pre-wrap; } -#write.fences-no-line-wrapping pre { white-space: pre; } -#write pre.ty-contain-cm { white-space: normal; } -.CodeMirror-gutters { margin-right: 4px; } -.md-fences { font-size: 0.9rem; display: block; break-inside: avoid; text-align: left; overflow: visible; white-space: pre; background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; position: relative !important; background-position: inherit inherit; background-repeat: inherit inherit; } -.md-diagram-panel { width: 100%; margin-top: 10px; text-align: center; padding-top: 0px; padding-bottom: 8px; overflow-x: auto; } -#write .md-fences.mock-cm { white-space: pre-wrap; } -.md-fences.md-fences-with-lineno { padding-left: 0px; } -#write.fences-no-line-wrapping .md-fences.mock-cm { white-space: pre; overflow-x: auto; } -.md-fences.mock-cm.md-fences-with-lineno { padding-left: 8px; } -.CodeMirror-line, twitterwidget { break-inside: avoid; } -.footnotes { opacity: 0.8; font-size: 0.9rem; margin-top: 1em; margin-bottom: 1em; } -.footnotes + .footnotes { margin-top: 0px; } -.md-reset { margin: 0px; padding: 0px; border: 0px; outline: 0px; vertical-align: top; text-decoration: none; text-shadow: none; float: none; position: static; width: auto; height: auto; white-space: nowrap; cursor: inherit; line-height: normal; font-weight: 400; text-align: left; box-sizing: content-box; direction: ltr; background-position: 0px 0px; background-repeat: initial initial; } -li div { padding-top: 0px; } -blockquote { margin: 1rem 0px; } -li .mathjax-block, li p { margin: 0.5rem 0px; } -li { margin: 0px; position: relative; } -blockquote > :last-child { margin-bottom: 0px; } -blockquote > :first-child, li > :first-child { margin-top: 0px; } -.footnotes-area { color: rgb(136, 136, 136); margin-top: 0.714rem; padding-bottom: 0.143rem; white-space: normal; } -#write .footnote-line { white-space: pre-wrap; } -@media print { - body, html { border: 1px solid transparent; height: 99%; break-after: avoid-page; break-before: avoid-page; } - #write { margin-top: 0px; padding-top: 0px; border-color: transparent !important; } - .typora-export * { -webkit-print-color-adjust: exact; } - html.blink-to-pdf { font-size: 13px; } - .typora-export #write { padding-left: 32px; padding-right: 32px; padding-bottom: 0px; break-after: avoid-page; } - .typora-export #write::after { height: 0px; } - @page { margin: 20mm 0px; } -} -.footnote-line { margin-top: 0.714em; font-size: 0.7em; } -a img, img a { cursor: pointer; } -pre.md-meta-block { font-size: 0.8rem; min-height: 0.8rem; white-space: pre-wrap; background-color: rgb(204, 204, 204); display: block; overflow-x: hidden; background-position: initial initial; background-repeat: initial initial; } -p > .md-image:only-child:not(.md-img-error) img, p > img:only-child { display: block; margin: auto; } -p > .md-image:only-child { display: inline-block; width: 100%; } -#write .MathJax_Display { margin: 0.8em 0px 0px; } -.md-math-block { width: 100%; } -.md-math-block:not(:empty)::after { display: none; } -[contenteditable="true"]:active, [contenteditable="true"]:focus { outline: 0px; box-shadow: none; } -.md-task-list-item { position: relative; list-style-type: none; } -.task-list-item.md-task-list-item { padding-left: 0px; } -.md-task-list-item > input { position: absolute; top: 0px; left: 0px; margin-left: -1.2em; margin-top: calc(1em - 10px); border: none; } -.math { font-size: 1rem; } -.md-toc { min-height: 3.58rem; position: relative; font-size: 0.9rem; border-top-left-radius: 10px; border-top-right-radius: 10px; border-bottom-right-radius: 10px; border-bottom-left-radius: 10px; } -.md-toc-content { position: relative; margin-left: 0px; } -.md-toc-content::after, .md-toc::after { display: none; } -.md-toc-item { display: block; color: rgb(65, 131, 196); } -.md-toc-item a { text-decoration: none; } -.md-toc-inner:hover { text-decoration: underline; } -.md-toc-inner { display: inline-block; cursor: pointer; } -.md-toc-h1 .md-toc-inner { margin-left: 0px; font-weight: 700; } -.md-toc-h2 .md-toc-inner { margin-left: 2em; } -.md-toc-h3 .md-toc-inner { margin-left: 4em; } -.md-toc-h4 .md-toc-inner { margin-left: 6em; } -.md-toc-h5 .md-toc-inner { margin-left: 8em; } -.md-toc-h6 .md-toc-inner { margin-left: 10em; } -@media screen and (max-width: 48em) { - .md-toc-h3 .md-toc-inner { margin-left: 3.5em; } - .md-toc-h4 .md-toc-inner { margin-left: 5em; } - .md-toc-h5 .md-toc-inner { margin-left: 6.5em; } - .md-toc-h6 .md-toc-inner { margin-left: 8em; } -} -a.md-toc-inner { font-size: inherit; font-style: inherit; font-weight: inherit; line-height: inherit; } -.footnote-line a:not(.reversefootnote) { color: inherit; } -.md-attr { display: none; } -.md-fn-count::after { content: "."; } -code, pre, samp, tt { font-family: var(--monospace); } -kbd { margin: 0px 0.1em; padding: 0.1em 0.6em; font-size: 0.8em; color: rgb(36, 39, 41); background-color: rgb(255, 255, 255); border: 1px solid rgb(173, 179, 185); border-top-left-radius: 3px; border-top-right-radius: 3px; border-bottom-right-radius: 3px; border-bottom-left-radius: 3px; box-shadow: rgba(12, 13, 14, 0.2) 0px 1px 0px, rgb(255, 255, 255) 0px 0px 0px 2px inset; white-space: nowrap; vertical-align: middle; background-position: initial initial; background-repeat: initial initial; } -.md-comment { color: rgb(162, 127, 3); opacity: 0.8; font-family: var(--monospace); } -code { text-align: left; } -a.md-print-anchor { white-space: pre !important; border: none !important; display: inline-block !important; position: absolute !important; width: 1px !important; right: 0px !important; outline: 0px !important; text-shadow: initial !important; background-position: 0px 0px !important; background-repeat: initial initial !important; } -.md-inline-math .MathJax_SVG .noError { display: none !important; } -.html-for-mac .inline-math-svg .MathJax_SVG { vertical-align: 0.2px; } -.md-math-block .MathJax_SVG_Display { text-align: center; margin: 0px; position: relative; text-indent: 0px; max-width: none; max-height: none; min-height: 0px; min-width: 100%; width: auto; overflow-y: hidden; display: block !important; } -.MathJax_SVG_Display, .md-inline-math .MathJax_SVG_Display { width: auto; margin: inherit; display: inline-block !important; } -.MathJax_SVG .MJX-monospace { font-family: var(--monospace); } -.MathJax_SVG .MJX-sans-serif { font-family: sans-serif; } -.MathJax_SVG { display: inline; font-style: normal; font-weight: 400; line-height: normal; zoom: 90%; text-indent: 0px; text-align: left; text-transform: none; letter-spacing: normal; word-spacing: normal; word-wrap: normal; white-space: nowrap; float: none; direction: ltr; max-width: none; max-height: none; min-width: 0px; min-height: 0px; border: 0px; padding: 0px; margin: 0px; } -.MathJax_SVG * { transition: none; } -.MathJax_SVG_Display svg { vertical-align: middle !important; margin-bottom: 0px !important; } -.os-windows.monocolor-emoji .md-emoji { font-family: "Segoe UI Symbol", sans-serif; } -.md-diagram-panel > svg { max-width: 100%; } -[lang="mermaid"] svg, [lang="flow"] svg { max-width: 100%; } -[lang="mermaid"] .node text { font-size: 1rem; } -table tr th { border-bottom-width: 0px; } -video { max-width: 100%; display: block; margin: 0px auto; } -iframe { max-width: 100%; width: 100%; border: none; } -.highlight td, .highlight tr { border: 0px; } - - -.CodeMirror { height: auto; } -.CodeMirror.cm-s-inner { background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; background-position: inherit inherit; background-repeat: inherit inherit; } -.CodeMirror-scroll { overflow-y: hidden; overflow-x: auto; z-index: 3; } -.CodeMirror-gutter-filler, .CodeMirror-scrollbar-filler { background-color: rgb(255, 255, 255); } -.CodeMirror-gutters { border-right-width: 1px; border-right-style: solid; border-right-color: rgb(221, 221, 221); background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; white-space: nowrap; background-position: inherit inherit; background-repeat: inherit inherit; } -.CodeMirror-linenumber { padding: 0px 3px 0px 5px; text-align: right; color: rgb(153, 153, 153); } -.cm-s-inner .cm-keyword { color: rgb(119, 0, 136); } -.cm-s-inner .cm-atom, .cm-s-inner.cm-atom { color: rgb(34, 17, 153); } -.cm-s-inner .cm-number { color: rgb(17, 102, 68); } -.cm-s-inner .cm-def { color: rgb(0, 0, 255); } -.cm-s-inner .cm-variable { color: rgb(0, 0, 0); } -.cm-s-inner .cm-variable-2 { color: rgb(0, 85, 170); } -.cm-s-inner .cm-variable-3 { color: rgb(0, 136, 85); } -.cm-s-inner .cm-string { color: rgb(170, 17, 17); } -.cm-s-inner .cm-property { color: rgb(0, 0, 0); } -.cm-s-inner .cm-operator { color: rgb(152, 26, 26); } -.cm-s-inner .cm-comment, .cm-s-inner.cm-comment { color: rgb(170, 85, 0); } -.cm-s-inner .cm-string-2 { color: rgb(255, 85, 0); } -.cm-s-inner .cm-meta { color: rgb(85, 85, 85); } -.cm-s-inner .cm-qualifier { color: rgb(85, 85, 85); } -.cm-s-inner .cm-builtin { color: rgb(51, 0, 170); } -.cm-s-inner .cm-bracket { color: rgb(153, 153, 119); } -.cm-s-inner .cm-tag { color: rgb(17, 119, 0); } -.cm-s-inner .cm-attribute { color: rgb(0, 0, 204); } -.cm-s-inner .cm-header, .cm-s-inner.cm-header { color: rgb(0, 0, 255); } -.cm-s-inner .cm-quote, .cm-s-inner.cm-quote { color: rgb(0, 153, 0); } -.cm-s-inner .cm-hr, .cm-s-inner.cm-hr { color: rgb(153, 153, 153); } -.cm-s-inner .cm-link, .cm-s-inner.cm-link { color: rgb(0, 0, 204); } -.cm-negative { color: rgb(221, 68, 68); } -.cm-positive { color: rgb(34, 153, 34); } -.cm-header, .cm-strong { font-weight: 700; } -.cm-del { text-decoration: line-through; } -.cm-em { font-style: italic; } -.cm-link { text-decoration: underline; } -.cm-error { color: red; } -.cm-invalidchar { color: red; } -.cm-constant { color: rgb(38, 139, 210); } -.cm-defined { color: rgb(181, 137, 0); } -div.CodeMirror span.CodeMirror-matchingbracket { color: rgb(0, 255, 0); } -div.CodeMirror span.CodeMirror-nonmatchingbracket { color: rgb(255, 34, 34); } -.cm-s-inner .CodeMirror-activeline-background { background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; background-position: inherit inherit; background-repeat: inherit inherit; } -.CodeMirror { position: relative; overflow: hidden; } -.CodeMirror-scroll { height: 100%; outline: 0px; position: relative; box-sizing: content-box; background-image: inherit; background-size: inherit; background-attachment: inherit; background-origin: inherit; background-clip: inherit; background-color: inherit; background-position: inherit inherit; background-repeat: inherit inherit; } -.CodeMirror-sizer { position: relative; } -.CodeMirror-gutter-filler, .CodeMirror-hscrollbar, .CodeMirror-scrollbar-filler, .CodeMirror-vscrollbar { position: absolute; z-index: 6; display: none; } -.CodeMirror-vscrollbar { right: 0px; top: 0px; overflow: hidden; } -.CodeMirror-hscrollbar { bottom: 0px; left: 0px; overflow: hidden; } -.CodeMirror-scrollbar-filler { right: 0px; bottom: 0px; } -.CodeMirror-gutter-filler { left: 0px; bottom: 0px; } -.CodeMirror-gutters { position: absolute; left: 0px; top: 0px; padding-bottom: 30px; z-index: 3; } -.CodeMirror-gutter { white-space: normal; height: 100%; box-sizing: content-box; padding-bottom: 30px; margin-bottom: -32px; display: inline-block; } -.CodeMirror-gutter-wrapper { position: absolute; z-index: 4; border: none !important; background-position: 0px 0px !important; background-repeat: initial initial !important; } -.CodeMirror-gutter-background { position: absolute; top: 0px; bottom: 0px; z-index: 4; } -.CodeMirror-gutter-elt { position: absolute; cursor: default; z-index: 4; } -.CodeMirror-lines { cursor: text; } -.CodeMirror pre { border-top-left-radius: 0px; border-top-right-radius: 0px; border-bottom-right-radius: 0px; border-bottom-left-radius: 0px; border-width: 0px; font-family: inherit; font-size: inherit; margin: 0px; white-space: pre; word-wrap: normal; color: inherit; z-index: 2; position: relative; overflow: visible; background-position: 0px 0px; background-repeat: initial initial; } -.CodeMirror-wrap pre { word-wrap: break-word; white-space: pre-wrap; word-break: normal; } -.CodeMirror-code pre { border-right-width: 30px; border-right-style: solid; border-right-color: transparent; width: fit-content; } -.CodeMirror-wrap .CodeMirror-code pre { border-right-style: none; width: auto; } -.CodeMirror-linebackground { position: absolute; left: 0px; right: 0px; top: 0px; bottom: 0px; z-index: 0; } -.CodeMirror-linewidget { position: relative; z-index: 2; overflow: auto; } -.CodeMirror-wrap .CodeMirror-scroll { overflow-x: hidden; } -.CodeMirror-measure { position: absolute; width: 100%; height: 0px; overflow: hidden; visibility: hidden; } -.CodeMirror-measure pre { position: static; } -.CodeMirror div.CodeMirror-cursor { position: absolute; visibility: hidden; border-right-style: none; width: 0px; } -.CodeMirror div.CodeMirror-cursor { visibility: hidden; } -.CodeMirror-focused div.CodeMirror-cursor { visibility: inherit; } -.cm-searching { background-color: rgba(255, 255, 0, 0.4); background-position: initial initial; background-repeat: initial initial; } -@media print { - .CodeMirror div.CodeMirror-cursor { visibility: hidden; } -} - - -:root { - --side-bar-bg-color: #fafafa; - --control-text-color: #777; -} - -@include-when-export url(https://fonts.loli.net/css?family=Open+Sans:400italic,700italic,700,400&subset=latin,latin-ext); - -html { - font-size: 16px; -} - -body { - font-family: "Open Sans","Clear Sans","Helvetica Neue",Helvetica,Arial,sans-serif; - color: rgb(51, 51, 51); - line-height: 1.6; -} - -#write { - max-width: 860px; - margin: 0 auto; - padding: 30px; - padding-bottom: 100px; -} -#write > ul:first-child, -#write > ol:first-child{ - margin-top: 30px; -} - -a { - color: #4183C4; -} -h1, -h2, -h3, -h4, -h5, -h6 { - position: relative; - margin-top: 1rem; - margin-bottom: 1rem; - font-weight: bold; - line-height: 1.4; - cursor: text; -} -h1:hover a.anchor, -h2:hover a.anchor, -h3:hover a.anchor, -h4:hover a.anchor, -h5:hover a.anchor, -h6:hover a.anchor { - text-decoration: none; -} -h1 tt, -h1 code { - font-size: inherit; -} -h2 tt, -h2 code { - font-size: inherit; -} -h3 tt, -h3 code { - font-size: inherit; -} -h4 tt, -h4 code { - font-size: inherit; -} -h5 tt, -h5 code { - font-size: inherit; -} -h6 tt, -h6 code { - font-size: inherit; -} -h1 { - padding-bottom: .3em; - font-size: 2.25em; - line-height: 1.2; - border-bottom: 1px solid #eee; -} -h2 { - padding-bottom: .3em; - font-size: 1.75em; - line-height: 1.225; - border-bottom: 1px solid #eee; -} -h3 { - font-size: 1.5em; - line-height: 1.43; -} -h4 { - font-size: 1.25em; -} -h5 { - font-size: 1em; -} -h6 { - font-size: 1em; - color: #777; -} -p, -blockquote, -ul, -ol, -dl, -table{ - margin: 0.8em 0; -} -li>ol, -li>ul { - margin: 0 0; -} -hr { - height: 2px; - padding: 0; - margin: 16px 0; - background-color: #e7e7e7; - border: 0 none; - overflow: hidden; - box-sizing: content-box; -} - -li p.first { - display: inline-block; -} -ul, -ol { - padding-left: 30px; -} -ul:first-child, -ol:first-child { - margin-top: 0; -} -ul:last-child, -ol:last-child { - margin-bottom: 0; -} -blockquote { - border-left: 4px solid #dfe2e5; - padding: 0 15px; - color: #777777; -} -blockquote blockquote { - padding-right: 0; -} -table { - padding: 0; - word-break: initial; -} -table tr { - border-top: 1px solid #dfe2e5; - margin: 0; - padding: 0; -} -table tr:nth-child(2n), -thead { - background-color: #f8f8f8; -} -table tr th { - font-weight: bold; - border: 1px solid #dfe2e5; - border-bottom: 0; - text-align: left; - margin: 0; - padding: 6px 13px; -} -table tr td { - border: 1px solid #dfe2e5; - text-align: left; - margin: 0; - padding: 6px 13px; -} -table tr th:first-child, -table tr td:first-child { - margin-top: 0; -} -table tr th:last-child, -table tr td:last-child { - margin-bottom: 0; -} - -.CodeMirror-lines { - padding-left: 4px; -} - -.code-tooltip { - box-shadow: 0 1px 1px 0 rgba(0,28,36,.3); - border-top: 1px solid #eef2f2; -} - -.md-fences, -code, -tt { - border: 1px solid #e7eaed; - background-color: #f8f8f8; - border-radius: 3px; - padding: 0; - padding: 2px 4px 0px 4px; - font-size: 0.9em; -} - -code { - background-color: #f3f4f4; - padding: 0 2px 0 2px; -} - -.md-fences { - margin-bottom: 15px; - margin-top: 15px; - padding-top: 8px; - padding-bottom: 6px; -} - - -.md-task-list-item > input { - margin-left: -1.3em; -} - -@media print { - html { - font-size: 13px; - } - table, - pre { - page-break-inside: avoid; - } - pre { - word-wrap: break-word; - } -} - -.md-fences { - background-color: #f8f8f8; -} -#write pre.md-meta-block { - padding: 1rem; - font-size: 85%; - line-height: 1.45; - background-color: #f7f7f7; - border: 0; - border-radius: 3px; - color: #777777; - margin-top: 0 !important; -} - -.mathjax-block>.code-tooltip { - bottom: .375rem; -} - -.md-mathjax-midline { - background: #fafafa; -} - -#write>h3.md-focus:before{ - left: -1.5625rem; - top: .375rem; -} -#write>h4.md-focus:before{ - left: -1.5625rem; - top: .285714286rem; -} -#write>h5.md-focus:before{ - left: -1.5625rem; - top: .285714286rem; -} -#write>h6.md-focus:before{ - left: -1.5625rem; - top: .285714286rem; -} -.md-image>.md-meta { - /*border: 1px solid #ddd;*/ - border-radius: 3px; - padding: 2px 0px 0px 4px; - font-size: 0.9em; - color: inherit; -} - -.md-tag { - color: #a7a7a7; - opacity: 1; -} - -.md-toc { - margin-top:20px; - padding-bottom:20px; -} - -.sidebar-tabs { - border-bottom: none; -} - -#typora-quick-open { - border: 1px solid #ddd; - background-color: #f8f8f8; -} - -#typora-quick-open-item { - background-color: #FAFAFA; - border-color: #FEFEFE #e5e5e5 #e5e5e5 #eee; - border-style: solid; - border-width: 1px; -} - -/** focus mode */ -.on-focus-mode blockquote { - border-left-color: rgba(85, 85, 85, 0.12); -} - -header, .context-menu, .megamenu-content, footer{ - font-family: "Segoe UI", "Arial", sans-serif; -} - -.file-node-content:hover .file-node-icon, -.file-node-content:hover .file-node-open-state{ - visibility: visible; -} - -.mac-seamless-mode #typora-sidebar { - background-color: #fafafa; - background-color: var(--side-bar-bg-color); -} - -.md-lang { - color: #b4654d; -} - -.html-for-mac .context-menu { - --item-hover-bg-color: #E6F0FE; -} - -#md-notification .btn { - border: 0; -} - -.dropdown-menu .divider { - border-color: #e5e5e5; -} - - .typora-export li, .typora-export p, .typora-export, .footnote-line {white-space: normal;} -</style> -</head> -<body class='typora-export' > -<div id='write' class = 'is-mac'><h1><a name='header-n0' class='md-header-anchor '></a>OAS Validator</h1><p>OpenAPI V3 Spec校验工具。</p><div class='md-toc' mdtype='toc'><p class="md-toc-content"><span class="md-toc-item md-toc-h1" data-ref="n0"><a class="md-toc-inner" href="#header-n0">OAS Validator</a></span><span class="md-toc-item md-toc-h2" data-ref="n4"><a class="md-toc-inner" href="#header-n4">项目结构</a></span><span class="md-toc-item md-toc-h2" data-ref="n20"><a class="md-toc-inner" h [...] -</body> -</html> diff --git a/oas-validator/oas-validator-web/src/main/resources/templates/index.html b/oas-validator/oas-validator-web/src/main/resources/templates/index.html index 1a986f3..e189139 100755 --- a/oas-validator/oas-validator-web/src/main/resources/templates/index.html +++ b/oas-validator/oas-validator-web/src/main/resources/templates/index.html @@ -29,7 +29,7 @@ <nav class="navbar navbar-expand-lg navbar-dark bg-dark"> <!-- Navbar content --> - <a class="navbar-brand" href="#">Servicecomb toolkit</a> + <a class="navbar-brand" href="#">Apache ServiceComb Toolkit OAS Validator</a> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> @@ -52,9 +52,9 @@ <div class="card mb-3 "> <!-- <img src="..." class="card-img-top" alt="..."> --> <div class="card-body"> - <h5 class="card-title">合规性校验 <span style="font-size: 1rem;">[<a href="#" th:href="@{/doc/validator.html#header-n20}" target="_blank">文档</a>]</span> </h5> - <p class="card-text">对OAS Yaml文档的内容做合规性校验</p> - <a href="#" th:href="@{/validator/compliance}" class="btn btn-primary">进入</a> + <h5 class="card-title">风格校验 <span style="font-size: 1rem;">[<a href="https://github.com/apache/servicecomb-toolkit/blob/master/oas-validator/README.md"; target="_blank">文档</a>]</span> </h5> + <p class="card-text">对OAS Yaml文档的内容做风格校验</p> + <a href="#" th:href="@{/validator/style}" class="btn btn-primary">进入</a> </div> </div> @@ -62,7 +62,7 @@ <div class="card mb-3 "> <!-- <img src="..." class="card-img-top" alt="..."> --> <div class="card-body"> - <h5 class="card-title">兼容性检查 <span style="font-size: 1rem;">[<a href="#" th:href="@{/doc/validator.html#header-n200}" target="_blank">文档</a>]</span> </h5> + <h5 class="card-title">兼容性检查 <span style="font-size: 1rem;">[<a href="https://github.com/apache/servicecomb-toolkit/blob/master/oas-validator/README.md"; target="_blank">文档</a>]</span> </h5> <p class="card-text">对新旧两个版本的OAS做兼容性检查。</p> <a href="#" th:href="@{/validator/compatibility}" class="btn btn-primary">进入</a> </div> diff --git a/oas-validator/oas-validator-web/src/main/resources/templates/validator/compatibility.html b/oas-validator/oas-validator-web/src/main/resources/templates/validator/compatibility.html index e6aeb25..b7dc8e6 100755 --- a/oas-validator/oas-validator-web/src/main/resources/templates/validator/compatibility.html +++ b/oas-validator/oas-validator-web/src/main/resources/templates/validator/compatibility.html @@ -29,7 +29,7 @@ <nav class="navbar navbar-expand-lg navbar-dark bg-dark"> <!-- Navbar content --> - <a class="navbar-brand" href="#">Servicecomb toolkit</a> + <a class="navbar-brand" href="#">Apache ServiceComb Toolkit OAS Validator</a> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> @@ -46,7 +46,7 @@ <div class="container"> - <h2>兼容性检查 <span style="font-size: 1rem;">[<a href="#" th:href="@{/doc/validator.html#header-n200}" target="_blank">文档</a>]</span> </h2> + <h2>兼容性检查 <span style="font-size: 1rem;">[<a href="https://github.com/apache/servicecomb-toolkit/blob/master/oas-validator/README.md"; target="_blank">文档</a>]</span> </h2> <div class="" style="height: 20px;"></div> <div> diff --git a/oas-validator/oas-validator-web/src/main/resources/templates/validator/style.html b/oas-validator/oas-validator-web/src/main/resources/templates/validator/style.html index b2726a3..7bffb72 100755 --- a/oas-validator/oas-validator-web/src/main/resources/templates/validator/style.html +++ b/oas-validator/oas-validator-web/src/main/resources/templates/validator/style.html @@ -20,7 +20,7 @@ <head> <meta content="text/html;charset=UTF-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> - <title>The OpenAPI Specification Tools - Compliance Validator</title> + <title>The OpenAPI Specification Tools - Style Check Validator</title> <link href="asserts/css/bootstrap.min.css" th:href="@{/webjars/bootstrap/4.3.1/css/bootstrap.css}" rel="stylesheet"> </head> @@ -29,7 +29,7 @@ <nav class="navbar navbar-expand-lg navbar-dark bg-dark"> <!-- Navbar content --> - <a class="navbar-brand" href="#">Servicecomb toolkit</a> + <a class="navbar-brand" href="#">Apache ServiceComb Toolkit OAS Validator</a> <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> @@ -46,20 +46,20 @@ <div class="container"> - <h2>合规性校验 <span style="font-size: 1rem;">[<a href="#" th:href="@{/doc/validator.html#header-n20}" target="_blank">文档</a>]</span> </h2> + <h2>风格校验 <span style="font-size: 1rem;">[<a href="https://github.com/apache/servicecomb-toolkit/blob/master/oas-validator/README.md"; target="_blank">文档</a>]</span> </h2> <div class="" style="height: 20px;"></div> <div> <textarea name="yaml" placeholder="OpenAPI Document（yaml）" style="width: 80%; height: 480px;"></textarea> <div> - <button id="complianceValidate" class="btn btn-info">合规性校验</button> + <button id="styleValidate" class="btn btn-info">风格校验</button> </div> </div> <div class="" style="height: 20px;"></div> <div> - <code id="complianceViolations"></code> + <code id="styleViolations"></code> </div> <div class="" style="height: 20px;"></div> @@ -89,7 +89,7 @@ $(function(){ - $('#complianceValidate').on('click', function(e) { + $('#styleValidate').on('click', function(e) { var url = "/api/style"; var yaml = $('textarea[name="yaml"]').val(); if (yaml=="") {return;} @@ -105,10 +105,10 @@ var data = json.data; - var complianceViolations = $("#complianceViolations"); - complianceViolations.empty(); + var styleViolations = $("#styleViolations"); + styleViolations.empty(); - if (!addParseErrors(complianceViolations, data.parseErrors)) { + if (!addParseErrors(styleViolations, data.parseErrors)) { return; } @@ -131,8 +131,8 @@ var errorInfo = ""+ locationPath + " : " + violation.error; - complianceViolations.append(errorInfo); - complianceViolations.append("<br/>"); + styleViolations.append(errorInfo); + styleViolations.append("<br/>"); }); });
