v3.1.3

.github/workflows/pr.yml

@@ -18,7 +18,7 @@ jobs:
 
   formatCheck:
     name: Checks Source Code Formatting
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3

.github/workflows/release.yml

@@ -16,7 +16,7 @@ on:
         type: boolean
 
 env:
-  MODULE_ID: cbSwagger
+  MODULE_ID: cbswagger
   SNAPSHOT: ${{ inputs.snapshot || false }}
 
 jobs:
@@ -25,7 +25,7 @@ jobs:
   ##########################################################################################
   build:
     name: Build & Publish
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
@@ -133,7 +133,7 @@ jobs:
   prep_next_release:
     name: Prep Next Release
     if: github.ref == 'refs/heads/main'
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     needs: [build]
     steps:
       # Checkout development

.github/workflows/snapshot.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - 'development'
+  workflow_dispatch:
 
 jobs:
   ##########################################################################################
@@ -18,7 +19,7 @@ jobs:
   ##########################################################################################
   format:
     name: Code Auto-Formatting
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v3
 

.github/workflows/tests.yml

@@ -10,15 +10,18 @@ on:
 jobs:
   tests:
     name: Tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-24.04
+    defaults:
+      run:
+        working-directory: ${{ github.workspace }}/cbswagger
     env:
       DB_USER: root
       DB_PASSWORD: root
     strategy:
       fail-fast: false
       matrix:
-        cfengine: [ "lucee@5", "adobe@2018", "adobe@2021" ]
-        coldboxVersion: [ "^6.0.0" ]
+        cfengine: [ "lucee@5", "lucee@6" ,"adobe@2018", "adobe@2021" ]
+        coldboxVersion: [ "^6.0.0", "^7.0.0" ]
         experimental: [ false ]
         include:
           - cfengine: "adobe@2023"
@@ -31,11 +34,16 @@ jobs:
             cfengine: "adobe@2018"
             experimental: true
           - coldboxVersion: "be"
-            cfengine: "adobe@2021"
+            cfengine: "adobe@2023"
+            experimental: true
+          - coldboxVersion: "be"
+            cfengine: "boxlang@1"
             experimental: true
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
+        with:
+          path: cbswagger
 
       # - name: Setup Database and Fixtures
       #   run: |
@@ -69,6 +77,7 @@ jobs:
 
       - name: Install Test Harness with ColdBox ${{ matrix.coldboxVersion }}
         run: |
+          box install commandbox-boxlang --force
           box install
           cd test-harness
           box package set dependencies.coldbox=${{ matrix.coldboxVersion }}
@@ -88,16 +97,16 @@ jobs:
         uses: EnricoMi/publish-unit-test-result-action@v2
         if: always()
         with:
-          junit_files: test-harness/tests/results/**/*.xml
+          junit_files: ${{ github.workspace }}/cbswagger/test-harness/tests/results/**/*.xml
           check_name: "${{ matrix.cfengine }} ColdBox ${{ matrix.coldboxVersion }} Test Results"
 
       - name: Upload Test Results to Artifacts
         if: always()
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: test-results-${{ matrix.cfengine }}-${{ matrix.coldboxVersion }}
           path: |
-            test-harness/tests/results/**/*
+            ${{ github.workspace }}/cbswagger/test-harness/tests/results/**/*
 
       - name: Show Server Log On Failures
         if: ${{ failure() }}
@@ -106,12 +115,12 @@ jobs:
 
       - name: Upload Debug Logs To Artifacts
         if: ${{ failure() }}
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: Failure Debugging Info - ${{ matrix.cfengine }} - ${{ matrix.coldboxVersion }}
           path: |
-            .engine/**/logs/*
-            .engine/**/WEB-INF/cfusion/logs/*
+            ${{ github.workspace }}/cbswagger/.engine/**/logs/*
+            ${{ github.workspace }}/cbswagger/.engine/**/WEB-INF/cfusion/logs/*
 
       - name: Slack Notifications
         # Only on failures and NOT in pull requests

.vscode/settings.json

@@ -11,7 +11,7 @@
 			"isPhysicalDirectoryPath": false
 		},
 		{
-			"logicalPath": "/cbSwagger",
+			"logicalPath": "/cbswagger",
 			"directoryPath": "./",
 			"isPhysicalDirectoryPath": false
 		}

ModuleConfig.cfc

@@ -7,14 +7,14 @@
 component {
 
 	// Module Properties
-	this.title          = "cbSwagger";
+	this.title          = "cbswagger";
 	this.author         = "Jon Clausen <[email protected]>";
-	this.webURL         = "https://github.com/coldbox-modules/cbSwagger";
+	this.webURL         = "https://github.com/coldbox-modules/cbswagger";
 	this.version        = "@version.number@[email protected]@";
 	this.description    = "A coldbox module to auto-generate Swagger API documentation from your configured routes";
-	this.entryPoint     = "cbSwagger";
-	this.modelNamespace = "cbSwagger";
-	this.cfmapping      = "cbSwagger";
+	this.entryPoint     = "cbswagger";
+	this.modelNamespace = "cbswagger";
+	this.cfmapping      = "cbswagger";
 	this.autoMapModels  = true;
 	this.dependencies   = [ "swagger-sdk" ];
 
@@ -75,7 +75,7 @@ component {
 			// A list of tags used by the specification with additional metadata.
 			// https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#tagObject
 			"tags"         : [],
-			// Whether to enable endpoint and parsed doc caching by cbSwagger
+			// Whether to enable endpoint and parsed doc caching by cbswagger
 			"cacheEnabled" : true
 		};
 

box.json

@@ -1,18 +1,18 @@
 {
-    "name":"cbSwagger",
-    "version":"3.1.2",
+    "name":"cbswagger",
+    "version":"3.1.3",
     "location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cbswagger/@build.version@/[email protected]@.zip",
     "author":"Ortus Solutions, Corp",
-    "slug":"cbSwagger",
+    "slug":"cbswagger",
     "type":"modules",
     "keywords":"Swagger,OpenAPI,API Docs",
-    "homepage":"https://github.com/coldbox-modules/cbSwagger",
-    "documentation":"https://github.com/coldbox-modules/cbSwagger/wiki",
+    "homepage":"https://github.com/coldbox-modules/cbswagger",
+    "documentation":"https://github.com/coldbox-modules/cbswagger/wiki",
     "repository":{
         "type":"git",
-        "url":"https://github.com/coldbox-modules/cbSwagger"
+        "url":"https://github.com/coldbox-modules/cbswagger"
     },
-    "bugs":"https://github.com/coldbox-modules/cbSwagger/issues",
+    "bugs":"https://github.com/coldbox-modules/cbswagger/issues",
     "shortDescription":"A Coldbox Module which automatically generates api documentation from your configured SES routes",
     "license":[
         {

build/.travis.yml

@@ -5,7 +5,7 @@ notifications:
 env:
   # Fill out these global variables for build process
   global:
-    - MODULE_ID=cbSwagger
+    - MODULE_ID=cbswagger
   matrix:
     - ENGINE=lucee@5
     - ENGINE=adobe@2016

changelog.md

@@ -25,19 +25,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
-- Interaction to WireBox via base test case and not application scope
-- Removed support for Adobe Coldfusion 2016
-- Removes `default` key from response object if empty and other status code keys are present [Issue #28](https://github.com/coldbox-modules/cbSwagger/issues/28)
+* Interaction to WireBox via base test case and not application scope
+* Removed support for Adobe Coldfusion 2016
+* Removes `default` key from response object if empty and other status code keys are present [Issue #28](https://github.com/coldbox-modules/cbswagger/issues/28)
 
 ### Added
 
-- Virtual application testing
-- Updated github actions
-- Updated module template provisions
-- Added support for samples path shortcut annotation (`~`) in annotation JSON `$ref` pointers
-- Added support for using globbing patterns in `excludeRoutes` array. [Issue #37](https://github.com/coldbox-modules/cbSwagger/issues/37)
-- Added `cbswagger` endpoint caching ( defaults to `true` ) and `cacheEnabled` setting.
-- Added URL convention for clearing/bypassing endpoint cache ( `swaggerCache=false` )
+* Virtual application testing
+* Updated github actions
+* Updated module template provisions
+* Added support for samples path shortcut annotation (`~`) in annotation JSON `$ref` pointers
+* Added support for using globbing patterns in `excludeRoutes` array. [Issue #37](https://github.com/coldbox-modules/cbswagger/issues/37)
+* Added `cbswagger` endpoint caching ( defaults to `true` ) and `cacheEnabled` setting.
+* Added URL convention for clearing/bypassing endpoint cache ( `swaggerCache=false` )
 
 ## [2.7.0] => 2021-OCT-1
 
@@ -113,6 +113,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `feature`: Upgraded to swagger-sdk 2.0.0 to support OpenAPI 3.0.x. A great guide on migrating is here: <https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/>
 
+
 - Migrated `cbSwagger` settings to the `moduleSettings` struct instead of top-level in the `config/ColdBox.cfc`. Make sure you move your settings.
 
 - `feature` : You can now pass a `format` to the `/cbSwagger` endpoint to either get the OpenAPI doc as `json` or `yml`. Eg: `/cbswagger?format=yml`
@@ -200,4 +201,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [3.1.1]: https://github.com/coldbox-modules/cbSwagger/compare/v3.1.0...v3.1.1
 
-[3.0.0]: https://github.com/coldbox-modules/cbSwagger/compare/5be045e7bd456304f3e338fd5e4f5ca94342dad0...v3.0.0
+[3.0.0]: https://github.com/coldbox-modules/cbswagger/compare/5be045e7bd456304f3e338fd5e4f5ca94342dad0...v3.0.0