@loopback/openapi-v3 1.10.3 → 2.0.0

package/src/enhancers/types.ts

@@ -0,0 +1,30 @@
+// 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
+
+import {BindingTemplate, extensionFor} 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 const OAS_ENHANCER_EXTENSION_POINT_NAME = 'oas-enhancer';
+
+/**
+ * A binding template for spec contributor extensions
+ */
+export const asSpecEnhancer: BindingTemplate = binding => {
+  extensionFor(OAS_ENHANCER_EXTENSION_POINT_NAME)(binding);
+  // is it ok to have a different namespace than the extension point name?
+  binding.tag({namespace: 'oas-enhancer'});
+};

package/src/index.ts

@@ -6,6 +6,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/src/json-to-schema.ts

@@ -56,13 +56,7 @@ export function jsonToSchemaObject(
     [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;
@@ -83,6 +77,18 @@ export function jsonToSchemaObject(
         );
         break;
       }
+      case 'anyOf': {
+        result.anyOf = _.map(json.anyOf, item =>
+          jsonToSchemaObject(item as JsonSchema, visited),
+        );
+        break;
+      }
+      case 'oneOf': {
+        result.oneOf = _.map(json.oneOf, item =>
+          jsonToSchemaObject(item as JsonSchema, visited),
+        );
+        break;
+      }
       case 'definitions': {
         result.definitions = _.mapValues(json.definitions, def =>
           jsonToSchemaObject(jsonOrBooleanToJSON(def), visited),

package/src/keys.ts

@@ -3,15 +3,10 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-import {MetadataAccessor} from '@loopback/context';
+import {MetadataAccessor} from '@loopback/core';
 import {ControllerSpec, RestEndpoint} from './controller-spec';
 import {ParameterObject, RequestBodyObject} from './types';
 
-// 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
-
 export namespace OAI3Keys {
   /**
    * Metadata key used to set or retrieve `@operation` metadata.
@@ -21,6 +16,22 @@ export namespace OAI3Keys {
     MethodDecorator
   >('openapi-v3:methods');
 
+  /**
+   * Metadata key used to set or retrieve `@deprecated` metadata on a method.
+   */
+  export const DEPRECATED_METHOD_KEY = MetadataAccessor.create<
+    boolean,
+    MethodDecorator
+  >('openapi-v3:methods:deprecated');
+
+  /**
+   * Metadata key used to set or retrieve `@deprecated` metadata on a class
+   */
+  export const DEPRECATED_CLASS_KEY = MetadataAccessor.create<
+    boolean,
+    ClassDecorator
+  >('openapi-v3:class:deprecated');
+
   /**
    * Metadata key used to set or retrieve `param` decorator metadata
    */
@@ -29,6 +40,22 @@ export namespace OAI3Keys {
     ParameterDecorator
   >('openapi-v3:parameters');
 
+  /**
+   * Metadata key used to set or retrieve `@deprecated` metadata on a method.
+   */
+  export const TAGS_METHOD_KEY = MetadataAccessor.create<
+    string[],
+    MethodDecorator
+  >('openapi-v3:methods:tags');
+
+  /**
+   * Metadata key used to set or retrieve `@deprecated` metadata on a class
+   */
+  export const TAGS_CLASS_KEY = MetadataAccessor.create<
+    string[],
+    ClassDecorator
+  >('openapi-v3:class:tags');
+
   /**
    * Metadata key used to set or retrieve `@api` metadata
    */

package/src/types.ts

@@ -28,3 +28,7 @@ export function createEmptyApiSpec(): OpenApiSpec {
     servers: [{url: '/'}],
   };
 }
+
+export interface TagsDecoratorMetadata {
+  tags: string[];
+}