upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-05-28 04:02:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

update api docs (using scripts)

Browse source
This commit is contained in:
Ad Schellevis 2023-09-18 13:19:28 +02:00
parent ded92025fc
commit de581eef5c
8 changed files with 145 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
source/development/api/core/dhcpv4.rst Normal file
View file

@ -0,0 +1,19 @@
Dhcpv4
~~~~~~
.. csv-table:: Resources (LeasesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dhcpv4","leases","delLease","$ip"
"``GET``","dhcpv4","leases","searchLease",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dhcpv4","service","reconfigure",""
"``POST``","dhcpv4","service","restart",""
"``POST``","dhcpv4","service","start",""
"``GET``","dhcpv4","service","status",""
"``POST``","dhcpv4","service","stop",""

20
source/development/api/core/dhcpv6.rst Normal file
View file

@ -0,0 +1,20 @@
Dhcpv6
~~~~~~
.. csv-table:: Resources (LeasesController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dhcpv6","leases","delLease","$ip"
"``GET``","dhcpv6","leases","searchLease",""
"``GET``","dhcpv6","leases","searchPrefix",""
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","dhcpv6","service","reconfigure",""
"``POST``","dhcpv6","service","restart",""
"``POST``","dhcpv6","service","start",""
"``GET``","dhcpv6","service","status",""
"``POST``","dhcpv6","service","stop",""

15
source/development/api/core/interfaces.rst
View file

@ -1,6 +1,21 @@
Interfaces
~~~~~~~~~~
.. csv-table:: Resources (LaggSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","interfaces","lagg_settings","addItem",""
"``POST``","interfaces","lagg_settings","delItem","$uuid"
"``GET``","interfaces","lagg_settings","get",""
"``GET``","interfaces","lagg_settings","getItem","$uuid=null"
"``POST``","interfaces","lagg_settings","reconfigure",""
"``*``","interfaces","lagg_settings","searchItem",""
"``POST``","interfaces","lagg_settings","set",""
"``POST``","interfaces","lagg_settings","setItem","$uuid"
"``<<uses>>``", "", "", "", "*model* `Lagg.xml <https://github.com/opnsense/core/blob/master/src/opnsense/mvc/app/models/OPNsense/Interfaces/Lagg.xml>`__"
.. csv-table:: Resources (LoopbackSettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40

2
source/development/api/core/openvpn.rst
View file

@ -34,7 +34,7 @@ Openvpn
"``POST``","openvpn","instances","add",""
"``POST``","openvpn","instances","addStaticKey",""
"``POST``","openvpn","instances","del","$uuid"
"``GET``","openvpn","instances","delStaticKey","$uuid"
"``POST``","openvpn","instances","delStaticKey","$uuid"
"``GET``","openvpn","instances","genKey",""
"``GET``","openvpn","instances","get","$uuid=null"
"``GET``","openvpn","instances","get",""

2
source/development/api/core/unbound.rst
View file

@ -16,7 +16,7 @@ Unbound
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","unbound","overview","Rolling","$timeperiod,$clients=false"
"``GET``","unbound","overview","Rolling","$timeperiod,$clients='0'"
"``GET``","unbound","overview","isBlockListEnabled",""
"``GET``","unbound","overview","isEnabled",""
"``GET``","unbound","overview","searchQueries",""

27
source/development/api/plugins/quagga.rst
View file

@ -62,31 +62,22 @@ Quagga
"``GET``","quagga","diagnostics","bfdcounters",""
"``GET``","quagga","diagnostics","bfdneighbors",""
"``GET``","quagga","diagnostics","bfdsummary",""
"``GET``","quagga","diagnostics","bgpneighbors","$format=""json"""
"``GET``","quagga","diagnostics","bgproute","$format=""json"""
"``GET``","quagga","diagnostics","bgproute4","$format=""json"""
"``GET``","quagga","diagnostics","bgproute6","$format=""json"""
"``GET``","quagga","diagnostics","bgpsummary","$format=""json"""
"``GET``","quagga","diagnostics","generalroute","$format=""json"""
"``GET``","quagga","diagnostics","generalroute4","$format=""json"""
"``GET``","quagga","diagnostics","generalroute6","$format=""json"""
"``GET``","quagga","diagnostics","bgpneighbors",""
"``GET``","quagga","diagnostics","bgpsummary",""
"``GET``","quagga","diagnostics","generalrunningconfig",""
"``GET``","quagga","diagnostics","ospfdatabase","$format=""json"""
"``GET``","quagga","diagnostics","ospfinterface","$format=""json"""
"``GET``","quagga","diagnostics","ospfneighbor","$format=""json"""
"``GET``","quagga","diagnostics","ospfoverview","$format=""json"""
"``GET``","quagga","diagnostics","ospfroute","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3database","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3interface","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3neighbor","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3overview","$format=""json"""
"``GET``","quagga","diagnostics","ospfv3route","$format=""json"""
"``GET``","quagga","diagnostics","ospfdatabase",""
"``GET``","quagga","diagnostics","ospfinterface",""
"``GET``","quagga","diagnostics","ospfoverview",""
"``GET``","quagga","diagnostics","ospfv3interface",""
"``GET``","quagga","diagnostics","ospfv3overview",""
"``GET``","quagga","diagnostics","searchBgproute4",""
"``GET``","quagga","diagnostics","searchBgproute6",""
"``GET``","quagga","diagnostics","searchGeneralroute4",""
"``GET``","quagga","diagnostics","searchGeneralroute6",""
"``GET``","quagga","diagnostics","searchOspfneighbor",""
"``GET``","quagga","diagnostics","searchOspfroute",""
"``GET``","quagga","diagnostics","searchOspfv3database",""
"``GET``","quagga","diagnostics","searchOspfv3route","$format=""json"""
.. csv-table:: Resources (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"

23
source/development/api/plugins/wazuhagent.rst Normal file
View file

@ -0,0 +1,23 @@
Wazuhagent
~~~~~~~~~~
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wazuhagent","service","reconfigure",""
"``POST``","wazuhagent","service","restart",""
"``POST``","wazuhagent","service","start",""
"``GET``","wazuhagent","service","status",""
"``POST``","wazuhagent","service","stop",""
"``<<uses>>``", "", "", "", "*model* `WazuhAgent.xml <https://github.com/opnsense/plugins/blob/master/security/wazuh-agent/src/opnsense/mvc/app/models/OPNsense/WazuhAgent/WazuhAgent.xml>`__"
.. csv-table:: Service (SettingsController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wazuhagent","settings","get",""
"``POST``","wazuhagent","settings","set",""
"``<<uses>>``", "", "", "", "*model* `WazuhAgent.xml <https://github.com/opnsense/plugins/blob/master/security/wazuh-agent/src/opnsense/mvc/app/models/OPNsense/WazuhAgent/WazuhAgent.xml>`__"

57
source/development/api/plugins/wireguard.rst
View file

@ -1,6 +1,60 @@
Wireguard
~~~~~~~~~
.. csv-table:: Resources (ClientController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","client","addClient",""
"``POST``","wireguard","client","delClient","$uuid"
"``GET``","wireguard","client","get",""
"``GET``","wireguard","client","getClient","$uuid=null"
"``*``","wireguard","client","searchClient",""
"``POST``","wireguard","client","set",""
"``POST``","wireguard","client","setClient","$uuid"
"``POST``","wireguard","client","toggleClient","$uuid"
"``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/Client.xml>`__"
.. csv-table:: Service (GeneralController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``GET``","wireguard","general","get",""
"``GET``","wireguard","general","getStatus",""
"``POST``","wireguard","general","set",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ServerController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","server","addServer","$uuid=null"
"``POST``","wireguard","server","delServer","$uuid"
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","getServer","$uuid=null"
"``*``","wireguard","server","searchServer",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
"``POST``","wireguard","server","toggleServer","$uuid"
"``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/Server.xml>`__"
.. csv-table:: Service (ServiceController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``POST``","wireguard","service","start",""
"``GET``","wireguard","service","status",""
"``POST``","wireguard","service","stop",""
"``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard-go/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
.. csv-table:: Resources (ClientController.php)
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
@ -34,6 +88,7 @@ Wireguard
"``POST``","wireguard","server","delServer","$uuid"
"``GET``","wireguard","server","get",""
"``GET``","wireguard","server","getServer","$uuid=null"
"``GET``","wireguard","server","keyPair",""
"``*``","wireguard","server","searchServer",""
"``POST``","wireguard","server","set",""
"``POST``","wireguard","server","setServer","$uuid=null"
@ -45,8 +100,10 @@ Wireguard
:header: "Method", "Module", "Controller", "Command", "Parameters"
:widths: 4, 15, 15, 30, 40
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","reconfigure",""
"``POST``","wireguard","service","restart",""
"``GET``","wireguard","service","show",""
"``GET``","wireguard","service","showconf",""
"``GET``","wireguard","service","showhandshake",""
"``POST``","wireguard","service","start",""