Merge branch 'development'

Author: jclausen

.module.properties

@@ -1,3 +1,3 @@
 project.name=swagger-sdk
-project.version=1.0.3
+project.version=1.0.4
 module.name=swagger-sdk

changelog.md

@@ -9,3 +9,7 @@ CHANGELOG
 
 ## 1.0.2
 * Adobe Coldfusion compatibility updates
+
+
+## 1.0.4
+*  Adds security definitions to default template 

instructions.md

@@ -14,24 +14,25 @@ component name="OpenAPIUtil" accessors="true" {
 		//We need to use Linked Hashmaps to maintain struct order for serialization and deserialization
 		var template = createLinkedHashMap();
 
-		var templateDefaults  = [ 
-		{"swagger"            : "2.0"},
-		{
-		  "info"              : {
-		      "version"       : "",
-		      "title"         : "",
-		      "description"   : "",
-		      "termsOfService": "",
-		      "contact"       : createLinkedHashMap(),
-		      "license"       : createLinkedHashMap()
-		    }
-		},
-		{"host"               : ""},
-		{"basePath"           : ""},
-		{"schemes"            : []},
-		{"consumes"           : ["application/json","multipart/form-data","application/x-www-form-urlencoded"]},
-		{"produces"           : ["application/json"]},
-		{"paths"              : createLinkedHashMap()}
+			var templateDefaults  = [ 
+			{"swagger"            : "2.0"},
+			{
+			  "info"              : {
+			      "version"       : "",
+			      "title"         : "",
+			      "description"   : "",
+			      "termsOfService": "",
+			      "contact"       : createLinkedHashMap(),
+			      "license"       : createLinkedHashMap()
+			    }
+			},
+			{"host"               : ""},
+			{"basePath"           : ""},
+			{"schemes"            : []},
+			{"consumes"           : ["application/json","multipart/form-data","application/x-www-form-urlencoded"]},
+			{"produces"           : ["application/json"]},
+			{"paths"              : createLinkedHashMap()},
+			{"securityDefinitions": createLinkedHashMap()}
 
 		];
 

modules/swagger-sdk/models/OpenAPI/Util.cfc

@@ -3,6 +3,37 @@
 
 This module allows for software development using the Swagger/OpenAPI specification and utilizes the [v3.0 OpenAPI Specification]([https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md])
 
+##See These Other Swagger/OpenAPI-aware Coldbox Modules
+
+* [Relax](https://www.forgebox.io/view/relax)
+* [cbSwagger](https://www.forgebox.io/view/cbswagger)
+
+
+##Install Swaggger SDK ( via Commandbox )
+
+`box install swagger-sdk`
+
+##Usage
+
+This SDK allows for creation, parsing, and normalization of OpenAPI documentation.  
+
+###Parse a Swagger JSON or YML file:
+
+```
+var APIDoc = Wirebox.getInstance( "OpenAPIParser@SwaggerSDK" ).init( DocumentPathOrURL );
+```
+
+This returns the parsed document object, which can be fully normalized ( e.g. $ref attributes are loaded and normalized within the document ) with `APIDoc.getNormalizedDocument()`
+
+You may also export the normalized document object to JSON (`APIDoc.asJSON()`), YAML (`APIDoc.asYAML()`), or as Struct++ (`APIDoc.asYAML()`)
+
+++Note: in order to maintain order, the struct format used is a Java.util.LinkedHashmap.  In order to access struct keys you will need to use braces ( e.g. = `APIDoc[ "info" ][ "title" ]` )
+
+
+See the APIDocs for additional information on methods and functions available in the SDK
+
+
+
 ##LICENSE
 Apache License, Version 2.0.