1 files changed, 28 insertions, 5 deletions

diff --git a/src/main/resources/reference.conf b/src/main/resources/reference.conf
index 637f713..16dcfda 100644
--- a/src/main/resources/reference.conf
+++ b/src/main/resources/reference.conf
@@ -1,25 +1,48 @@
+######################################################################
+# Default settings for driver core. Any settings defined by users of #
+# this library will take precedence. See the documentation of the    #
+# Typesafe Config Library (https://github.com/lightbend/config) for  #
+# more information.						     #
+######################################################################
 
-// This file takes on the lowest config priority. Any settings implemented in
-// entities that use this library will take precedence.
+# This scope is for general settings related to the execution of a
+# specific service.
 application {
   baseUrl: "localhost:8080"
   environment: "local_testing"
 }
 
+# Settings about the auto-generated REST API documentation.
 swagger {
+
+  # Version of the Swagger specification
+  # (https://swagger.io/specification/). Note that changing this will
+  # likely require changing the way Swagger is integrated into
+  # driver-core, involving upgrading libraries and web resources.
   apiVersion = "2.0"
+
   basePath = "/"
+
   docsPath = "api-docs"
 
+  # Description and usage of the specific API provided by the service
+  # using this library.
   apiInfo {
-    title = "NEW SERVICE"
+
+    # Name of the service
+    title = "NEW SERVICE (change config swagger.apiInfo)"
+
+    # Description of the service
     description = "Please implement swagger info in your new service"
-    termsOfServiceUrl = "TOC Url"
+
+    # Contact for support about this service.
     contact {
       name = "Driver Inc."
-      url = "http://driver.xyz"
+      url = "https://driver.xyz"
       email = "info@driver.xyz"
     }
+
+    termsOfServiceUrl = "TOC Url"
     license = "Apache V2"
     licenseUrl = "http://www.apache.org/licenses/LICENSE-2.0"
   }