{
+ if (typeof uri !== "string") {
+ return null
+ }
+
+ const unescaped = uri.replace(/~1/g, "/").replace(/~0/g, "~")
+ try {
+ return decodeURIComponent(unescaped)
+ } catch {
+ return unescaped
+ }
+}
+
+const getRefDisplayName = (ref) => {
+ if (typeof ref !== "string") {
+ return null
+ }
+ if (ref.indexOf("#/definitions/") !== -1) {
+ return decodeRefName(ref.replace(/^.*#\/definitions\//, ""))
+ }
+ if (ref.indexOf("#/components/schemas/") !== -1) {
+ return decodeRefName(ref.replace(/^.*#\/components\/schemas\//, ""))
+ }
+ return null
+}
+
+const inferSchemaDisplayName = (schema, level = 0) => {
+ if (!schema || typeof schema.get !== "function" || level > 2) {
+ return null
+ }
+
+ const title = schema.get("title")
+ if (typeof title === "string" && title) {
+ return title
+ }
+
+ const refDisplayName = getRefDisplayName(
+ schema.get("$$ref") || schema.get("$ref")
+ )
+ if (refDisplayName) {
+ return refDisplayName
+ }
+
+ const compositions = ["allOf", "oneOf", "anyOf"]
+ for (let i = 0; i < compositions.length; i++) {
+ const composed = schema.get(compositions[i])
+ if (List.isList(composed) && composed.size) {
+ for (let j = 0; j < composed.size; j++) {
+ const inferred = inferSchemaDisplayName(composed.get(j), level + 1)
+ if (inferred) {
+ return inferred
+ }
+ }
+ }
+ }
+
+ return null
+}
+
export default class ObjectModel extends Component {
static propTypes = {
schema: PropTypes.object.isRequired,
@@ -237,6 +296,8 @@ export default class ObjectModel extends Component {
| {"allOf ->"} |
{allOf.map((schema, k) => {
+ const inferredDisplayName =
+ inferSchemaDisplayName(schema)
return (
@@ -259,6 +321,8 @@ export default class ObjectModel extends Component {
| {"anyOf ->"} |
{anyOf.map((schema, k) => {
+ const inferredDisplayName =
+ inferSchemaDisplayName(schema)
return (
@@ -281,6 +346,8 @@ export default class ObjectModel extends Component {
| {"oneOf ->"} |
{oneOf.map((schema, k) => {
+ const inferredDisplayName =
+ inferSchemaDisplayName(schema)
return (
diff --git a/test/e2e-cypress/e2e/features/resolve-subtree-on-expand-disabled.cy.js b/test/e2e-cypress/e2e/features/resolve-subtree-on-expand-disabled.cy.js
new file mode 100644
index 00000000000..ea0c75933da
--- /dev/null
+++ b/test/e2e-cypress/e2e/features/resolve-subtree-on-expand-disabled.cy.js
@@ -0,0 +1,20 @@
+/**
+ * @prettier
+ */
+describe("resolveSubtreeOnExpand disabled", () => {
+ it("renders a schema model and its properties when expanded", () => {
+ cy.visit(
+ "/?url=/documents/features/models.swagger.yaml&resolveSubtreeOnExpand=false"
+ )
+ .get("#model-Pet .model-box .model-box-control")
+ .click()
+ .get("#model-Pet .model-box .model .inner-object")
+ .should("exist")
+
+ cy.get("#model-Pet").contains("tr.property-row td", "name").should("exist")
+ cy.get("#model-Pet")
+ .contains("tr.property-row td", "category")
+ .should("exist")
+ cy.get("#model-Pet").contains("Category").should("exist")
+ })
+})
diff --git a/test/unit/core/config/type-cast/index.js b/test/unit/core/config/type-cast/index.js
index c233b13fbb7..27e27c4d384 100644
--- a/test/unit/core/config/type-cast/index.js
+++ b/test/unit/core/config/type-cast/index.js
@@ -12,6 +12,7 @@ describe("typeCast", () => {
tryItOutEnabled: "false",
withCredentials: "true",
filter: "false",
+ resolveSubtreeOnExpand: "true",
}
const expectedConfig = {
@@ -19,6 +20,7 @@ describe("typeCast", () => {
tryItOutEnabled: false,
withCredentials: true,
filter: false,
+ resolveSubtreeOnExpand: true,
}
expect(typeCast(config)).toStrictEqual(expectedConfig)
@@ -87,6 +89,7 @@ describe("typeCast", () => {
maxDisplayedTags: "null",
defaultModelExpandDepth: {},
defaultModelsExpandDepth: false,
+ resolveSubtreeOnExpand: "invalid",
}
const expectedConfig = {
@@ -97,6 +100,7 @@ describe("typeCast", () => {
maxDisplayedTags: -1,
defaultModelExpandDepth: 1,
defaultModelsExpandDepth: 1,
+ resolveSubtreeOnExpand: true,
}
expect(typeCast(config)).toStrictEqual(expectedConfig)
diff --git a/test/unit/core/plugins/json-schema-5/components/model.jsx b/test/unit/core/plugins/json-schema-5/components/model.jsx
new file mode 100644
index 00000000000..b5985c330a5
--- /dev/null
+++ b/test/unit/core/plugins/json-schema-5/components/model.jsx
@@ -0,0 +1,38 @@
+import React from "react"
+import { shallow } from "enzyme"
+import { fromJS } from "immutable"
+import Model from "core/plugins/json-schema-5/components/model"
+
+describe("", function() {
+ const ObjectModel = () => null
+ const ArrayModel = () => null
+ const PrimitiveModel = () => null
+
+ const getComponent = (componentName) => {
+ return {
+ ObjectModel,
+ ArrayModel,
+ PrimitiveModel,
+ }[componentName]
+ }
+
+ const props = {
+ getComponent,
+ getConfigs: () => ({}),
+ specSelectors: {
+ isOAS3: () => true,
+ findDefinition: () => fromJS({ type: "object" }),
+ },
+ specPath: fromJS([]),
+ }
+
+ it("derives model name from unresolved $ref", function() {
+ const wrapper = shallow(
+
+ )
+
+ const renderedObjectModel = wrapper.find(ObjectModel)
+ expect(renderedObjectModel.length).toEqual(1)
+ expect(renderedObjectModel.first().prop("name")).toEqual("Links")
+ })
+})
diff --git a/test/unit/core/plugins/json-schema-5/components/models.jsx b/test/unit/core/plugins/json-schema-5/components/models.jsx
index 3203f486376..6ff0fe4ed85 100644
--- a/test/unit/core/plugins/json-schema-5/components/models.jsx
+++ b/test/unit/core/plugins/json-schema-5/components/models.jsx
@@ -17,6 +17,9 @@ describe("", function(){
getComponent: (c) => {
return components[c]
},
+ specActions: {
+ requestResolvedSubtree: jest.fn()
+ },
specSelectors: {
isOAS3: () => false,
specJson: () => Map(),
@@ -31,10 +34,14 @@ describe("", function(){
layoutSelectors: {
isShown: jest.fn()
},
- layoutActions: {},
+ layoutActions: {
+ show: jest.fn(),
+ readyToScroll: jest.fn()
+ },
getConfigs: () => ({
docExpansion: "list",
- defaultModelsExpandDepth: 0
+ defaultModelsExpandDepth: 0,
+ resolveSubtreeOnExpand: false
})
}
@@ -51,4 +58,51 @@ describe("", function(){
})
})
+ it("does not resolve model subtree on expand when disabled", function() {
+ const localProps = {
+ ...props,
+ specActions: {
+ requestResolvedSubtree: jest.fn()
+ },
+ layoutActions: {
+ show: jest.fn(),
+ readyToScroll: jest.fn()
+ },
+ getConfigs: () => ({
+ docExpansion: "list",
+ defaultModelsExpandDepth: 0,
+ resolveSubtreeOnExpand: false
+ })
+ }
+
+ const wrapper = shallow()
+ wrapper.instance().handleToggle("def1", true)
+
+ expect(localProps.layoutActions.show).toHaveBeenCalledWith(["definitions", "def1"], true)
+ expect(localProps.specActions.requestResolvedSubtree).not.toHaveBeenCalled()
+ })
+
+ it("resolves model subtree on expand when enabled", function() {
+ const localProps = {
+ ...props,
+ specActions: {
+ requestResolvedSubtree: jest.fn()
+ },
+ layoutActions: {
+ show: jest.fn(),
+ readyToScroll: jest.fn()
+ },
+ getConfigs: () => ({
+ docExpansion: "list",
+ defaultModelsExpandDepth: 0,
+ resolveSubtreeOnExpand: true
+ })
+ }
+
+ const wrapper = shallow()
+ wrapper.instance().handleToggle("def1", true)
+
+ expect(localProps.specActions.requestResolvedSubtree).toHaveBeenCalledWith(["definitions", "def1"])
+ })
+
})
diff --git a/test/unit/core/plugins/json-schema-5/components/object-model.jsx b/test/unit/core/plugins/json-schema-5/components/object-model.jsx
index 9f4c5f72382..941a79bf69c 100644
--- a/test/unit/core/plugins/json-schema-5/components/object-model.jsx
+++ b/test/unit/core/plugins/json-schema-5/components/object-model.jsx
@@ -61,6 +61,25 @@ describe("", function() {
...props,
schema: props.schema.set("minProperties", 1).set("maxProperties", 5)
}
+ const propsOneOfRefs = {
+ ...props,
+ schema: Immutable.fromJS({
+ oneOf: [
+ {
+ allOf: [
+ {
+ $ref: "#/components/schemas/Application"
+ }
+ ]
+ }
+ ]
+ }),
+ specSelectors: {
+ isOAS3(){
+ return true
+ }
+ }
+ }
it("renders a collapsible header", function(){
const wrapper = shallow()
@@ -106,4 +125,15 @@ describe("", function() {
expect(renderProperties.get(1).props.propKey).toEqual("maxProperties")
expect(renderProperties.get(1).props.propVal).toEqual(5)
})
+
+ it("infers display names for composed refs in oneOf entries", function() {
+ const wrapper = shallow()
+ const oneOfModel = wrapper.find(Model).findWhere((node) => {
+ const specPath = node.prop("specPath")
+ return specPath && specPath.equals(List(["oneOf", 0]))
+ })
+
+ expect(oneOfModel.length).toEqual(1)
+ expect(oneOfModel.first().prop("displayName")).toEqual("Application")
+ })
})
|