@loopback/openapi-v3 1.10.2 → 1.13.0

package/dist/decorators/request-body.decorator.js

@@ -3,9 +3,12 @@
 // Node module: @loopback/openapi-v3
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const context_1 = require("@loopback/context");
-const _ = require("lodash");
+const core_1 = require("@loopback/core");
+const lodash_1 = __importDefault(require("lodash"));
 const util_1 = require("util");
 const generate_schema_1 = require("../generate-schema");
 const keys_1 = require("../keys");
@@ -77,24 +80,25 @@ exports.REQUEST_BODY_INDEX = 'x-parameter-index';
  */
 function requestBody(requestBodySpec) {
     return function (target, member, index) {
+        var _a;
         debug('@requestBody() on %s.%s', target.constructor.name, member);
         debug('  parameter index: %s', index);
         /* istanbul ignore if */
         if (debug.enabled)
             debug('  options: %s', util_1.inspect(requestBodySpec, { depth: null }));
         // Use 'application/json' as default content if `requestBody` is undefined
-        requestBodySpec = requestBodySpec || { content: {} };
-        if (_.isEmpty(requestBodySpec.content))
+        requestBodySpec = (requestBodySpec !== null && requestBodySpec !== void 0 ? requestBodySpec : { content: {} });
+        if (lodash_1.default.isEmpty(requestBodySpec.content))
             requestBodySpec.content = { 'application/json': {} };
         // Get the design time method parameter metadata
-        const methodSig = context_1.MetadataInspector.getDesignTypeForMethod(target, member);
-        const paramTypes = (methodSig && methodSig.parameterTypes) || [];
+        const methodSig = core_1.MetadataInspector.getDesignTypeForMethod(target, member);
+        const paramTypes = ((_a = methodSig) === null || _a === void 0 ? void 0 : _a.parameterTypes) || [];
         const paramType = paramTypes[index];
         const schema = generate_schema_1.resolveSchema(paramType);
         /* istanbul ignore if */
         if (debug.enabled)
             debug('  inferred schema: %s', util_1.inspect(schema, { depth: null }));
-        requestBodySpec.content = _.mapValues(requestBodySpec.content, c => {
+        requestBodySpec.content = lodash_1.default.mapValues(requestBodySpec.content, c => {
             if (!c.schema) {
                 c.schema = schema;
             }
@@ -108,7 +112,7 @@ function requestBody(requestBodySpec) {
         /* istanbul ignore if */
         if (debug.enabled)
             debug('  final spec: ', util_1.inspect(requestBodySpec, { depth: null }));
-        context_1.ParameterDecoratorFactory.createDecorator(keys_1.OAI3Keys.REQUEST_BODY_KEY, requestBodySpec, { decoratorName: '@requestBody' })(target, member, index);
+        core_1.ParameterDecoratorFactory.createDecorator(keys_1.OAI3Keys.REQUEST_BODY_KEY, requestBodySpec, { decoratorName: '@requestBody' })(target, member, index);
     };
 }
 exports.requestBody = requestBody;

package/dist/decorators/request-body.decorator.js.map

@@ -1 +1 @@
-{"version":3,"file":"request-body.decorator.js","sourceRoot":"","sources":["../../src/decorators/request-body.decorator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAEhE,+CAA+E;AAC/E,4BAA4B;AAC5B,+BAA6B;AAC7B,wDAAiD;AACjD,kCAAiC;AAGjC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,wCAAwC,CAAC,CAAC;AAC5D,QAAA,kBAAkB,GAAG,mBAAmB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,SAAgB,WAAW,CAAC,eAA4C;IACtE,OAAO,UAAS,MAAc,EAAE,MAAc,EAAE,KAAa;QAC3D,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClE,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;QACtC,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO;YACf,KAAK,CAAC,eAAe,EAAE,cAAO,CAAC,eAAe,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QAElE,0EAA0E;QAC1E,eAAe,GAAG,eAAe,IAAI,EAAC,OAAO,EAAE,EAAE,EAAC,CAAC;QAEnD,IAAI,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC;YACpC,eAAe,CAAC,OAAO,GAAG,EAAC,kBAAkB,EAAE,EAAE,EAAC,CAAC;QAErD,gDAAgD;QAChD,MAAM,SAAS,GAAG,2BAAiB,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3E,MAAM,UAAU,GAAG,CAAC,SAAS,IAAI,SAAS,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;QAEjE,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,+BAAa,CAAC,SAAS,CAAC,CAAC;QACxC,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO;YACf,KAAK,CAAC,uBAAuB,EAAE,cAAO,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QACjE,eAAe,CAAC,OAAO,GAAG,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;YACjE,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE;gBACb,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;aACnB;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,oEAAoE;QACpE,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,eAAe,CAAC,0BAAkB,CAAC,GAAG,KAAK,CAAC;SAC7C;QAED,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO;YACf,KAAK,CAAC,gBAAgB,EAAE,cAAO,CAAC,eAAe,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QACnE,mCAAyB,CAAC,eAAe,CACvC,eAAQ,CAAC,gBAAgB,EACzB,eAAoC,EACpC,EAAC,aAAa,EAAE,cAAc,EAAC,CAChC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC;AACJ,CAAC;AA7CD,kCA6CC;AAED,WAAiB,WAAW;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;IACU,iBAAK,GAAG,UACnB,QAAwC,EACxC,UAAuD;QAEvD,OAAO,WAAW,iCACb,UAAU,KACb,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAC;iBACzC;aACF,IACD,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,EAjCgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiC3B"}
+{"version":3,"file":"request-body.decorator.js","sourceRoot":"","sources":["../../src/decorators/request-body.decorator.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;;AAEhE,yCAA4E;AAC5E,oDAAuB;AACvB,+BAA6B;AAC7B,wDAAiD;AACjD,kCAAiC;AAGjC,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,wCAAwC,CAAC,CAAC;AAC5D,QAAA,kBAAkB,GAAG,mBAAmB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,SAAgB,WAAW,CAAC,eAA4C;IACtE,OAAO,UAAS,MAAc,EAAE,MAAc,EAAE,KAAa;;QAC3D,KAAK,CAAC,yBAAyB,EAAE,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAClE,KAAK,CAAC,uBAAuB,EAAE,KAAK,CAAC,CAAC;QACtC,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO;YACf,KAAK,CAAC,eAAe,EAAE,cAAO,CAAC,eAAe,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QAElE,0EAA0E;QAC1E,eAAe,IAAG,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,EAAC,OAAO,EAAE,EAAE,EAAC,CAAA,CAAC;QAEnD,IAAI,gBAAC,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC;YACpC,eAAe,CAAC,OAAO,GAAG,EAAC,kBAAkB,EAAE,EAAE,EAAC,CAAC;QAErD,gDAAgD;QAChD,MAAM,SAAS,GAAG,wBAAiB,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC3E,MAAM,UAAU,GAAG,OAAA,SAAS,0CAAE,cAAc,KAAI,EAAE,CAAC;QAEnD,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;QACpC,MAAM,MAAM,GAAG,+BAAa,CAAC,SAAS,CAAC,CAAC;QACxC,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO;YACf,KAAK,CAAC,uBAAuB,EAAE,cAAO,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QACjE,eAAe,CAAC,OAAO,GAAG,gBAAC,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE;YACjE,IAAI,CAAC,CAAC,CAAC,MAAM,EAAE;gBACb,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC;aACnB;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,sDAAsD;QACtD,oEAAoE;QACpE,IAAI,KAAK,KAAK,CAAC,EAAE;YACf,eAAe,CAAC,0BAAkB,CAAC,GAAG,KAAK,CAAC;SAC7C;QAED,wBAAwB;QACxB,IAAI,KAAK,CAAC,OAAO;YACf,KAAK,CAAC,gBAAgB,EAAE,cAAO,CAAC,eAAe,EAAE,EAAC,KAAK,EAAE,IAAI,EAAC,CAAC,CAAC,CAAC;QACnE,gCAAyB,CAAC,eAAe,CACvC,eAAQ,CAAC,gBAAgB,EACzB,eAAoC,EACpC,EAAC,aAAa,EAAE,cAAc,EAAC,CAChC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC,CAAC;AACJ,CAAC;AA7CD,kCA6CC;AAED,WAAiB,WAAW;IAC1B;;;;;;;;;;;;;;;;;;OAkBG;IACU,iBAAK,GAAG,UACnB,QAAwC,EACxC,UAAuD;QAEvD,OAAO,WAAW,iCACb,UAAU,KACb,OAAO,EAAE;gBACP,kBAAkB,EAAE;oBAClB,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAC;iBACzC;aACF,IACD,CAAC;IACL,CAAC,CAAC;AACJ,CAAC,EAjCgB,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAiC3B"}

package/dist/decorators/tags.decorator.d.ts

@@ -0,0 +1 @@
+export declare function tags(...tagNames: string[]): (target: any, method?: string | undefined, methodDescriptor?: TypedPropertyDescriptor<any> | undefined) => any;

package/dist/decorators/tags.decorator.js

@@ -0,0 +1,33 @@
+"use strict";
+// Copyright IBM Corp. 2018. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@loopback/core");
+const keys_1 = require("../keys");
+function tags(...tagNames) {
+    return function tagsDecoratorForClassOrMethod(
+    // Class or a prototype
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    target, method, 
+    // Use `any` to for `TypedPropertyDescriptor`
+    // See https://github.com/strongloop/loopback-next/pull/2704
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    methodDescriptor) {
+        if (method && methodDescriptor) {
+            // Method
+            return core_1.MethodDecoratorFactory.createDecorator(keys_1.OAI3Keys.TAGS_METHOD_KEY, { tags: tagNames }, { decoratorName: '@oas.tags' })(target, method, methodDescriptor);
+        }
+        else if (typeof target === 'function' && !method && !methodDescriptor) {
+            // Class
+            return core_1.ClassDecoratorFactory.createDecorator(keys_1.OAI3Keys.TAGS_CLASS_KEY, { tags: tagNames }, { decoratorName: '@oas.tags' })(target);
+        }
+        else {
+            throw new Error('@oas.tags cannot be used on a property: ' +
+                core_1.DecoratorFactory.getTargetName(target, method, methodDescriptor));
+        }
+    };
+}
+exports.tags = tags;
+//# sourceMappingURL=tags.decorator.js.map

package/dist/decorators/tags.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.decorator.js","sourceRoot":"","sources":["../../src/decorators/tags.decorator.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAEhE,yCAIwB;AACxB,kCAAiC;AAGjC,SAAgB,IAAI,CAAC,GAAG,QAAkB;IACxC,OAAO,SAAS,6BAA6B;IAC3C,uBAAuB;IACvB,8DAA8D;IAC9D,MAAW,EACX,MAAe;IACf,6CAA6C;IAC7C,4DAA4D;IAC5D,8DAA8D;IAC9D,gBAA+C;QAE/C,IAAI,MAAM,IAAI,gBAAgB,EAAE;YAC9B,SAAS;YACT,OAAO,6BAAsB,CAAC,eAAe,CAC3C,eAAQ,CAAC,eAAe,EACxB,EAAC,IAAI,EAAE,QAAQ,EAAC,EAChB,EAAC,aAAa,EAAE,WAAW,EAAC,CAC7B,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAAC;SACrC;aAAM,IAAI,OAAO,MAAM,KAAK,UAAU,IAAI,CAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE;YACvE,QAAQ;YACR,OAAO,4BAAqB,CAAC,eAAe,CAC1C,eAAQ,CAAC,cAAc,EACvB,EAAC,IAAI,EAAE,QAAQ,EAAC,EAChB,EAAC,aAAa,EAAE,WAAW,EAAC,CAC7B,CAAC,MAAM,CAAC,CAAC;SACX;aAAM;YACL,MAAM,IAAI,KAAK,CACb,0CAA0C;gBACxC,uBAAgB,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,gBAAgB,CAAC,CACnE,CAAC;SACH;IACH,CAAC,CAAC;AACJ,CAAC;AAhCD,oBAgCC"}

package/dist/enhancers/index.d.ts

@@ -0,0 +1,3 @@
+export * from './keys';
+export * from './spec-enhancer.service';
+export * from './types';

package/dist/enhancers/index.js

@@ -0,0 +1,13 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+function __export(m) {
+    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./keys"));
+__export(require("./spec-enhancer.service"));
+__export(require("./types"));
+//# sourceMappingURL=index.js.map

package/dist/enhancers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/enhancers/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;;AAEhE,4BAAuB;AACvB,6CAAwC;AACxC,6BAAwB"}

package/dist/enhancers/keys.d.ts

@@ -0,0 +1,6 @@
+import { BindingKey } from '@loopback/core';
+import { OASEnhancerService } from './spec-enhancer.service';
+/**
+ * Strongly-typed binding key for SpecService
+ */
+export declare const OAS_ENHANCER_SERVICE: BindingKey<OASEnhancerService>;

package/dist/enhancers/keys.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@loopback/core");
+/**
+ * Strongly-typed binding key for SpecService
+ */
+exports.OAS_ENHANCER_SERVICE = core_1.BindingKey.create('services.SpecService');
+//# sourceMappingURL=keys.js.map

package/dist/enhancers/keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../../src/enhancers/keys.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAEhE,yCAA0C;AAG1C;;GAEG;AACU,QAAA,oBAAoB,GAAG,iBAAU,CAAC,MAAM,CACnD,sBAAsB,CACvB,CAAC"}

package/dist/enhancers/spec-enhancer.service.d.ts

@@ -0,0 +1,73 @@
+import { Getter } from '@loopback/core';
+import { OpenApiSpec } from '../types';
+import { OASEnhancer } from './types';
+/**
+ * Options for the OpenAPI Spec enhancer extension point
+ */
+export interface OASEnhancerServiceOptions {
+}
+/**
+ * An extension point for OpenAPI Spec enhancement
+ * This service is used for enhancing an OpenAPI spec by loading and applying one or more
+ * registered enhancers.
+ *
+ * A typical use of it would be generating the OpenAPI spec for the endpoints on a server
+ * in the `@loopback/rest` module.
+ */
+export declare class OASEnhancerService {
+    /**
+     * Inject a getter function to fetch spec enhancers
+     */
+    private getEnhancers;
+    /**
+     * An extension point should be able to receive its options via dependency
+     * injection.
+     */
+    readonly options?: OASEnhancerServiceOptions | undefined;
+    constructor(
+    /**
+     * Inject a getter function to fetch spec enhancers
+     */
+    getEnhancers: Getter<OASEnhancer[]>, 
+    /**
+     * An extension point should be able to receive its options via dependency
+     * injection.
+     */
+    options?: OASEnhancerServiceOptions | undefined);
+    private _spec;
+    /**
+     * Getter for `_spec`
+     */
+    get spec(): OpenApiSpec;
+    /**
+     * Setter for `_spec`
+     */
+    set spec(value: OpenApiSpec);
+    /**
+     * Find an enhancer by its name
+     * @param name The name of the enhancer you want to find
+     */
+    getEnhancerByName(name: string): Promise<OASEnhancer | undefined>;
+    /**
+     * Apply a given enhancer's merge function. Return the latest _spec.
+     * @param name The name of the enhancer you want to apply
+     */
+    applyEnhancerByName(name: string): Promise<OpenApiSpec>;
+    /**
+     * Generate OpenAPI spec by applying ALL registered enhancers
+     * TBD: load enhancers by group names
+     */
+    applyAllEnhancers(options?: {}): Promise<OpenApiSpec>;
+}
+/**
+ * The default merge function to patch the current OpenAPI spec.
+ * It leverages module `json-merge-patch`'s merge API to merge two json objects.
+ * It returns a new merged object without modifying the original one.
+ *
+ * A list of merging rules can be found in test file:
+ * https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js
+ *
+ * @param currentSpec The original spec
+ * @param patchSpec The patch spec to be merged into the original spec
+ */
+export declare function mergeOpenAPISpec(currentSpec: Partial<OpenApiSpec>, patchSpec: Partial<OpenApiSpec>): any;

package/dist/enhancers/spec-enhancer.service.js

@@ -0,0 +1,135 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@loopback/core");
+const debug_1 = __importDefault(require("debug"));
+const _ = __importStar(require("lodash"));
+const util_1 = require("util");
+const types_1 = require("./types");
+const jsonmergepatch = require('json-merge-patch');
+const debug = debug_1.default('loopback:openapi:spec-enhancer');
+/**
+ * An extension point for OpenAPI Spec enhancement
+ * This service is used for enhancing an OpenAPI spec by loading and applying one or more
+ * registered enhancers.
+ *
+ * A typical use of it would be generating the OpenAPI spec for the endpoints on a server
+ * in the `@loopback/rest` module.
+ */
+let OASEnhancerService = class OASEnhancerService {
+    constructor(
+    /**
+     * Inject a getter function to fetch spec enhancers
+     */
+    getEnhancers, 
+    /**
+     * An extension point should be able to receive its options via dependency
+     * injection.
+     */
+    options) {
+        this.getEnhancers = getEnhancers;
+        this.options = options;
+        this._spec = {
+            openapi: '3.0.0',
+            info: {
+                title: 'LoopBack Application',
+                version: '1.0.0',
+            },
+            paths: {},
+        };
+    }
+    /**
+     * Getter for `_spec`
+     */
+    get spec() {
+        return this._spec;
+    }
+    /**
+     * Setter for `_spec`
+     */
+    set spec(value) {
+        this._spec = value;
+    }
+    /**
+     * Find an enhancer by its name
+     * @param name The name of the enhancer you want to find
+     */
+    async getEnhancerByName(name) {
+        // Get the latest list of enhancers
+        const enhancers = await this.getEnhancers();
+        return enhancers.find(e => e.name === name);
+    }
+    /**
+     * Apply a given enhancer's merge function. Return the latest _spec.
+     * @param name The name of the enhancer you want to apply
+     */
+    async applyEnhancerByName(name) {
+        const enhancer = await this.getEnhancerByName(name);
+        if (enhancer)
+            this._spec = enhancer.modifySpec(this._spec);
+        return this._spec;
+    }
+    /**
+     * Generate OpenAPI spec by applying ALL registered enhancers
+     * TBD: load enhancers by group names
+     */
+    async applyAllEnhancers(options = {}) {
+        const enhancers = await this.getEnhancers();
+        if (_.isEmpty(enhancers))
+            return this._spec;
+        for (const e of enhancers) {
+            this._spec = e.modifySpec(this._spec);
+        }
+        debug(`Spec enhancer service, generated spec: ${util_1.inspect(this._spec)}`);
+        return this._spec;
+    }
+};
+OASEnhancerService = __decorate([
+    core_1.extensionPoint(types_1.OAS_ENHANCER_EXTENSION_POINT_NAME),
+    __param(0, core_1.extensions()),
+    __param(1, core_1.config()),
+    __metadata("design:paramtypes", [Function, Object])
+], OASEnhancerService);
+exports.OASEnhancerService = OASEnhancerService;
+/**
+ * The default merge function to patch the current OpenAPI spec.
+ * It leverages module `json-merge-patch`'s merge API to merge two json objects.
+ * It returns a new merged object without modifying the original one.
+ *
+ * A list of merging rules can be found in test file:
+ * https://github.com/pierreinglebert/json-merge-patch/blob/master/test/lib/merge.js
+ *
+ * @param currentSpec The original spec
+ * @param patchSpec The patch spec to be merged into the original spec
+ */
+function mergeOpenAPISpec(currentSpec, patchSpec) {
+    const mergedSpec = jsonmergepatch.merge(currentSpec, patchSpec);
+    return mergedSpec;
+}
+exports.mergeOpenAPISpec = mergeOpenAPISpec;
+//# sourceMappingURL=spec-enhancer.service.js.map

package/dist/enhancers/spec-enhancer.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"spec-enhancer.service.js","sourceRoot":"","sources":["../../src/enhancers/spec-enhancer.service.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;;;;;;;;;;;;;;;;;;;;;AAEhE,yCAA0E;AAC1E,kDAAgC;AAChC,0CAA4B;AAC5B,+BAA6B;AAE7B,mCAAuE;AACvE,MAAM,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;AAEnD,MAAM,KAAK,GAAG,eAAW,CAAC,gCAAgC,CAAC,CAAC;AAS5D;;;;;;;GAOG;AAEH,IAAa,kBAAkB,GAA/B,MAAa,kBAAkB;IAC7B;IACE;;OAEG;IAEK,YAAmC;IAC3C;;;OAGG;IAEa,OAAmC;QAN3C,iBAAY,GAAZ,YAAY,CAAuB;QAM3B,YAAO,GAAP,OAAO,CAA4B;QAG7C,UAAK,GAAgB;YAC3B,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE;gBACJ,KAAK,EAAE,sBAAsB;gBAC7B,OAAO,EAAE,OAAO;aACjB;YACD,KAAK,EAAE,EAAE;SACV,CAAC;IATC,CAAC;IAWJ;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IACD;;OAEG;IACH,IAAI,IAAI,CAAC,KAAkB;QACzB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,IAAY;QAClC,mCAAmC;QACnC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,IAAY;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,QAAQ;YAAE,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,OAAO,GAAG,EAAE;QAClC,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,IAAI,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;YAAE,OAAO,IAAI,CAAC,KAAK,CAAC;QAC5C,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE;YACzB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACvC;QACD,KAAK,CAAC,0CAA0C,cAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF,CAAA;AAtEY,kBAAkB;IAD9B,qBAAc,CAAC,yCAAiC,CAAC;IAM7C,WAAA,iBAAU,EAAE,CAAA;IAMZ,WAAA,aAAM,EAAE,CAAA;;GAXA,kBAAkB,CAsE9B;AAtEY,gDAAkB;AAwE/B;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAC9B,WAAiC,EACjC,SAA+B;IAE/B,MAAM,UAAU,GAAG,cAAc,CAAC,KAAK,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IAChE,OAAO,UAAU,CAAC;AACpB,CAAC;AAND,4CAMC"}

package/dist/enhancers/types.d.ts

@@ -0,0 +1,18 @@
+import { BindingTemplate } from '@loopback/core';
+import { OpenApiSpec } from '../types';
+/**
+ * Typically an extension point defines an interface as the contract for
+ * extensions to implement
+ */
+export interface OASEnhancer {
+    name: string;
+    modifySpec(spec: OpenApiSpec): OpenApiSpec;
+}
+/**
+ * Name/id of the OAS enhancer extension point
+ */
+export declare const OAS_ENHANCER_EXTENSION_POINT_NAME = "oas-enhancer";
+/**
+ * A binding template for spec contributor extensions
+ */
+export declare const asSpecEnhancer: BindingTemplate;

package/dist/enhancers/types.js

@@ -0,0 +1,20 @@
+"use strict";
+// Copyright IBM Corp. 2019. All Rights Reserved.
+// Node module: @loopback/openapi-v3
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@loopback/core");
+/**
+ * Name/id of the OAS enhancer extension point
+ */
+exports.OAS_ENHANCER_EXTENSION_POINT_NAME = 'oas-enhancer';
+/**
+ * A binding template for spec contributor extensions
+ */
+exports.asSpecEnhancer = binding => {
+    core_1.extensionFor(exports.OAS_ENHANCER_EXTENSION_POINT_NAME)(binding);
+    // is it ok to have a different namespace than the extension point name?
+    binding.tag({ namespace: 'oas-enhancer' });
+};
+//# sourceMappingURL=types.js.map

package/dist/enhancers/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/enhancers/types.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAEhE,yCAA6D;AAY7D;;GAEG;AACU,QAAA,iCAAiC,GAAG,cAAc,CAAC;AAEhE;;GAEG;AACU,QAAA,cAAc,GAAoB,OAAO,CAAC,EAAE;IACvD,mBAAY,CAAC,yCAAiC,CAAC,CAAC,OAAO,CAAC,CAAC;IACzD,wEAAwE;IACxE,OAAO,CAAC,GAAG,CAAC,EAAC,SAAS,EAAE,cAAc,EAAC,CAAC,CAAC;AAC3C,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from '@loopback/repository-json-schema';
 export * from './controller-spec';
 export * from './decorators';
+export * from './enhancers';
 export * from './filter-schema';
 export * from './json-to-schema';
 export * from './types';

package/dist/index.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __export(require("@loopback/repository-json-schema"));
 __export(require("./controller-spec"));
 __export(require("./decorators"));
+__export(require("./enhancers"));
 __export(require("./filter-schema"));
 __export(require("./json-to-schema"));
 __export(require("./types"));

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;;AAEhE,sDAAiD;AACjD,uCAAkC;AAClC,kCAA6B;AAC7B,qCAAgC;AAChC,sCAAiC;AACjC,6BAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;;AAEhE,sDAAiD;AACjD,uCAAkC;AAClC,kCAA6B;AAC7B,iCAA4B;AAC5B,qCAAgC;AAChC,sCAAiC;AACjC,6BAAwB"}

package/dist/json-to-schema.js

@@ -3,8 +3,11 @@
 // Node module: @loopback/openapi-v3
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const _ = require("lodash");
+const lodash_1 = __importDefault(require("lodash"));
 const types_1 = require("./types");
 /**
  * Converts JSON Schemas into a SchemaObject
@@ -25,13 +28,7 @@ function jsonToSchemaObject(json, visited = new Map()) {
         [converted]: false,
     };
     visited.set(json, result);
-    const propsToIgnore = [
-        'anyOf',
-        'oneOf',
-        'additionalItems',
-        'defaultProperties',
-        'typeof',
-    ];
+    const propsToIgnore = ['additionalItems', 'defaultProperties', 'typeof'];
     for (const property in json) {
         if (propsToIgnore.includes(property)) {
             continue;
@@ -45,15 +42,23 @@ function jsonToSchemaObject(json, visited = new Map()) {
                 break;
             }
             case 'allOf': {
-                result.allOf = _.map(json.allOf, item => jsonToSchemaObject(item, visited));
+                result.allOf = lodash_1.default.map(json.allOf, item => jsonToSchemaObject(item, visited));
+                break;
+            }
+            case 'anyOf': {
+                result.anyOf = lodash_1.default.map(json.anyOf, item => jsonToSchemaObject(item, visited));
+                break;
+            }
+            case 'oneOf': {
+                result.oneOf = lodash_1.default.map(json.oneOf, item => jsonToSchemaObject(item, visited));
                 break;
             }
             case 'definitions': {
-                result.definitions = _.mapValues(json.definitions, def => jsonToSchemaObject(jsonOrBooleanToJSON(def), visited));
+                result.definitions = lodash_1.default.mapValues(json.definitions, def => jsonToSchemaObject(jsonOrBooleanToJSON(def), visited));
                 break;
             }
             case 'properties': {
-                result.properties = _.mapValues(json.properties, item => jsonToSchemaObject(jsonOrBooleanToJSON(item), visited));
+                result.properties = lodash_1.default.mapValues(json.properties, item => jsonToSchemaObject(jsonOrBooleanToJSON(item), visited));
                 break;
             }
             case 'additionalProperties': {

package/dist/json-to-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"json-to-schema.js","sourceRoot":"","sources":["../src/json-to-schema.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAGhE,4BAA4B;AAC5B,mCAKiB;AAwBjB;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,IAAgB,EAChB,UAAqD,IAAI,GAAG,EAAE;IAE9D,wDAAwD;IACxD,MAAM,SAAS,GAAG,sBAAsB,CAAC;IACzC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,MAAM,IAAI,IAAI,IAAI,sBAAc,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;QAC3E,OAAO,EAAC,IAAI,EAAE,wBAAwB,IAAI,CAAC,KAAK,EAAE,EAAC,CAAC;KACrD;IACD,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,MAAM,CAAC;IAElC,MAAM,MAAM,GAAiB;QAC3B,CAAC,SAAS,CAAC,EAAE,KAAK;KACnB,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1B,MAAM,aAAa,GAAG;QACpB,OAAO;QACP,OAAO;QACP,iBAAiB;QACjB,mBAAmB;QACnB,QAAQ;KACT,CAAC;IACF,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE;QAC3B,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACpC,SAAS;SACV;QACD,QAAQ,QAAQ,EAAE;YAChB,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACxC,MAAM,IAAI,KAAK,CACb,wDAAwD,CACzD,CAAC;iBACH;gBACD,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBAClE,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CACtC,kBAAkB,CAAC,IAAkB,EAAE,OAAO,CAAC,CAChD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,aAAa,CAAC,CAAC;gBAClB,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,CACvD,kBAAkB,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CACtD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,YAAY,CAAC,CAAC;gBACjB,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CACtD,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CACvD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,sBAAsB,CAAC,CAAC;gBAC3B,IAAI,OAAO,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE;oBAClD,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC;iBACzD;qBAAM;oBACL,MAAM,CAAC,oBAAoB,GAAG,kBAAkB,CAC9C,IAAI,CAAC,oBAAqB,EAC1B,OAAO,CACR,CAAC;iBACH;gBACD,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;gBACrE,MAAM,CAAC,KAAK,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,KAAM,CAAC,EAAE,OAAO,CAAC,CAAC;gBACxE,MAAM;aACP;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAK,CAAC,OAAO,CAC9B,eAAe,EACf,sBAAsB,CACvB,CAAC;gBACF,MAAM;aACP;YACD,KAAK,UAAU,CAAC,CAAC;gBACf,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBAChC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;iBACnC;gBACD,MAAM;aACP;YACD,OAAO,CAAC,CAAC;gBACP,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAA4B,CAAC,CAAC;gBACtD,MAAM;aACP;SACF;KACF;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AA7FD,gDA6FC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,UAAgC;IAClE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,OAAO,UAAU,CAAC;KACnB;SAAM;QACL,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,EAAE,EAAC,CAAC;KACpC;AACH,CAAC;AAND,kDAMC"}
+{"version":3,"file":"json-to-schema.js","sourceRoot":"","sources":["../src/json-to-schema.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;;;;AAGhE,oDAAuB;AACvB,mCAKiB;AAwBjB;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,IAAgB,EAChB,UAAqD,IAAI,GAAG,EAAE;IAE9D,wDAAwD;IACxD,MAAM,SAAS,GAAG,sBAAsB,CAAC;IACzC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACjC,IAAI,MAAM,IAAI,IAAI,IAAI,sBAAc,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,KAAK,EAAE;QAC3E,OAAO,EAAC,IAAI,EAAE,wBAAwB,IAAI,CAAC,KAAK,EAAE,EAAC,CAAC;KACrD;IACD,IAAI,MAAM,IAAI,IAAI;QAAE,OAAO,MAAM,CAAC;IAElC,MAAM,MAAM,GAAiB;QAC3B,CAAC,SAAS,CAAC,EAAE,KAAK;KACnB,CAAC;IACF,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1B,MAAM,aAAa,GAAG,CAAC,iBAAiB,EAAE,mBAAmB,EAAE,QAAQ,CAAC,CAAC;IACzE,KAAK,MAAM,QAAQ,IAAI,IAAI,EAAE;QAC3B,IAAI,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE;YACpC,SAAS;SACV;QACD,QAAQ,QAAQ,EAAE;YAChB,KAAK,MAAM,CAAC,CAAC;gBACX,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;oBACxC,MAAM,IAAI,KAAK,CACb,wDAAwD,CACzD,CAAC;iBACH;gBACD,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;gBAClE,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,CAAC,KAAK,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CACtC,kBAAkB,CAAC,IAAkB,EAAE,OAAO,CAAC,CAChD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,CAAC,KAAK,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CACtC,kBAAkB,CAAC,IAAkB,EAAE,OAAO,CAAC,CAChD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,CAAC,KAAK,GAAG,gBAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CACtC,kBAAkB,CAAC,IAAkB,EAAE,OAAO,CAAC,CAChD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,aAAa,CAAC,CAAC;gBAClB,MAAM,CAAC,WAAW,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,CACvD,kBAAkB,CAAC,mBAAmB,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CACtD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,YAAY,CAAC,CAAC;gBACjB,MAAM,CAAC,UAAU,GAAG,gBAAC,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,EAAE,CACtD,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CACvD,CAAC;gBACF,MAAM;aACP;YACD,KAAK,sBAAsB,CAAC,CAAC;gBAC3B,IAAI,OAAO,IAAI,CAAC,oBAAoB,KAAK,SAAS,EAAE;oBAClD,MAAM,CAAC,oBAAoB,GAAG,IAAI,CAAC,oBAAoB,CAAC;iBACzD;qBAAM;oBACL,MAAM,CAAC,oBAAoB,GAAG,kBAAkB,CAC9C,IAAI,CAAC,oBAAqB,EAC1B,OAAO,CACR,CAAC;iBACH;gBACD,MAAM;aACP;YACD,KAAK,OAAO,CAAC,CAAC;gBACZ,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;gBACrE,MAAM,CAAC,KAAK,GAAG,kBAAkB,CAAC,mBAAmB,CAAC,KAAM,CAAC,EAAE,OAAO,CAAC,CAAC;gBACxE,MAAM;aACP;YACD,KAAK,MAAM,CAAC,CAAC;gBACX,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,IAAK,CAAC,OAAO,CAC9B,eAAe,EACf,sBAAsB,CACvB,CAAC;gBACF,MAAM;aACP;YACD,KAAK,UAAU,CAAC,CAAC;gBACf,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;oBAChC,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;iBACnC;gBACD,MAAM;aACP;YACD,OAAO,CAAC,CAAC;gBACP,MAAM,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAA4B,CAAC,CAAC;gBACtD,MAAM;aACP;SACF;KACF;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC;IACzB,OAAO,MAAM,CAAC;AAChB,CAAC;AAnGD,gDAmGC;AAED;;;;;GAKG;AACH,SAAgB,mBAAmB,CAAC,UAAgC;IAClE,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;QAClC,OAAO,UAAU,CAAC;KACnB;SAAM;QACL,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAC,GAAG,EAAE,EAAE,EAAC,CAAC;KACpC;AACH,CAAC;AAND,kDAMC"}

package/dist/keys.d.ts

@@ -1,4 +1,4 @@
-import { MetadataAccessor } from '@loopback/context';
+import { MetadataAccessor } from '@loopback/core';
 import { ControllerSpec, RestEndpoint } from './controller-spec';
 import { ParameterObject, RequestBodyObject } from './types';
 export declare namespace OAI3Keys {
@@ -6,10 +6,26 @@ export declare namespace OAI3Keys {
      * Metadata key used to set or retrieve `@operation` metadata.
      */
     const METHODS_KEY: MetadataAccessor<Partial<RestEndpoint>, MethodDecorator>;
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a method.
+     */
+    const DEPRECATED_METHOD_KEY: MetadataAccessor<boolean, MethodDecorator>;
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a class
+     */
+    const DEPRECATED_CLASS_KEY: MetadataAccessor<boolean, ClassDecorator>;
     /**
      * Metadata key used to set or retrieve `param` decorator metadata
      */
     const PARAMETERS_KEY: MetadataAccessor<ParameterObject, ParameterDecorator>;
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a method.
+     */
+    const TAGS_METHOD_KEY: MetadataAccessor<string[], MethodDecorator>;
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a class
+     */
+    const TAGS_CLASS_KEY: MetadataAccessor<string[], ClassDecorator>;
     /**
      * Metadata key used to set or retrieve `@api` metadata
      */

package/dist/keys.js

@@ -4,32 +4,44 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 Object.defineProperty(exports, "__esModule", { value: true });
-const context_1 = require("@loopback/context");
-// Copyright IBM Corp. 2018. All Rights Reserved.
-// Node module: @loopback/openapi-v3
-// This file is licensed under the MIT License.
-// License text available at https://opensource.org/licenses/MIT
+const core_1 = require("@loopback/core");
 var OAI3Keys;
 (function (OAI3Keys) {
     /**
      * Metadata key used to set or retrieve `@operation` metadata.
      */
-    OAI3Keys.METHODS_KEY = context_1.MetadataAccessor.create('openapi-v3:methods');
+    OAI3Keys.METHODS_KEY = core_1.MetadataAccessor.create('openapi-v3:methods');
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a method.
+     */
+    OAI3Keys.DEPRECATED_METHOD_KEY = core_1.MetadataAccessor.create('openapi-v3:methods:deprecated');
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a class
+     */
+    OAI3Keys.DEPRECATED_CLASS_KEY = core_1.MetadataAccessor.create('openapi-v3:class:deprecated');
     /**
      * Metadata key used to set or retrieve `param` decorator metadata
      */
-    OAI3Keys.PARAMETERS_KEY = context_1.MetadataAccessor.create('openapi-v3:parameters');
+    OAI3Keys.PARAMETERS_KEY = core_1.MetadataAccessor.create('openapi-v3:parameters');
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a method.
+     */
+    OAI3Keys.TAGS_METHOD_KEY = core_1.MetadataAccessor.create('openapi-v3:methods:tags');
+    /**
+     * Metadata key used to set or retrieve `@deprecated` metadata on a class
+     */
+    OAI3Keys.TAGS_CLASS_KEY = core_1.MetadataAccessor.create('openapi-v3:class:tags');
     /**
      * Metadata key used to set or retrieve `@api` metadata
      */
-    OAI3Keys.CLASS_KEY = context_1.MetadataAccessor.create('openapi-v3:class');
+    OAI3Keys.CLASS_KEY = core_1.MetadataAccessor.create('openapi-v3:class');
     /**
      * Metadata key used to set or retrieve a controller spec
      */
-    OAI3Keys.CONTROLLER_SPEC_KEY = context_1.MetadataAccessor.create('openapi-v3:controller-spec');
+    OAI3Keys.CONTROLLER_SPEC_KEY = core_1.MetadataAccessor.create('openapi-v3:controller-spec');
     /**
      * Metadata key used to set or retrieve `@requestBody` metadata
      */
-    OAI3Keys.REQUEST_BODY_KEY = context_1.MetadataAccessor.create('openapi-v3:request-body');
+    OAI3Keys.REQUEST_BODY_KEY = core_1.MetadataAccessor.create('openapi-v3:request-body');
 })(OAI3Keys = exports.OAI3Keys || (exports.OAI3Keys = {}));
 //# sourceMappingURL=keys.js.map

package/dist/keys.js.map

@@ -1 +1 @@
-{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAEhE,+CAAmD;AAInD,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;AAEhE,IAAiB,QAAQ,CAwCxB;AAxCD,WAAiB,QAAQ;IACvB;;OAEG;IACU,oBAAW,GAAG,0BAAgB,CAAC,MAAM,CAGhD,oBAAoB,CAAC,CAAC;IAExB;;OAEG;IACU,uBAAc,GAAG,0BAAgB,CAAC,MAAM,CAGnD,uBAAuB,CAAC,CAAC;IAE3B;;OAEG;IACU,kBAAS,GAAG,0BAAgB,CAAC,MAAM,CAG9C,kBAAkB,CAAC,CAAC;IAEtB;;OAEG;IACU,4BAAmB,GAAG,0BAAgB,CAAC,MAAM,CAGxD,4BAA4B,CAAC,CAAC;IAEhC;;OAEG;IACU,yBAAgB,GAAG,0BAAgB,CAAC,MAAM,CAGrD,yBAAyB,CAAC,CAAC;AAC/B,CAAC,EAxCgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAwCxB"}
+{"version":3,"file":"keys.js","sourceRoot":"","sources":["../src/keys.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,oCAAoC;AACpC,+CAA+C;AAC/C,gEAAgE;;AAEhE,yCAAgD;AAIhD,IAAiB,QAAQ,CAwExB;AAxED,WAAiB,QAAQ;IACvB;;OAEG;IACU,oBAAW,GAAG,uBAAgB,CAAC,MAAM,CAGhD,oBAAoB,CAAC,CAAC;IAExB;;OAEG;IACU,8BAAqB,GAAG,uBAAgB,CAAC,MAAM,CAG1D,+BAA+B,CAAC,CAAC;IAEnC;;OAEG;IACU,6BAAoB,GAAG,uBAAgB,CAAC,MAAM,CAGzD,6BAA6B,CAAC,CAAC;IAEjC;;OAEG;IACU,uBAAc,GAAG,uBAAgB,CAAC,MAAM,CAGnD,uBAAuB,CAAC,CAAC;IAE3B;;OAEG;IACU,wBAAe,GAAG,uBAAgB,CAAC,MAAM,CAGpD,yBAAyB,CAAC,CAAC;IAE7B;;OAEG;IACU,uBAAc,GAAG,uBAAgB,CAAC,MAAM,CAGnD,uBAAuB,CAAC,CAAC;IAE3B;;OAEG;IACU,kBAAS,GAAG,uBAAgB,CAAC,MAAM,CAG9C,kBAAkB,CAAC,CAAC;IAEtB;;OAEG;IACU,4BAAmB,GAAG,uBAAgB,CAAC,MAAM,CAGxD,4BAA4B,CAAC,CAAC;IAEhC;;OAEG;IACU,yBAAgB,GAAG,uBAAgB,CAAC,MAAM,CAGrD,yBAAyB,CAAC,CAAC;AAC/B,CAAC,EAxEgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAwExB"}

package/dist/types.d.ts

@@ -7,3 +7,6 @@ export * from 'openapi3-ts';
  * @deprecated Use `OpenApiBuilder` from `openapi3-ts` instead.
  */
 export declare function createEmptyApiSpec(): OpenApiSpec;
+export interface TagsDecoratorMetadata {
+    tags: string[];
+}