feat: adding endpoint's extensions

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

Author: jarrodek

apis/arc-demo-api/arc-demo-api.raml

@@ -105,6 +105,7 @@ resourceTypes:
 traits:
   Paginated: !include traits/pagination.raml
   Adminable: !include traits/adminable.raml
+  RateLimited: !include traits/rate-limited.raml
 securitySchemes:
   oauth_2_0: !include securitySchemes/oauth_2_0.raml
   x-custom: !include securitySchemes/x-custom.raml
@@ -162,6 +163,8 @@ securedBy: [basic]
       description: To test enum values in the URI parameters for global type declaration.
 /people:
   displayName: People
+  type: RequestErrorResponse
+  is: [RateLimited]
   get:
     (annotationTest):
     displayName: List people
@@ -284,6 +287,7 @@ securedBy: [basic]
 /products:
   displayName: Products
   description: The API is to be used to access data about the products.
+  type: RequestErrorResponse
   post:
     displayName: Create product
     description: |
@@ -328,6 +332,7 @@ securedBy: [basic]
         description: The request has been rejected. Probably the product already exists in the datastore.
 /orgs:
   /{orgId}:
+    is: [RateLimited]
     get:
       displayName: Get organization
       description: Returns an organization info.

apis/arc-demo-api/traits/rate-limited.raml

@@ -0,0 +1,9 @@
+#%RAML 1.0 Trait
+
+displayName: RateLimited
+usage: TO be used when the API has a rate limit on the API gateway.
+headers:
+  x-rate-client-id:
+    description: he client ID to use for the rate limit.
+    example: 5757gh76
+    required: true

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.14",
+  "version": "4.5.15",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",
@@ -38,7 +38,7 @@
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
     "husky": "^7.0.2",
-    "lint-staged": "^11.1.2",
+    "lint-staged": "^11.2.0",
     "lit-element": "^2.5.1",
     "lit-html": "^1.4.1",
     "sinon": "^11.1.2",

package.json

@@ -49,7 +49,9 @@ import { AmfHelperMixin, expandKey, findAmfType, getArrayItems } from "./AmfHelp
 /** @typedef {import('./types').ApiDataNodeUnion} ApiDataNodeUnion */
 /** @typedef {import('./types').ApiDocumentSourceMaps} ApiDocumentSourceMaps */
 /** @typedef {import('./types').ApiSynthesizedField} ApiSynthesizedField */
+/** @typedef {import('./types').ApiParametrizedDeclaration} ApiParametrizedDeclaration */
 /** @typedef {import('./types').ApiParametrizedTrait} ApiParametrizedTrait */
+/** @typedef {import('./types').ApiParametrizedResourceType} ApiParametrizedResourceType */
 /** @typedef {import('./types').ApiVariableValue} ApiVariableValue */
 /** @typedef {import('./types').ApiAbstractDeclaration} ApiAbstractDeclaration */
 /** @typedef {import('./types').ShapeProcessingOptions} ShapeProcessingOptions */
@@ -106,7 +108,9 @@ import { AmfHelperMixin, expandKey, findAmfType, getArrayItems } from "./AmfHelp
 /** @typedef {import('./amf').Tag} Tag */
 /** @typedef {import('./amf').DocumentSourceMaps} DocumentSourceMaps */
 /** @typedef {import('./amf').SynthesizedField} SynthesizedField */
+/** @typedef {import('./amf').ParametrizedDeclaration} ParametrizedDeclaration */
 /** @typedef {import('./amf').ParametrizedTrait} ParametrizedTrait */
+/** @typedef {import('./amf').ParametrizedResourceType} ParametrizedResourceType */
 /** @typedef {import('./amf').VariableValue} VariableValue */
 /** @typedef {import('./amf').AbstractDeclaration} AbstractDeclaration */
 /** @typedef {import('./amf').Organization} Organization */
@@ -1303,6 +1307,7 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
       payloads: [],
       servers: [],
       security: [],
+      extends: [],
     });
     const { ns } = this;
     const path = this._getValue(object, ns.aml.vocabularies.apiContract.path);
@@ -1341,6 +1346,21 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
     if (Array.isArray(security) && security.length) {
       result.security = security.map(i => this.securityRequirement(i));
     }
+    const extensions = this[getArrayItems](object, ns.aml.vocabularies.document.extends);
+    if (Array.isArray(extensions) && extensions.length) {
+      result.extends = [];
+      extensions.forEach((ex) => {
+        let extension = ex;
+        if (Array.isArray(extension)) {
+          [extension] = extension;
+        }
+        if (this._hasType(extension, ns.aml.vocabularies.apiContract.ParametrizedResourceType)) {
+          result.extends.push(this.parametrizedResourceType(extension));
+        } else if (this._hasType(extension, ns.aml.vocabularies.apiContract.ParametrizedTrait)) {
+          result.extends.push(this.parametrizedTrait(extension));
+        }
+      });
+    }
     return result;
   }
 
@@ -1364,7 +1384,7 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
       schemes: [],
       contentType: [],
       tags: [],
-      traits: [],
+      extends: [],
     });
     const { ns } = this;
     const method = this._getValue(object, ns.aml.vocabularies.apiContract.method);
@@ -1440,7 +1460,7 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
     }
     const traits = object[this._getAmfKey(ns.aml.vocabularies.document.extends)];
     if (Array.isArray(traits) && traits.length) {
-      result.traits = traits.map(t => this.parametrizedTrait(t));
+      result.extends = traits.map(t => this.parametrizedTrait(t));
     }
     return result;
   }
@@ -2102,11 +2122,11 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
   }
 
   /**
-   * @param {ParametrizedTrait} object 
-   * @returns {ApiParametrizedTrait}
+   * @param {ParametrizedDeclaration} object 
+   * @returns {ApiParametrizedDeclaration}
    */
-  parametrizedTrait(object) {
-    const result = /** @type ApiParametrizedTrait */ ({
+  parametrizedDeclaration(object) {
+    const result = /** @type ApiParametrizedDeclaration */ ({
       id: object['@id'],
       types: object['@type'].map(this[expandKey].bind(this)),
       variables: [],
@@ -2132,6 +2152,24 @@ export class AmfSerializer extends AmfHelperMixin(Object) {
     return result;
   }
 
+  /**
+   * @param {ParametrizedTrait} object 
+   * @returns {ApiParametrizedTrait}
+   */
+  parametrizedTrait(object) {
+    const result = /** @type ApiParametrizedTrait */ (this.parametrizedDeclaration(object));
+    return result;
+  }
+
+  /**
+   * @param {ParametrizedResourceType} object 
+   * @returns {ApiParametrizedResourceType}
+   */
+  parametrizedResourceType(object) {
+    const result = /** @type ApiParametrizedResourceType */ (this.parametrizedDeclaration(object));
+    return result;
+  }
+
   /**
    * @param {VariableValue} object 
    * @returns {ApiVariableValue}

src/AmfSerializer.js

@@ -108,6 +108,7 @@ export declare interface EndPoint extends DomainElement {
   'http://a.ml/vocabularies/apiContract#payload'?: Payload[];
   'http://a.ml/vocabularies/apiContract#server'?: Server[];
   'http://a.ml/vocabularies/security#security'?: SecurityRequirement[];
+  'http://a.ml/vocabularies/document#extends'?: ParametrizedDeclaration[];
 }
 
 export declare interface Operation extends DomainElement {
@@ -438,3 +439,4 @@ export interface AbstractDeclaration extends DomainElement {
 }
 
 export interface ParametrizedTrait extends ParametrizedDeclaration {}
+export interface ParametrizedResourceType extends ParametrizedDeclaration {}

src/amf.d.ts

@@ -113,6 +113,7 @@ export interface ApiEndPoint extends ApiDomainProperty {
   servers: ApiServer[];
   security: ApiSecurityRequirement[];
   sourceMaps?: ApiDocumentSourceMaps;
+  extends: ApiParametrizedDeclaration[];
 }
 
 export interface ApiOperation extends ApiDomainProperty {
@@ -133,7 +134,7 @@ export interface ApiOperation extends ApiDomainProperty {
   servers: ApiServer[];
   tags: ApiTag[];
   sourceMaps?: ApiDocumentSourceMaps;
-  traits: ApiParametrizedTrait[];
+  extends: ApiParametrizedTrait[];
 }
 
 export interface ApiTag extends ApiDomainProperty {
@@ -521,8 +522,8 @@ export interface ApiAbstractDeclaration extends ApiDomainProperty {
   variables: string[];
 }
 
-export interface ApiParametrizedTrait extends ApiParametrizedDeclaration {
-}
+export interface ApiParametrizedTrait extends ApiParametrizedDeclaration {}
+export interface ApiParametrizedResourceType extends ApiParametrizedDeclaration {}
 
 export interface ShapeProcessingOptions {
   /**