@loopback/openapi-v3 5.3.0 → 6.0.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@loopback/openapi-v3",
   "description": "Decorators that annotate LoopBack artifacts with OpenAPI v3 metadata and utilities that transform LoopBack metadata to OpenAPI v3 specifications",
-  "version": "5.3.0",
+  "version": "6.0.2",
   "keywords": [
     "Swagger",
     "OpenAPI Spec",
@@ -14,7 +14,7 @@
   "copyright.owner": "IBM Corp.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
     "directory": "packages/openapi-v3"
   },
   "engines": {
@@ -39,28 +39,28 @@
     "!*/__tests__"
   ],
   "peerDependencies": {
-    "@loopback/core": "^2.16.0"
+    "@loopback/core": "^2.18.0"
   },
   "dependencies": {
-    "@loopback/repository-json-schema": "^3.4.0",
-    "debug": "^4.3.1",
+    "@loopback/repository-json-schema": "^4.0.2",
+    "debug": "^4.3.2",
     "http-status": "^1.5.0",
-    "json-merge-patch": "^1.0.1",
+    "json-merge-patch": "^1.0.2",
     "lodash": "^4.17.21",
     "openapi3-ts": "^2.0.1",
-    "tslib": "^2.2.0"
+    "tslib": "^2.3.1"
   },
   "devDependencies": {
-    "@loopback/build": "^6.4.0",
-    "@loopback/core": "^2.16.0",
-    "@loopback/eslint-config": "^10.2.0",
-    "@loopback/openapi-spec-builder": "^3.2.0",
-    "@loopback/repository": "^3.6.0",
-    "@loopback/testlab": "^3.4.0",
-    "@types/debug": "^4.1.5",
+    "@loopback/build": "^7.0.2",
+    "@loopback/core": "^2.18.0",
+    "@loopback/eslint-config": "^11.0.2",
+    "@loopback/openapi-spec-builder": "^3.2.4",
+    "@loopback/repository": "^3.7.3",
+    "@loopback/testlab": "^3.4.4",
+    "@types/debug": "^4.1.7",
     "@types/json-merge-patch": "0.0.5",
-    "@types/lodash": "^4.14.168",
-    "@types/node": "^10.17.59"
+    "@types/lodash": "^4.14.175",
+    "@types/node": "^10.17.60"
   },
-  "gitHead": "2ca802912d8c7750d0256f3c3d493c4525415201"
+  "gitHead": "d9a29c85dbe38f12ba219d8c495cf6038bbc3590"
 }

package/src/build-responses-from-metadata.ts

@@ -3,8 +3,8 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {DecoratorFactory} from '@loopback/core';
-import {Model} from '@loopback/repository';
+import {DecoratorFactory, MetadataInspector} from '@loopback/core';
+import {Model, MODEL_KEY} from '@loopback/repository';
 import {
   ContentObject,
   OperationObject,
@@ -21,7 +21,11 @@ declare type ResponseMap = Map<
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function isModel<T extends Model>(c: any): c is T {
-  return c?.prototype instanceof Model;
+  return (
+    c?.prototype instanceof Model ||
+    // Allowing classes decorated with `@model` but not extending from `Model`
+    MetadataInspector.getClassMetadata(MODEL_KEY, c) != null
+  );
 }
 
 /**

package/src/controller-spec.ts

@@ -95,10 +95,11 @@ function resolveControllerSpec(constructor: Function): ControllerSpec {
     constructor,
   );
 
-  const classVisibility = MetadataInspector.getClassMetadata<OperationVisibility>(
-    OAI3Keys.VISIBILITY_CLASS_KEY,
-    constructor,
-  );
+  const classVisibility =
+    MetadataInspector.getClassMetadata<OperationVisibility>(
+      OAI3Keys.VISIBILITY_CLASS_KEY,
+      constructor,
+    );
 
   if (classVisibility) {
     debug(`  using class-level @oas.visibility(): '${classVisibility}'`);
@@ -158,11 +159,12 @@ function resolveControllerSpec(constructor: Function): ControllerSpec {
       debug('  using method-level deprecation via @deprecated()');
     }
 
-    const methodVisibility = MetadataInspector.getMethodMetadata<OperationVisibility>(
-      OAI3Keys.VISIBILITY_METHOD_KEY,
-      constructor.prototype,
-      op,
-    );
+    const methodVisibility =
+      MetadataInspector.getMethodMetadata<OperationVisibility>(
+        OAI3Keys.VISIBILITY_METHOD_KEY,
+        constructor.prototype,
+        op,
+      );
 
     if (methodVisibility) {
       debug(
@@ -170,11 +172,12 @@ function resolveControllerSpec(constructor: Function): ControllerSpec {
       );
     }
 
-    const methodTags = MetadataInspector.getMethodMetadata<TagsDecoratorMetadata>(
-      OAI3Keys.TAGS_METHOD_KEY,
-      constructor.prototype,
-      op,
-    );
+    const methodTags =
+      MetadataInspector.getMethodMetadata<TagsDecoratorMetadata>(
+        OAI3Keys.TAGS_METHOD_KEY,
+        constructor.prototype,
+        op,
+      );
 
     if (methodTags) {
       debug('  using method-level tags via @oas.tags()');
@@ -196,11 +199,12 @@ function resolveControllerSpec(constructor: Function): ControllerSpec {
 
     let operationSpec = endpoint.spec;
 
-    const decoratedResponses = MetadataInspector.getMethodMetadata<ResponseDecoratorMetadata>(
-      OAI3Keys.RESPONSE_METHOD_KEY,
-      constructor.prototype,
-      op,
-    );
+    const decoratedResponses =
+      MetadataInspector.getMethodMetadata<ResponseDecoratorMetadata>(
+        OAI3Keys.RESPONSE_METHOD_KEY,
+        constructor.prototype,
+        op,
+      );
 
     if (!operationSpec) {
       if (decoratedResponses) {
@@ -304,11 +308,12 @@ function resolveControllerSpec(constructor: Function): ControllerSpec {
     }
 
     debug('  processing requestBody for method %s', op);
-    let requestBodies = MetadataInspector.getAllParameterMetadata<RequestBodyObject>(
-      OAI3Keys.REQUEST_BODY_KEY,
-      constructor.prototype,
-      op,
-    );
+    let requestBodies =
+      MetadataInspector.getAllParameterMetadata<RequestBodyObject>(
+        OAI3Keys.REQUEST_BODY_KEY,
+        constructor.prototype,
+        op,
+      );
 
     const bodyIndexes: number[] = [];
     if (requestBodies != null)

package/src/decorators/deprecated.decorator.ts

@@ -57,7 +57,7 @@ export function deprecated(isDeprecated = true) {
     target: any,
     method?: string,
     // Use `any` to for `TypedPropertyDescriptor`
-    // See https://github.com/strongloop/loopback-next/pull/2704
+    // See https://github.com/loopbackio/loopback-next/pull/2704
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     methodDescriptor?: TypedPropertyDescriptor<any>,
   ) {

package/src/decorators/tags.decorator.ts

@@ -59,7 +59,7 @@ export function tags(...tagNames: string[]) {
     target: any,
     method?: string,
     // Use `any` to for `TypedPropertyDescriptor`
-    // See https://github.com/strongloop/loopback-next/pull/2704
+    // See https://github.com/loopbackio/loopback-next/pull/2704
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     methodDescriptor?: TypedPropertyDescriptor<any>,
   ) {

package/src/decorators/visibility.decorator.ts

@@ -56,7 +56,7 @@ export function visibility(visibilityType: OperationVisibility) {
     target: any,
     method?: string,
     // Use `any` to for `TypedPropertyDescriptor`
-    // See https://github.com/strongloop/loopback-next/pull/2704
+    // See https://github.com/loopbackio/loopback-next/pull/2704
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     methodDescriptor?: TypedPropertyDescriptor<any>,
   ) {

package/src/enhancers/spec-enhancer.service.ts

@@ -121,7 +121,7 @@ export class OASEnhancerService {
  */
 export function mergeOpenAPISpec<
   C extends Partial<OpenApiSpec>,
-  P extends Partial<OpenApiSpec>
+  P extends Partial<OpenApiSpec>,
 >(currentSpec: C, patchSpec: P): C & P {
   const mergedSpec = jsonmergepatch.merge(currentSpec, patchSpec);
   return mergedSpec;