Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion packages/elements-core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@stoplight/elements-core",
"version": "9.0.6",
"version": "9.0.7",
"sideEffects": [
"web-components.min.js",
"src/web-components/**",
Expand Down
15 changes: 15 additions & 0 deletions packages/elements-core/src/components/Docs/Model/Model.spec.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,21 @@ describe('Model', () => {
expect(textboxDescription).toHaveTextContent('example schema description');
});

it('displays child description at top of doc for allOf-inheriting objects', async () => {
const desc = 'child schema description';
// allOf-inheriting properties from parent but having its own description
const allOfSchema: JSONSchema7 = {
allOf: [exampleSchema],
description: desc,
};
render(<Model data={allOfSchema} />);
const description = screen.queryAllByText(desc);
const textboxDescription = screen.getByRole('textbox');

expect(description).toHaveLength(1);
expect(textboxDescription).toHaveTextContent(desc);
});

it('does not display description at top of doc for non-objects', async () => {
render(<Model data={exampleStringSchema} />);
const description = screen.queryByRole('textbox');
Expand Down
13 changes: 7 additions & 6 deletions packages/elements-core/src/components/Docs/Model/Model.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,13 @@ const ModelComponent: React.FC<ModelProps> = ({

const description = (
<VStack spacing={10}>
{data.description && data.type === 'object' && (
<Box pos="relative">
<MarkdownViewer role="textbox" markdown={data.description} />
<NodeAnnotation change={descriptionChanged} />
</Box>
)}
{data.description &&
(data.type === 'object' || (data.allOf || []).some(s => (s as JSONSchema7).type === 'object')) && (
<Box pos="relative">
<MarkdownViewer role="textbox" markdown={data.description} />
<NodeAnnotation change={descriptionChanged} />
</Box>
)}

<NodeVendorExtensions data={data} />

Expand Down
4 changes: 2 additions & 2 deletions packages/elements-dev-portal/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@stoplight/elements-dev-portal",
"version": "3.0.6",
"version": "3.0.7",
"description": "UI components for composing beautiful developer documentation.",
"keywords": [],
"sideEffects": [
Expand Down Expand Up @@ -66,7 +66,7 @@
"dependencies": {
"@stoplight/markdown-viewer": "^5.7.1",
"@stoplight/mosaic": "^1.53.4",
"@stoplight/elements-core": "~9.0.6",
"@stoplight/elements-core": "~9.0.7",
"@stoplight/path": "^1.3.2",
"@stoplight/types": "^14.0.0",
"classnames": "^2.2.6",
Expand Down
6 changes: 3 additions & 3 deletions packages/elements/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@stoplight/elements",
"version": "9.0.6",
"version": "9.0.7",
"description": "UI components for composing beautiful developer documentation.",
"keywords": [],
"sideEffects": [
Expand Down Expand Up @@ -63,7 +63,7 @@
]
},
"dependencies": {
"@stoplight/elements-core": "~9.0.4",
"@stoplight/elements-core": "~9.0.7",
"@stoplight/http-spec": "^7.1.0",
"@stoplight/json": "^3.18.1",
"@stoplight/mosaic": "^1.53.4",
Expand Down Expand Up @@ -109,4 +109,4 @@
"release": {
"extends": "@stoplight/scripts/release"
}
}
}