v6.3.3 (#662)

* chore(models): add APIC-553.raml

* feat(deps): regenerate package-lock.json

* test: add test cases for major fixes

* 6.3.3

* test: fix test after model change

Author: twoplustwoone

demo/apis.json

@@ -13,5 +13,7 @@
   "models/apic-83/apic-83.raml": "RAML 1.0",
   "models/multi-server/multi-server.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },
   "models/oas-3-api/oas-3-api.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },
-  "models/async-api/async-api.yaml": "ASYNC 2.0"
+  "models/async-api/async-api.yaml": "ASYNC 2.0",
+  "models/APIC-553/APIC-553.raml": "RAML 1.0",
+  "models/APIC-554/APIC-554.raml": "RAML 1.0"
 }

demo/element/app.js

@@ -22,6 +22,7 @@ class ApicApplication extends DemoBase {
       ['multi-server', 'Multi Server API'],
       ['oas-3-api', 'OAS 3 API'],
       ['async-api', 'AsyncAPI'],
+      ['APIC-553', 'APIC-553'],
     ];
 
     this.toggleConsoleMenu = this.toggleConsoleMenu.bind(this);

demo/models/APIC-553/APIC-553.raml

@@ -0,0 +1,57 @@
+#%RAML 1.0
+baseUri: http://domain.org 
+
+title: Array does not work API
+version: 1.0
+mediaType:  application/json
+
+types:
+  ORX_ARRAY:
+    type: array
+    items: string
+    minItems: 1
+  ORX_STR_WITH_EXAMPLE:
+    type: string
+    example: foo
+
+
+
+/cmt:
+  get:
+    queryParameters:
+      orx:
+        description: List ORX type.
+        type: ORX_ARRAY
+        required: true
+      details:
+        displayName: details
+        type: string
+        required: false
+      modemCount:
+        displayName: modemCount
+        type: string
+        required: false
+    responses:
+      200:
+        body:
+          application/json:
+/cmt-with-qp-example:
+  get:
+    queryParameters:
+      orx:
+        description: ORX type.
+        type: string
+        required: true
+        example: foo
+      details:
+        displayName: details
+        type: string
+        required: false
+      modemCount:
+        displayName: modemCount
+        type: string
+        required: false
+    responses:
+      200:
+        body:
+          application/json:

demo/models/APIC-554/APIC-554.raml

@@ -0,0 +1,6 @@
+#%RAML 1.0
+title: api
+
+/customer/{customerId}/chromeos:
+/customer/{customerId}/chromeos/deviceId:
+/customer/{customerId}/chromeos/deviceId/customerId:

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "api-console",
   "description": "The API Console to automatically generate API documentation from RAML and OAS files.",
-  "version": "6.3.2",
+  "version": "6.3.3",
   "license": "CPAL-1.0",
   "main": "index.js",
   "module": "index.js",

package.json

@@ -27,6 +27,13 @@ describe('<api-console>', function() {
     return element;
   }
 
+  function selectOperation(element, endpointName, operationName) {
+    const operation = AmfLoader.lookupOperation(element.amf, endpointName, operationName);
+    const operationId = operation['@id'];
+    element.selectedShape = operationId;
+    element.selectedShapeType = 'method';
+  }
+
   describe('AMF model computations', () => {
     [
       new ApiDescribe('Regular model'),
@@ -206,4 +213,61 @@ describe('<api-console>', function() {
       });
     });
   });
+
+  describe('APIC-553', () => {
+    [
+      new ApiDescribe('Regular model'),
+      new ApiDescribe('Compact model', true),
+    ].forEach(({ label, compact }) => {
+      describe(label, () => {
+        let amf;
+        let element;
+
+        before(async () => {
+          amf = await AmfLoader.load({ compact, fileName: 'APIC-553' });
+        });
+
+        beforeEach(async () => {
+          element = await amfFixture(amf);
+          await aTimeout(0);
+        });
+
+        it('should have URL set', async () => {
+          selectOperation(element, '/cmt', 'get');
+          await nextFrame();
+          await nextFrame();
+          const apiDocumentation = element.shadowRoot.querySelector('api-documentation');
+          const apiMethodDocumentation = apiDocumentation.shadowRoot.querySelector('api-method-documentation');
+          assert.equal(apiMethodDocumentation.shadowRoot.querySelector('api-url').url, 'http://domain.org/cmt');
+        });
+      });
+    });
+  });
+
+  describe('APIC-554', () => {
+    [
+      new ApiDescribe('Regular model'),
+      new ApiDescribe('Compact model', true),
+    ].forEach(({ label, compact }) => {
+      describe(label, () => {
+        let amf;
+        let element;
+
+        before(async () => {
+          amf = await AmfLoader.load({ compact, fileName: 'APIC-554' });
+        });
+
+        beforeEach(async () => {
+          element = await amfFixture(amf);
+          await aTimeout(0);
+        });
+
+        it('should set correct navigation labels', async () => {
+          const apiNavigation = element.shadowRoot.querySelector('api-navigation');
+          const labels = ['/customer/{customerId}/chromeos', '/deviceId', '/customerId'];
+          assert.deepEqual(apiNavigation._endpoints.map(e => e.label), labels);
+        });
+      });
+    });
+  });
 });