From 90251daf7e61d6700a6efea7a5e8fea73bae30d7 Mon Sep 17 00:00:00 2001
From: joshua bauer <josh@wurrly.com>
Date: Wed, 10 May 2017 17:18:11 -0700
Subject: [PATCH] Made the swagger resource prefix configurable.

---
 .../io/sinistral/proteus/server/swagger/Reader.java |  3 ++-
 .../io/sinistral/proteus/services/BaseService.java  |  2 ++
 .../sinistral/proteus/services/SwaggerService.java  |  7 +++++--
 src/main/resources/reference.conf                   | 13 +++++++++++++
 4 files changed, 22 insertions(+), 3 deletions(-)

diff --git a/src/main/java/io/sinistral/proteus/server/swagger/Reader.java b/src/main/java/io/sinistral/proteus/server/swagger/Reader.java
index 07e4884..beaec61 100644
--- a/src/main/java/io/sinistral/proteus/server/swagger/Reader.java
+++ b/src/main/java/io/sinistral/proteus/server/swagger/Reader.java
@@ -7,6 +7,7 @@
 import java.lang.reflect.Method;
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
+import java.nio.ByteBuffer;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -1263,7 +1264,7 @@ private static boolean isValidResponse(Type type) {
       
         if( cls != null )
         {
-        	if( cls.isAssignableFrom(ServerResponse.class) || cls.isAssignableFrom(CompletableFuture.class))
+        	if( cls.isAssignableFrom(ServerResponse.class) || cls.isAssignableFrom(CompletableFuture.class) || cls.isAssignableFrom(ByteBuffer.class))
         	{
         		return false;
         	}
diff --git a/src/main/java/io/sinistral/proteus/services/BaseService.java b/src/main/java/io/sinistral/proteus/services/BaseService.java
index 2f8bb4a..bacafcd 100644
--- a/src/main/java/io/sinistral/proteus/services/BaseService.java
+++ b/src/main/java/io/sinistral/proteus/services/BaseService.java
@@ -14,6 +14,8 @@
 import com.typesafe.config.Config;
 
 /**
+ * An abstract base class for a Proteus service.
+ * 
  * @author jbauer
  *
  */
diff --git a/src/main/java/io/sinistral/proteus/services/SwaggerService.java b/src/main/java/io/sinistral/proteus/services/SwaggerService.java
index f3473d6..aabd887 100644
--- a/src/main/java/io/sinistral/proteus/services/SwaggerService.java
+++ b/src/main/java/io/sinistral/proteus/services/SwaggerService.java
@@ -61,8 +61,7 @@ public class SwaggerService   extends BaseService implements Supplier<RoutingHan
 	
 	protected final String swaggerResourcePathPrefix = "swagger";
 	
-	protected final String swaggerResourcePrefix = "io/sinistral/proteus/swagger";
-
+ 
 	protected Swagger swagger = null;
 	
 	protected String swaggerSpec = null;
@@ -70,6 +69,10 @@ public class SwaggerService   extends BaseService implements Supplier<RoutingHan
 	protected String swaggerIndexHTML = null;
 	
 	
+	@Inject
+	@Named("swagger.resourcePrefix")
+	protected String swaggerResourcePrefix;
+	
 	@Inject
 	@Named("swagger.basePath")
 	protected String swaggerBasePath;
diff --git a/src/main/resources/reference.conf b/src/main/resources/reference.conf
index 2a1c63d..e232865 100644
--- a/src/main/resources/reference.conf
+++ b/src/main/resources/reference.conf
@@ -47,9 +47,12 @@ globalHeaders
 
 
 assets {
+  # the base path assets will be server from
   path = "/public"
+  # the directory to load the assets from
   dir = "./assets"
   cache {
+    # cache timeout for the assets
     time = 500
   }
 }
@@ -57,16 +60,26 @@ assets {
 
 
 swagger {
+  # the path that has an index.html template and theme css files
+  resourcePrefix="io/sinistral/proteus/swagger"
+  # swagger version
   swagger: "2.0"
   info {
+    # swagger info title
     title = ${application.name}
+    # swagger info version
     version = ${application.version}
   }
+  # swagger-ui theme from ostranme's swagger-ui-themes, the following are built-in [feeling-blue, flattop, material, monokai, muted, newspaper, outline]
+  # specifying a different name causes the SwaggerService to search in {swagger.resourcePrefix}/themes for a file named "theme-{swagger.theme}.css"
   theme="default"
+  # where the swagger endpoints will be mounted
   basePath= ${application.path}"/swagger"
+  #the name of the spec file
   specFilename="swagger.json"
   consumes = ["application/json"]
   produces = ["application/json"]
+  # supported schemes
   schemes = ["http"]
 }