Minor documentation adjustments, minor adjustments to unit test framework, added legal and copyright details, fixed bug that prevented client username from showing in change logs, bug fixes for use on pfSense 2.5

Author: Jared Hendrickson

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [2020] [Jared Hendrickson]
+   Copyright [YYYY] [NAME]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -284,9 +284,10 @@ There is no limit to API calls at this time but is important to note that pfSens
 
 * [STATUS/LOG](#statuslog)
 
-  * [Read DHCP Status Log](#1-read-dhcp-status-log)
-  * [Read Firewall Status Log](#2-read-firewall-status-log)
-  * [Read System Status Log](#3-read-system-status-log)
+  * [Read Configuration History Status Log](#1-read-configuration-history-status-log)
+  * [Read DHCP Status Log](#2-read-dhcp-status-log)
+  * [Read Firewall Status Log](#3-read-firewall-status-log)
+  * [Read System Status Log](#4-read-system-status-log)
 
 * [SYSTEM/API](#systemapi)
 
@@ -2762,7 +2763,35 @@ URL: https://{{$hostname}}/api/v1/status/carp
 
 
 
-### 1. Read DHCP Status Log
+### 1. Read Configuration History Status Log
+
+
+Read the configuration history log.<br><br>
+
+_Requires at least one of the following privileges:_ [`page-all`, `page-diagnostics-configurationhistory`]
+
+
+***Endpoint:***
+
+```bash
+Method: GET
+Type: RAW
+URL: https://{{$hostname}}/api/v1/status/log/config_history
+```
+
+
+
+***Body:***
+
+```js        
+{
+
+}
+```
+
+
+
+### 2. Read DHCP Status Log
 
 
 Read the dhcpd.log file.<br><br>
@@ -2790,7 +2819,7 @@ URL: https://{{$hostname}}/api/v1/status/log/dhcp
 
 
 
-### 2. Read Firewall Status Log
+### 3. Read Firewall Status Log
 
 
 Read the filter.log file.<br><br>
@@ -2818,7 +2847,7 @@ URL: https://{{$hostname}}/api/v1/status/log/firewall
 
 
 
-### 3. Read System Status Log
+### 4. Read System Status Log
 
 
 Read the system.log file.<br><br>
@@ -4183,3 +4212,4 @@ URL: https://{{$hostname}}/api/v1/user/privilege
 
 ---
 [Back to top](#pfsense-rest-api-documentation)
+> Made with &#9829; by [thedevsaddam](https://github.com/thedevsaddam) | Generated at: 2020-09-28 16:26:07 by [docgen](https://github.com/thedevsaddam/docgen)

docs/CONTRIBUTING.md

@@ -375,6 +375,14 @@ not support POST requests, you do not need to override this property.
 not support PUT requests, you do not need to override this property. 
 - `delete_payloads` : A list of dictionary formatted API payloads to use when testing DELETE requests. If this endpoint does 
 not support DELETE requests, you do not need to override this property. 
+- `get_responses` : A list of previously executed GET requests in a dictionary format. Failing responses will not be 
+included.
+- `post_responses` : A list of previously executed POST requests in a dictionary format. Failing responses will not be 
+included.
+- `put_responses` : A list of previously executed PUT requests in a dictionary format. Failing responses will not be 
+included.
+- `delete_responses` : A list of previously executed DELETE requests in a dictionary format. Failing responses will not be 
+included.
 
 ```python
 import unit_test_framework
@@ -395,6 +403,20 @@ class NewAPIUnitTest(unit_test_framework.APIUnitTest):
     ]    
 ```
 
+#### Overriding Base Model Methods ####
+There are methods that will assist you when you need to dynamically format API request data. These are typically used 
+when you need to add payload data that is dependent on a previous API response. The following methods may 
+overridden:
+
+- `pre_get()` : Runs before the GET request is made.
+- `post_get()` : Runs after the GET request is made.
+- `pre_post()` : Runs before the POST request is made.
+- `post_post()` : Runs after the POST request is made.
+- `pre_put()` : Runs before the PUT request is made.
+- `post_put()` : Runs after the PUT request is made.
+- `pre_delete()` : Runs before the DELETE request is made.
+- `post_delete()` : Runs after the DELETE request is made.
+
 #### Running Unit Tests ####
 Once you have written your unit test class, you must ensure you create the unit test object at the end of the file
 you've created like so:

docs/documentation.json

@@ -63,10 +63,7 @@
 								],
 								"body": {
 									"mode": "raw",
-									"raw": "{\n    \n}",
-									"options": {
-										"raw": {}
-									}
+									"raw": "{\n    \n}"
 								},
 								"url": {
 									"raw": "https://{{$hostname}}/api/v1/user/auth_server/ldap",
@@ -100,10 +97,7 @@
 								],
 								"body": {
 									"mode": "raw",
-									"raw": "{\n\t\"name\": \"TEST_AUTHSERVER\",\n\t\"host\": \"ldap.com\",\n\t\"ldap_port\": 636,\n\t\"ldap_urltype\": \"encrypted\",\n\t\"ldap_protver\": \"3\",\n\t\"ldap_timeout\": 12,\n\t\"ldap_scope\": \"subtree\",\n\t\"ldap_basedn\": \"dc=test,dc=com\",\n    \"ldap_authcn\": \"ou=people,dc=test,dc=com;ou=groups,dc=test,dc=com\",\n    \"ldap_attr_user\": \"uid\",\n    \"ldap_attr_group\": \"cn\",\n    \"ldap_attr_member\": \"memberof\",\n    \"ldap_attr_groupobj\": \"posixGroup\",\n    \"ldap_binddn\": \"cn=pfsense,dc=test,dc=com\",\n    \"ldap_bindpw\": \"asdf\",\n    \"active\": false\n}",
-									"options": {
-										"raw": {}
-									}
+									"raw": "{\n\t\"name\": \"TEST_AUTHSERVER\",\n\t\"host\": \"ldap.com\",\n\t\"ldap_port\": 636,\n\t\"ldap_urltype\": \"encrypted\",\n\t\"ldap_protver\": \"3\",\n\t\"ldap_timeout\": 12,\n\t\"ldap_scope\": \"subtree\",\n\t\"ldap_basedn\": \"dc=test,dc=com\",\n    \"ldap_authcn\": \"ou=people,dc=test,dc=com;ou=groups,dc=test,dc=com\",\n    \"ldap_attr_user\": \"uid\",\n    \"ldap_attr_group\": \"cn\",\n    \"ldap_attr_member\": \"memberof\",\n    \"ldap_attr_groupobj\": \"posixGroup\",\n    \"ldap_binddn\": \"cn=pfsense,dc=test,dc=com\",\n    \"ldap_bindpw\": \"asdf\",\n    \"active\": false\n}"
 								},
 								"url": {
 									"raw": "https://{{$hostname}}/api/v1/user/auth_server/ldap?name=string&host=string&ldap_port=string or integer&ldap_urltype=string&ldap_protver=string or integer&ldap_scope=string&ldap_basedn=string&ldap_authcn=string&ldap_extended_query=string&ldap_binddn=string&ldap_bindpw=string&ldap_attr_user=string&ldap_attr_group=string&ldap_attr_member=string&ldap_attr_groupobj=string&ldap_utf8=boolean&ldap_timeout=string or integer&active=boolean",
@@ -229,10 +223,7 @@
 								],
 								"body": {
 									"mode": "raw",
-									"raw": "{\n\t\"name\": \"LDAP_AUTHSERVER_0\"\n}",
-									"options": {
-										"raw": {}
-									}
+									"raw": "{\n\t\"name\": \"LDAP_AUTHSERVER_0\"\n}"
 								},
 								"url": {
 									"raw": "https://{{$hostname}}/api/v1/user/auth_server/ldap?name=string",
@@ -273,10 +264,7 @@
 								],
 								"body": {
 									"mode": "raw",
-									"raw": "{\n\t\"name\": \"test\"\n}",
-									"options": {
-										"raw": {}
-									}
+									"raw": "{\n\t\"name\": \"test\"\n}"
 								},
 								"url": {
 									"raw": "https://{{$hostname}}/api/v1/user/auth_server/radius?name=string",
@@ -317,10 +305,7 @@
 								],
 								"body": {
 									"mode": "raw",
-									"raw": "{\n\t\"name\": \"test\"\n}",
-									"options": {
-										"raw": {}
-									}
+									"raw": "{\n\t\"name\": \"test\"\n}"
 								},
 								"url": {
 									"raw": "https://{{$hostname}}/api/v1/user/auth_server?name=string",
@@ -4485,6 +4470,51 @@
 								"description": "Read the dhcpd.log file.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-diagnostics-logs-dhcp`]"
 							},
 							"response": []
+						},
+						{
+							"name": "Read Configuration History Status Log",
+							"protocolProfileBehavior": {
+								"disableBodyPruning": true
+							},
+							"request": {
+								"auth": {
+									"type": "bearer",
+									"bearer": [
+										{
+											"key": "token",
+											"value": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJwZlNlbnNlIiwiZXhwIjoxNTk4MDcwMTAzLCJuYmYiOjE1OTgwNjE3MDMsImRhdGEiOiJhZG1pbiJ9.hgvNu96Bvsehcq6ygTa9LPB8eymiLnxYu4V6J8_h0-o",
+											"type": "string"
+										}
+									]
+								},
+								"method": "GET",
+								"header": [],
+								"body": {
+									"mode": "raw",
+									"raw": "{\n\n}",
+									"options": {
+										"raw": {
+											"language": "json"
+										}
+									}
+								},
+								"url": {
+									"raw": "https://{{$hostname}}/api/v1/status/log/config_history",
+									"protocol": "https",
+									"host": [
+										"{{$hostname}}"
+									],
+									"path": [
+										"api",
+										"v1",
+										"status",
+										"log",
+										"config_history"
+									]
+								},
+								"description": "Read the configuration history log.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-diagnostics-configurationhistory`]"
+							},
+							"response": []
 						}
 					],
 					"description": "API endpoints that read, update and delete pfSense logs.",

pfSense-pkg-API/files/etc/inc/api/endpoints/APIAccessToken.inc

@@ -1,4 +1,18 @@
 <?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 require_once("api/framework/APIEndpoint.inc");
 
 class APIAccessToken extends APIEndpoint {

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallAlias.inc

@@ -1,4 +1,18 @@
 <?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 require_once("api/framework/APIEndpoint.inc");
 
 class APIFirewallAlias extends APIEndpoint {

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallAliasEntry.inc

@@ -1,4 +1,18 @@
 <?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 require_once("api/framework/APIEndpoint.inc");
 
 class APIFirewallAliasEntry extends APIEndpoint {

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNAT.inc

@@ -1,4 +1,18 @@
 <?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 require_once("api/framework/APIEndpoint.inc");
 
 class APIFirewallNAT extends APIEndpoint {

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallNATPortForward.inc

@@ -1,4 +1,18 @@
 <?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 require_once("api/framework/APIEndpoint.inc");
 
 class APIFirewallNATPortForward extends APIEndpoint {

pfSense-pkg-API/files/etc/inc/api/endpoints/APIFirewallRule.inc

@@ -1,4 +1,18 @@
 <?php
+//   Copyright 2020 Jared Hendrickson
+//
+//   Licensed under the Apache License, Version 2.0 (the "License");
+//   you may not use this file except in compliance with the License.
+//   You may obtain a copy of the License at
+//
+//       http://www.apache.org/licenses/LICENSE-2.0
+//
+//   Unless required by applicable law or agreed to in writing, software
+//   distributed under the License is distributed on an "AS IS" BASIS,
+//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//   See the License for the specific language governing permissions and
+//   limitations under the License.
+
 require_once("api/framework/APIEndpoint.inc");
 
 class APIFirewallRule extends APIEndpoint {