Merge pull request #747 from jaredhendrickson13/next_minor

v2.6.0 Features & Fixes

Author: jaredhendrickson13

.github/workflows/build.yml

@@ -57,6 +57,8 @@ jobs:
         include:
           - PFSENSE_VERSION: pfSense-2.8.0-RELEASE
             FREEBSD_ID: freebsd15
+          - PFSENSE_VERSION: pfSense-2.8.1-RELEASE
+            FREEBSD_ID: freebsd15
     steps:
       - uses: actions/checkout@v5
       - uses: actions/download-artifact@v5
@@ -105,6 +107,8 @@ jobs:
         include:
           - PFSENSE_VERSION: pfSense-2.8.0-RELEASE
             FREEBSD_ID: freebsd15
+          - PFSENSE_VERSION: pfSense-2.8.1-RELEASE
+            FREEBSD_ID: freebsd15
     steps:
       - uses: actions/checkout@v5
       - uses: actions/download-artifact@v5
@@ -132,6 +136,8 @@ jobs:
         include:
           - PFSENSE_VERSION: pfSense-2.8.0-RELEASE
             FREEBSD_ID: freebsd15
+          - PFSENSE_VERSION: pfSense-2.8.1-RELEASE
+            FREEBSD_ID: freebsd15
 
     steps:
       - uses: actions/checkout@v5

.github/workflows/release.yml

@@ -28,8 +28,14 @@ jobs:
           # Note: The first item in this matrix must use env.DEFAULT_PFSENSE_VERSION as the PFSENSE_VERSION!
           - FREEBSD_VERSION: FreeBSD-15.0-CURRENT
             PFSENSE_VERSION: "2.8.0"
+          - FREEBSD_VERSION: FreeBSD-15.0-CURRENT
+            PFSENSE_VERSION: "2.8.1"
           - FREEBSD_VERSION: FreeBSD-15.0-CURRENT
             PFSENSE_VERSION: "24.11"
+          - FREEBSD_VERSION: FreeBSD-15.0-CURRENT
+            PFSENSE_VERSION: "25.07"
+          - FREEBSD_VERSION: FreeBSD-15.0-CURRENT
+            PFSENSE_VERSION: "25.07.1"
 
     steps:
       - uses: actions/checkout@v5

README.md

@@ -36,13 +36,13 @@ commands are included below for quick reference.
 Install on pfSense CE:
 
 ```bash
-pkg-static add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.8.0-pkg-RESTAPI.pkg
+pkg-static add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-2.8.1-pkg-RESTAPI.pkg
 ```
 
 Install on pfSense Plus:
 
 ```bash
-pkg-static -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-24.11-pkg-RESTAPI.pkg
+pkg-static -C /dev/null add https://github.com/jaredhendrickson13/pfsense-api/releases/latest/download/pfSense-25.07.1-pkg-RESTAPI.pkg
 ```
 
 > [!WARNING]

composer.lock

@@ -108,6 +108,11 @@ The `tag` property is used to define the [OpenAPI tag](https://swagger.io/docs/s
 for the endpoint. This is used to group related endpoints together in the API documentation. This property is optional 
 and defaults to the first section of the URL after the `/api/v2/` prefix.
 
+### deprecated
+
+The `deprecated` property is used to indicate if the endpoint is deprecated. This property defaults to `false`. When set
+to `true`, the endpoint will be marked as deprecated in applicable documentation and schemas.
+
 ### requires_auth
 
 The `requires_auth` property is used to specify whether the endpoint requires authentication and authorization. This property

docs/BUILDING_CUSTOM_ENDPOINT_CLASSES.md

@@ -1,8 +1,12 @@
 # Common Control Parameters
 
 The API utilizes a set of common parameters to control certain behaviors of API calls. These parameters are available to
-all endpoints and requests, but some endpoints may not support all parameters. Below are the available control
-parameters you can use:
+all endpoints and requests, but some endpoints may not support all parameters.
+
+!!! Note
+    Requests must pass these parameters according to your specific [content type](CONTENT_AND_ACCEPT_TYPES.md). For
+    example, if you are using the `application/json` content-type, these parameters should be included in the JSON body 
+    of your request. Content types cannot be mixed.
 
 ## append
 

docs/COMMON_CONTROL_PARAMETERS.md

@@ -6,6 +6,10 @@ The REST API has been designed to allow multiple content and accept types to be
 
 Content types are used to specify the format of the data being sent in your request. You must specify the content type in the `Content-Type` header of your request. The REST API supports the following content types:
 
+!!! Important
+    Only one content type can be specified per request. Data formats cannot be mixed. For example, a request cannot
+    use both a JSON body and URL query string parameters to send data.
+
 ### application/json
 - MIME Type: `application/json`
 - Description: Use this content type to send JSON data in the body of your request. The data should be formatted as a JSON object or array.