浏览代码

fix: label models section as `Schemas` in OpenAPI 3 (via #5065)

* fix: label models section `Schemas` in OpenAPI 3

* Update swos-63.js
bubble
kyle 5 年前
committed by GitHub
父节点
当前提交
91b1becc65
找不到此签名对应的密钥 GPG 密钥 ID: 4AEE18F83AFDEB23
共有 3 个文件被更改,包括 18 次插入3 次删除
  1. +2
    -2
      package-lock.json
  2. +2
    -1
      src/core/components/models.jsx
  3. +14
    -0
      test/e2e-cypress/tests/bugs/swos-63.js

+ 2
- 2
package-lock.json 查看文件

@@ -1,6 +1,6 @@
{ {
"name": "swagger-ui", "name": "swagger-ui",
"version": "3.19.5",
"version": "3.20.1",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {
@@ -7269,7 +7269,7 @@
}, },
"form-data": { "form-data": {
"version": "1.0.1", "version": "1.0.1",
"resolved": "http://registry.npmjs.org/form-data/-/form-data-1.0.1.tgz",
"resolved": "https://registry.npmjs.org/form-data/-/form-data-1.0.1.tgz",
"integrity": "sha1-rjFduaSQf6BlUCMEpm13M0de43w=", "integrity": "sha1-rjFduaSQf6BlUCMEpm13M0de43w=",
"requires": { "requires": {
"async": "^2.0.1", "async": "^2.0.1",


+ 2
- 1
src/core/components/models.jsx 查看文件

@@ -37,6 +37,7 @@ export default class Models extends Component {


let showModels = layoutSelectors.isShown("models", defaultModelsExpandDepth > 0 && docExpansion !== "none") let showModels = layoutSelectors.isShown("models", defaultModelsExpandDepth > 0 && docExpansion !== "none")
const specPathBase = this.getSchemaBasePath() const specPathBase = this.getSchemaBasePath()
const isOAS3 = specSelectors.isOAS3()


const ModelWrapper = getComponent("ModelWrapper") const ModelWrapper = getComponent("ModelWrapper")
const Collapse = getComponent("Collapse") const Collapse = getComponent("Collapse")
@@ -45,7 +46,7 @@ export default class Models extends Component {


return <section className={ showModels ? "models is-open" : "models"}> return <section className={ showModels ? "models is-open" : "models"}>
<h4 onClick={() => layoutActions.show("models", !showModels)}> <h4 onClick={() => layoutActions.show("models", !showModels)}>
<span>Models</span>
<span>{isOAS3 ? "Schemas" : "Models" }</span>
<svg width="20" height="20"> <svg width="20" height="20">
<use xlinkHref={showModels ? "#large-arrow-down" : "#large-arrow"} /> <use xlinkHref={showModels ? "#large-arrow-down" : "#large-arrow"} />
</svg> </svg>


+ 14
- 0
test/e2e-cypress/tests/bugs/swos-63.js 查看文件

@@ -0,0 +1,14 @@
describe("SWOS-63: Schema/Model section labeling", () => {
it("should render `Schemas` for OpenAPI 3", () => {
cy
.visit("/?url=/documents/petstore-expanded.openapi.yaml")
.get("section.models > h4")
.contains("Schemas")
})
it("should render `Models` for OpenAPI 2", () => {
cy
.visit("/?url=/documents/petstore.swagger.yaml")
.get("section.models > h4")
.contains("Models")
})
})

正在加载...
取消
保存