Skip to content

fix(json-schema-2020-12): render property schema title #11062

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshuablac wants to merge 1 commit into
base: main
Choose a base branch
from
+48 −1
Open

fix(json-schema-2020-12): render property schema title #11062

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 16 additions & 1 deletion src/core/plugins/json-schema-2020-12/components/keywords/Title/Title.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,26 @@ import { useFn } from "../../../hooks"

const Title = ({ title = "", schema }) => {
const fn = useFn()
const schemaTitle = fn.getTitle(schema, { lookup: "basic" })
const renderedTitle = title || fn.getTitle(schema)
const hasSecondaryTitle =
typeof title === "string" &&
title !== "" &&
schemaTitle !== "" &&
!title.toLowerCase().includes(schemaTitle.toLowerCase())

if (!renderedTitle) return null

return <strong className="json-schema-2020-12__title">{renderedTitle}</strong>
return (
<strong className="json-schema-2020-12__title">
{renderedTitle}
{hasSecondaryTitle && (
<span className="json-schema-2020-12__title-secondary">
{schemaTitle}
</span>
)}
</strong>
)
}

Title.propTypes = {
Expand Down
6 changes: 6 additions & 0 deletions src/core/plugins/json-schema-2020-12/components/keywords/Title/_title.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
& .json-schema-2020-12-keyword__name {
margin: 0;
}

&-secondary {
margin-left: 10px;
font-weight: normal;
font-style: italic;
}
}

&-property {
Expand Down
20 changes: 20 additions & 0 deletions test/e2e-cypress/e2e/features/plugins/json-schema-2020-12/schema-title.cy.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,24 @@ describe("JSON Schema 2020-12 title keyword", () => {
.contains("Error")
.should("exist")
})

it("should render a title for schema properties", () => {
cy.visit(
"/?url=/documents/features/json-schema-2020-12-title.yaml&defaultModelsExpandDepth=2"
)
.get(".json-schema-2020-12-property")
.contains(".json-schema-2020-12__title", "nickname")
.contains("Pet nickname")
.should("exist")
})

it("should not repeat a property title that matches the property name", () => {
cy.visit(
"/?url=/documents/features/json-schema-2020-12-title.yaml&defaultModelsExpandDepth=2"
)
.get(".json-schema-2020-12-property")
.contains(".json-schema-2020-12__title", "color")
.find(".json-schema-2020-12__title-secondary")
.should("not.exist")
})
})
6 changes: 6 additions & 0 deletions test/e2e-cypress/static/documents/features/json-schema-2020-12-title.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,12 @@ components:
type: string
tag:
type: string
nickname:
type: string
title: Pet nickname
color:
type: string
title: color
Pets:
title: My Pets
type: array
Expand Down