Merge pull request #31 from advanced-rest-client/fix/duplicated-examples

Fix/duplicated examples

Author: carowright

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-components/api-type-document",
   "description": "A documentation table for type (resource) properties. Works with AMF data model",
-  "version": "4.2.14",
+  "version": "4.2.15",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",

package.json

@@ -180,7 +180,7 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
 
   connectedCallback(): void;
 
-  _computeRenderMainExample(noMainExample: boolean, hasExamples: boolean): boolean;
+  _computeRenderMainExample(noMainExample: boolean, hasExamples: boolean, isScalar: boolean): boolean;
 
   /**
    * Called when resolved type or amf changed.

src/ApiTypeDocument.d.ts

@@ -289,9 +289,11 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     }
     this.__hasExamples = value;
     this.requestUpdate('_hasExamples', old);
+    const scalarType = this._hasType(this.type, this.ns.aml.vocabularies.shapes.ScalarShape);
     this._renderMainExample = this._computeRenderMainExample(
       this.noMainExample,
-      value
+      value,
+      scalarType
     );
   }
 
@@ -337,8 +339,8 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     }
   }
 
-  _computeRenderMainExample(noMainExample, hasExamples) {
-    return !!(!noMainExample && hasExamples);
+  _computeRenderMainExample(noMainExample, hasExamples, isScalar = false) {
+    return isScalar ? false : !!(!noMainExample && hasExamples);
   }
 
   /**

src/ApiTypeDocument.js

@@ -117,6 +117,11 @@ describe('<api-type-document>', () => {
         const result = element._computeRenderMainExample(true, true);
         assert.isFalse(result);
       });
+
+      it('Returns false when type is scalar', () => {
+        const result = element._computeRenderMainExample(true, true, true);
+        assert.isFalse(result);
+      });
     });
   });
 
@@ -564,6 +569,13 @@ describe('<api-type-document>', () => {
           );
           assert.notOk(doc);
         });
+
+        it('Does not render main example', () => {
+          const examples = element.shadowRoot.querySelector(
+            'examples'
+          );
+          assert.notOk(examples);
+        });
       });
 
       describe('Nil type', () => {