Skip to content

Commit 772a828

Browse files
docs: add extra help text for /api/v2/vpn/openvpn/client_export
1 parent 64a14cb commit 772a828

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

pfSense-pkg-RESTAPI/files/usr/local/pkg/RESTAPI/Endpoints/VPNOpenVPNClientExportEndpoint.inc

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,14 @@ class VPNOpenVPNClientExportEndpoint extends Endpoint {
2121

2222
# Set help texts
2323
$this->post_help_text =
24-
'Export an OpenVPN Client configuration. Before using this endpoint, you must define ' .
25-
'a default export configuration for your OpenVPN server(s) using the the endpoint at ' .
26-
'/api/v2/openvpn/vpn/client_export/config as you will need its ID to use this endpoint. ' .
27-
'Any specific configurations made to this endpoint will override the default configurations, ' .
28-
'but will not store them in the pfSense configuration.';
24+
"Export an OpenVPN Client configuration.\n\n" .
25+
'Before using this endpoint, you must define a default export configuration for your ' .
26+
'OpenVPN server(s) using the the endpoint at /api/v2/openvpn/vpn/client_export/config ' .
27+
'as you will need its ID to use this endpoint. Any specific configurations made to this ' .
28+
'endpoint will override the default configurations, but will not store them in the pfSense ' .
29+
"configuration.\n\n" .
30+
"Exports of exe, zip and other binary file types MUST use the 'application/octet-stream' accept " .
31+
'type as their data is not serializable.';
2932

3033
# Construct the parent Endpoint object
3134
parent::__construct();

0 commit comments

Comments
 (0)