feat: add default deprecate enhancer

add deprecate enhancer Signed-off-by: Douglas McConnachie <[email protected]>
loopbackio · Jan 29, 2020 · 5271b8c · 5271b8c
1 parent 0b769a5
commit 5271b8c
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 0 deletions.
diff --git a/packages/openapi-v3/src/enhancers/default-deprecate-schema.enhancer.ts b/packages/openapi-v3/src/enhancers/default-deprecate-schema.enhancer.ts
@@ -0,0 +1,37 @@
+import {bind} from '@loopback/core';
+import {OperationObject} from 'openapi3-ts';
+import {OpenApiSpec} from '../types';
+import {asSpecEnhancer, OASEnhancer} from './types';
+
+/**
+ * A spec enhancer to add verbose deprecation status to OperationObjects
+ *
+ */
+@bind(asSpecEnhancer)
+export class DefaultDeprecateEnhancer implements OASEnhancer {
+  name = 'defaultdeprecate';
+
+  modifySpec(spec: OpenApiSpec): OpenApiSpec {
+    try {
+      return this.defaultDeprecate(spec);
+    } catch {
+      console.log('Default Deprecate Enhancer failed, returned original spec.');
+      return spec;
+    }
+  }
+
+  /**
+   *  add verbose deprecation status to OperationObjects if not set
+   *
+   */
+  private defaultDeprecate(spec: OpenApiSpec): OpenApiSpec {
+    Object.keys(spec.paths).forEach(path =>
+      Object.keys(spec.paths[path]).forEach(op => {
+        const OpObj = spec.paths[path][op] as OperationObject;
+        if (!OpObj.deprecated) OpObj.deprecated = false;
+      }),
+    );
+
+    return spec;
+  }
+}
diff --git a/packages/openapi-v3/src/enhancers/index.ts b/packages/openapi-v3/src/enhancers/index.ts
@@ -4,6 +4,7 @@
 // License text available at https://opensource.org/licenses/MIT
 
 export * from './consolidate-schema.enhancer';
+export * from './default-deprecate-schema.enhancer';
 export * from './keys';
 export * from './prune-schema.enhancer';
 export * from './spec-enhancer.service';

diff --git a/packages/rest/src/rest.server.ts b/packages/rest/src/rest.server.ts
@@ -15,6 +15,7 @@ import {Application, CoreBindings, Server} from '@loopback/core';
 import {HttpServer, HttpServerOptions} from '@loopback/http-server';
 import {
   ConsolidationEnhancer,
+  DefaultDeprecateEnhancer,
   getControllerSpec,
   OpenAPIObject,
   OpenApiSpec,
@@ -722,6 +723,8 @@ export class RestServer extends Context implements Server, HttpServerLike {
     spec = consolidationEnhancer.modifySpec(spec);
     const pruneEnhancer = new PruneEnhancer();
     spec = pruneEnhancer.modifySpec(spec);
+    const defaultDeprecateEnhancer = new DefaultDeprecateEnhancer();
+    spec = defaultDeprecateEnhancer.modifySpec(spec);
 
     return spec;
   }