fix: adding mnissing server description

Signed-off-by: Pawel Psztyc <[email protected]>

Author: jarrodek

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-components/amf-helper-mixin",
   "description": "A mixin with common functions user by most AMF components to compute AMF values",
-  "version": "4.5.13",
+  "version": "4.5.14",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",

package.json

@@ -292,7 +292,8 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
    * @returns {ApiServer} Serialized Server
    */
   server(object) {
-    const url = this._getValue(object, this.ns.aml.vocabularies.core.urlTemplate) || '';
+    const { ns } = this;
+    const url = this._getValue(object, ns.aml.vocabularies.core.urlTemplate) || '';
     const result = /** @type ApiServer */ ({
       id: object['@id'],
       types: object['@type'].map(this[expandKey].bind(this)),
@@ -301,19 +302,23 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
       customDomainProperties: this.customDomainProperties(object),
       sourceMaps: this.sourceMap(object),
     });
-    const variables = /** @type Parameter[] */ (object[this._getAmfKey(this.ns.aml.vocabularies.apiContract.variable)]);
+    const description = this._getValue(object, ns.aml.vocabularies.core.description);
+    if (description && typeof description === 'string') {
+      result.description = description;
+    }
+    const variables = /** @type Parameter[] */ (object[this._getAmfKey(ns.aml.vocabularies.apiContract.variable)]);
     if (Array.isArray(variables) && variables.length) {
       result.variables = variables.map((p) => this.parameter(p));
     }
-    const protocol = /** @type string */ (this._getValue(object, this.ns.aml.vocabularies.apiContract.protocol));
-    const protocolVersion = /** @type string */ (this._getValue(object, this.ns.aml.vocabularies.apiContract.protocolVersion));
+    const protocol = /** @type string */ (this._getValue(object, ns.aml.vocabularies.apiContract.protocol));
+    const protocolVersion = /** @type string */ (this._getValue(object, ns.aml.vocabularies.apiContract.protocolVersion));
     if (protocol) {
       result.protocol = protocol;
     }
     if (protocolVersion) {
       result.protocolVersion = protocolVersion;
     }
-    const security = /** @type SecurityRequirement */ (object[this._getAmfKey(this.ns.aml.vocabularies.security.security)]);
+    const security = /** @type SecurityRequirement */ (object[this._getAmfKey(ns.aml.vocabularies.security.security)]);
     if (Array.isArray(security) && security.length) {
       result.security = security.map((p) => this.securityRequirement(p));
     }

src/AmfSerializer.js

@@ -46,6 +46,11 @@ describe('AmfSerializer', () => {
             assert.typeOf(v1, 'object', 'the variable is an object');
             assert.include(v1.types, serializer.ns.aml.vocabularies.apiContract.Parameter, 'has the Parameter type');
           });
+
+          it('has the description', () => {
+            const result = serializer.server(servers[1]);
+            assert.equal(result.description, 'Staging server');
+          });
         });
 
         describe('Async API', () => {