Fix description for allOf-inheriting child schemas

Fixes #2810

Author: marcelstoer

packages/elements-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/elements-core",
-  "version": "9.0.6",
+  "version": "9.0.7",
   "sideEffects": [
     "web-components.min.js",
     "src/web-components/**",

packages/elements-core/src/components/Docs/Model/Model.spec.tsx

@@ -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');

packages/elements-core/src/components/Docs/Model/Model.tsx

@@ -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} />
 

packages/elements-dev-portal/package.json

@@ -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": [
@@ -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",

packages/elements/package.json

@@ -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": [
@@ -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",
@@ -109,4 +109,4 @@
   "release": {
     "extends": "@stoplight/scripts/release"
   }
-}
+}