From 14e6cc0f630f1a8d613f681f73349874a649305a Mon Sep 17 00:00:00 2001 From: Nicholas de Jong Date: Sun, 31 May 2020 23:00:24 +1000 Subject: [PATCH] Release 1.4.x --- README.md | 16 ++++++--- pfSense-pkg-FauxAPI/Makefile | 4 +-- .../files/usr/local/pkg/fauxapi.xml | 2 +- .../usr/local/www/fauxapi/admin/about.php | 34 ++++++++++++++----- 4 files changed, 39 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 953e1f9..91bce1d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# FauxAPI - v1.3 -A REST API interface for pfSense 2.3.x and 2.4.x to facilitate devops:- +# FauxAPI - v1.4 +A REST API interface for pfSense 2.3.x, 2.4.x, 2.5.x to facilitate devops:- - https://github.com/ndejong/pfsense_fauxapi Additionally available are a set of [client libraries](#client-libraries) @@ -935,10 +935,11 @@ curl \ The FauxAPI has been developed against the following pfSense versions - **2.3.x** - 2.3.2, 2.3.3, 2.3.4, 2.3.5 - **2.4.x** - 2.4.3, 2.4.4, 2.4.5 + - **2.5.x** - 2.5.0-DEVELOPMENT-amd64-20200527-1410 -FauxAPI has not been tested against 2.3.0 or 2.3.1. Additionally, it is apparent that the pfSense -packaging technique changed significantly prior to 2.3.x so it is unlikely that it will be -backported to anything prior to 2.3.0. +FauxAPI has not been tested against 2.3.0 or 2.3.1. Additionally, it is apparent the pfSense +packaging technique changed significantly prior to 2.3.x so it is unlikely it will be backported +to anything prior to 2.3.0. Testing is reasonable but does not achieve 100% code coverage within the FauxAPI codebase. Two client side test scripts (1x Bash, 1x Python) that both @@ -995,6 +996,11 @@ pfSense test infrastructure if it already exists.* - testing against pfSense 2.3.5 - testing against pfSense 2.4.3 +#### v1.4 - 2020-05-31 + - Added **system_info** function to return various useful system information. + - include include `phpsessionmanager.inc` since it is commonly required in other function calls + - testing against pfSense 2.4.5 + - testing against pfSense 2.5.0 (pfSense-CE-2.5.0-DEVELOPMENT-amd64-20200527-1410.iso) ## FauxAPI License ``` diff --git a/pfSense-pkg-FauxAPI/Makefile b/pfSense-pkg-FauxAPI/Makefile index 998af93..aeed664 100644 --- a/pfSense-pkg-FauxAPI/Makefile +++ b/pfSense-pkg-FauxAPI/Makefile @@ -1,8 +1,8 @@ # $FreeBSD$ PORTNAME= pfSense-pkg-FauxAPI -PORTVERSION= 1.3 -PORTREVISION= 5 +PORTVERSION= 1.4 +PORTREVISION= 1 CATEGORIES= sysutils MASTER_SITES= # empty DISTFILES= # empty diff --git a/pfSense-pkg-FauxAPI/files/usr/local/pkg/fauxapi.xml b/pfSense-pkg-FauxAPI/files/usr/local/pkg/fauxapi.xml index 0662865..d9a576a 100644 --- a/pfSense-pkg-FauxAPI/files/usr/local/pkg/fauxapi.xml +++ b/pfSense-pkg-FauxAPI/files/usr/local/pkg/fauxapi.xml @@ -9,7 +9,7 @@ * - A REST API interface for pfSense to facilitate dev-ops. * - https://github.com/ndejong/pfsense_fauxapi * - * Copyright 2016 Nicholas de Jong + * Copyright 2020 Nicholas de Jong * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. diff --git a/pfSense-pkg-FauxAPI/files/usr/local/www/fauxapi/admin/about.php b/pfSense-pkg-FauxAPI/files/usr/local/www/fauxapi/admin/about.php index b576e97..601923a 100644 --- a/pfSense-pkg-FauxAPI/files/usr/local/www/fauxapi/admin/about.php +++ b/pfSense-pkg-FauxAPI/files/usr/local/www/fauxapi/admin/about.php @@ -45,8 +45,8 @@

-FauxAPI - v1.3

-

A REST API interface for pfSense 2.3.x and 2.4.x to facilitate devops:-

+FauxAPI - v1.4 +

A REST API interface for pfSense 2.3.x, 2.4.x, 2.5.x to facilitate devops:-

@@ -939,10 +939,18 @@ function thus causing all FauxAPI actions to be logged and auditable on a per

Versions and Testing

-

The FauxAPI has been developed against pfSense 2.3.2, 2.3.3, 2.3.4, 2.3.5, 2.4.3, 2.4.4 it has -not (yet) been tested against 2.3.0 or 2.3.1. Further, it is apparent that the pfSense -packaging technique changed significantly prior to 2.3.x so it is unlikely that it will be -backported to anything prior to 2.3.0.

+

The FauxAPI has been developed against the following pfSense versions

+ +

FauxAPI has not been tested against 2.3.0 or 2.3.1. Additionally, it is apparent the pfSense +packaging technique changed significantly prior to 2.3.x so it is unlikely it will be backported +to anything prior to 2.3.0.

Testing is reasonable but does not achieve 100% code coverage within the FauxAPI codebase. Two client side test scripts (1x Bash, 1x Python) that both demonstrate and test all possible server side actions are provided. Under the @@ -1000,15 +1008,23 @@ interface to (partly) address clog /var/log/system.log | grep fauxapi -

  • plenty of dcoumentation fixes and updates
    • -
  • added documentation highlighting features and capabilities that existed without -them being obvious
    • +
  • plenty of documentation fixes and updates
    • +
  • added documentation highlighting features and capabilities that existed but were not +previously obvious
  • added the extras path in the project repo as a better place to keep non-package files, client-libs, examples, build-tools etc
  • testing against pfSense 2.3.5
  • testing against pfSense 2.4.3
    • +

    +v1.4 - 2020-05-31

    +

    FauxAPI License

    Copyright 2016-2020 Nicholas de Jong