Fix issue with double pound signs at root

Also added tests for more complex/nested scenarios.

Author: homestar9

models/OpenAPI/Parser.cfc

@@ -133,7 +133,14 @@ component name="OpenAPIParser" accessors="true" {
 		} else if( isStruct( DocItem ) ) {
 
             //handle top-level values, if they exist
-			if( structKeyExists( DocItem, "$ref" ) ) return fetchDocumentReference( DocItem[ "$ref" ] );
+			if( structKeyExists( DocItem, "$ref" ) ) {
+                // special handling for double pound signs
+                if( left( DocItem[ "$ref" ], 2 ) == chr( 35 ) & chr( 35 ) ) {
+                    DocItem[ "$ref" ] = right( DocItem[ "$ref" ], ( len( DocItem[ "$ref" ] ) - 1 ) );
+                    return DocItem;
+                }
+                return fetchDocumentReference( DocItem[ "$ref" ] );
+            }
 
 			for( var key in DocItem){
 
@@ -273,8 +280,14 @@ component name="OpenAPIParser" accessors="true" {
 	**/
 	private function fetchDocumentReference( required string $ref ){
 
+        /* if ( $ref == chr( 35 ) & chr( 35 ) & "/components/requestBodies/PostBody" ) {
+            writeDump( var=$ref, output="console" );
+        } */
+        
+        
         // double pound ## means we want to preserve the swagger $ref pointer (just remove the extra #)
         if( left( $ref, 2 ) == chr( 35 ) & chr( 35 ) ){
+            writeDump( var=right( $ref, ( len( $ref ) - 1 ) ), output="console" );
             return  { "$ref": right( $ref, ( len( $ref ) - 1 ) ) };
 		//resolve internal refrences before looking for externals
         } else if( left( $ref, 1 ) == chr( 35 )){

test-harness/tests/resources/coldboxRest/_examples/response.json

@@ -0,0 +1,9 @@
+{
+    "summary": "Response",
+    "description": "A generic response",
+    "value": {
+        "error": false,
+        "data": {},
+        "messages": []
+    }
+}

test-harness/tests/resources/coldboxRest/coldboxRest.json

@@ -52,9 +52,13 @@
             "Pagination": { "$ref": "_schemas/pagination.json" },
             "User": { "$ref": "paths/users/_schemas/user.json" },
             "Post": { "$ref": "paths/posts/_schemas/post.json" },
+            "PostBody": { "$ref": "paths/posts/_schemas/postBody.json" },
             "Media": { "$ref": "paths/media/_schemas/media.json" },
             "BookMedia": { "$ref": "paths/media/_schemas/bookMedia.json" },
             "MusicMedia": { "$ref": "paths/media/_schemas/musicMedia.json" }
+        },
+        "requestBodies": {
+            "PostBody": { "$ref": "paths/posts/_bodies/postBody.json" }
         }
     },
 	"paths": {

test-harness/tests/resources/coldboxRest/paths/posts/_bodies/postBody.json

@@ -0,0 +1,15 @@
+{
+    "description": "Post to Create",
+    "required": true,
+    "content": {
+        "application/json": {
+            "schema": { "$ref": "##/components/schemas/PostBody" },
+            "example":  {
+                "id": "1",
+                "title": "Washingtons Newburgh Address",
+                "body": "While I give you these assurances...",
+                "authorId": 1 
+            }
+        }
+    }
+}

test-harness/tests/resources/coldboxRest/paths/posts/_schemas/postBody.json

@@ -0,0 +1,17 @@
+{
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string"
+        },
+        "title": {
+            "type": "string"
+        },
+        "body": {
+            "type": "string"
+        },
+        "authorId": {
+            "type": "integer"
+        }
+    }
+}

test-harness/tests/resources/coldboxRest/paths/posts/create/example.200.json

@@ -0,0 +1,17 @@
+{
+    "data": {
+        "id": "1",
+        "title": "Washingtons Newburgh Address",
+        "body": "While I give you these assurances, and pledge myself in the most unequivocal manner, to exert whatever ability I am possessed of, in your favor—let me entreat you, Gentlemen, on your part, not to take any measures, which, viewed in the calm light of reason, will lessen the dignity, & sully the glory you have hitherto maintained—let me request you to rely on the plighted faith of your Country, and place a full confidence in the purity of the intentions of Congress",
+        "author": {
+            "id": "1",
+            "firstName": "George",
+            "lastName": "Washington",
+            "emailAddress": "potus1@gmail.com"
+        }
+    },
+    "messages": [
+        "New Post Created Successfully"
+    ],
+    "error": false
+}

test-harness/tests/resources/coldboxRest/paths/posts/create/requestBody.json

@@ -0,0 +1,3 @@
+{
+    "$ref": "##/components/requestBodies/PostBody"
+}

test-harness/tests/resources/coldboxRest/paths/posts/create/responses.json

@@ -0,0 +1,27 @@
+{
+    "200": {
+        "description": "Success",
+        "content": {
+            "application/json": {
+                "schema": {
+                    "$extend": [ 
+                        {
+                            "$ref": "../../../_schemas/response.json"
+                        }, 
+                        {
+                            "properties": {
+                                "data": {
+                                    "$ref": "##/components/schemas/Post" 
+                                }
+                            }
+                        }   
+                        
+                    ]
+				},
+                "example": {
+					"$ref": "example.200.json"
+				}
+            }
+        }
+	}
+}

test-harness/tests/resources/coldboxRest/paths/posts/posts.json

@@ -10,6 +10,17 @@
             "responses": {
                 "$ref": "index/responses.json"
             }
+        }, 
+        "post": {
+            "summary": "Create a post",
+            "operationId": "posts.create",
+            "tags": ["posts"],
+            "requestBody": {
+                "$ref": "create/requestBody.json"
+            },
+            "responses": {
+                "$ref": "create/responses.json"
+            }
         } 
     },
     "/posts/{id}": {

test-harness/tests/specs/ColdboxSpec.cfc

@@ -45,6 +45,8 @@ component extends="BaseOpenAPISpec"{
 			it( "Can parse the apiDoc", function(){
 				var apiDoc = parseApiDoc();
 
+                debug( serializeJson( apiDoc ) );
+
                 // it can have multiple servers
                 expect( apiDoc ).toHaveKey( "servers" );
                 expect( apiDoc.servers ).toBeArray();
@@ -95,6 +97,10 @@ component extends="BaseOpenAPISpec"{
                     expect( apiDoc.paths[ "/users" ].get.responses[ "200" ].content[ "application/json" ].schema.properties.data.properties.results.items.properties ).toHaveKey( item );
                 }
 
+                // expect the requestBody reference to have one pound sign
+                expect( apiDoc.paths[ "/posts" ].post.requestBody ).toHaveKey( "$ref" );
+                expect( left( apiDoc.paths[ "/posts" ].post.requestBody[ '$ref' ], 2 ) ).toBe( "#chr( 35 )#/" );
+
 			});
 
 		});