API: plugins, add models for standard templates.

4 years ago · 2ec2ca7e86
parent 6700e6c2ac
commit 2ec2ca7e86
29 changed files with 132 additions and 0 deletions
--- a/source/development/api/plugins/acmeclient.rst
+++ b/source/development/api/plugins/acmeclient.rst
@ -12,6 +12,8 @@ Acmeclient
    "``POST``","acmeclient","accounts","toggle","$uuid,$enabled=null"
    "``POST``","acmeclient","accounts","update","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `AcmeClient.xml <https://github.com/opnsense/plugins/blob/master/security/acme-client/src/opnsense/mvc/app/models/OPNsense/AcmeClient/AcmeClient.xml>`__"
+
 .. csv-table:: Resources (ActionsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -25,6 +27,8 @@ Acmeclient
    "``POST``","acmeclient","actions","toggle","$uuid,$enabled=null"
    "``POST``","acmeclient","actions","update","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `AcmeClient.xml <https://github.com/opnsense/plugins/blob/master/security/acme-client/src/opnsense/mvc/app/models/OPNsense/AcmeClient/AcmeClient.xml>`__"
+
 .. csv-table:: Resources (CertificatesController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -39,6 +43,8 @@ Acmeclient
    "``POST``","acmeclient","certificates","toggle","$uuid,$enabled=null"
    "``POST``","acmeclient","certificates","update","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `AcmeClient.xml <https://github.com/opnsense/plugins/blob/master/security/acme-client/src/opnsense/mvc/app/models/OPNsense/AcmeClient/AcmeClient.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -61,6 +67,8 @@ Acmeclient
    "``GET``","acmeclient","settings","getBindPluginStatus",""
    "``GET``","acmeclient","settings","getGcloudPluginStatus",""

+    "``<<uses>>``", "", "", "", "*model* `AcmeClient.xml <https://github.com/opnsense/plugins/blob/master/security/acme-client/src/opnsense/mvc/app/models/OPNsense/AcmeClient/AcmeClient.xml>`__"
+
 .. csv-table:: Resources (ValidationsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -71,3 +79,5 @@ Acmeclient
    "``*``","acmeclient","validations","search",""
    "``POST``","acmeclient","validations","toggle","$uuid,$enabled=null"
    "``POST``","acmeclient","validations","update","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `AcmeClient.xml <https://github.com/opnsense/plugins/blob/master/security/acme-client/src/opnsense/mvc/app/models/OPNsense/AcmeClient/AcmeClient.xml>`__"
--- a/source/development/api/plugins/bind.rst
+++ b/source/development/api/plugins/bind.rst
@ -12,6 +12,8 @@ Bind
    "``POST``","bind","acl","setAcl","$uuid"
    "``POST``","bind","acl","toggleAcl","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Acl.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Acl.xml>`__"
+
 .. csv-table:: Resources (DomainController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -23,6 +25,8 @@ Bind
    "``POST``","bind","domain","setDomain","$uuid=null"
    "``POST``","bind","domain","toggleDomain","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Domain.xml>`__"
+
 .. csv-table:: Resources (RecordController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -34,8 +38,12 @@ Bind
    "``POST``","bind","record","setRecord","$uuid=null"
    "``POST``","bind","record","toggleRecord","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Record.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/Record.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``GET``","bind","service","dnsbl",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/bind/src/opnsense/mvc/app/models/OPNsense/Bind/General.xml>`__"
--- a/source/development/api/plugins/cicap.rst
+++ b/source/development/api/plugins/cicap.rst
@ -6,3 +6,5 @@ Cicap
   :widths: 4, 15, 15, 30, 40

    "``GET``","cicap","service","checkclamav",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/www/c-icap/src/opnsense/mvc/app/models/OPNsense/CICAP/General.xml>`__"
--- a/source/development/api/plugins/clamav.rst
+++ b/source/development/api/plugins/clamav.rst
@ -8,6 +8,8 @@ Clamav
    "``POST``","clamav","service","freshclam",""
    "``GET``","clamav","service","version",""

+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/General.xml>`__"
+
 .. csv-table:: Resources (UrlController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -18,3 +20,5 @@ Clamav
    "``*``","clamav","url","searchUrl",""
    "``POST``","clamav","url","setUrl","$uuid"
    "``POST``","clamav","url","toggleUrl","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `Url.xml <https://github.com/opnsense/plugins/blob/master/security/clamav/src/opnsense/mvc/app/models/OPNsense/ClamAV/Url.xml>`__"
--- a/source/development/api/plugins/dnscryptproxy.rst
+++ b/source/development/api/plugins/dnscryptproxy.rst
@ -12,6 +12,8 @@ Dnscryptproxy
    "``POST``","dnscryptproxy","cloak","setCloak","$uuid"
    "``POST``","dnscryptproxy","cloak","toggleCloak","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Cloak.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Cloak.xml>`__"
+
 .. csv-table:: Resources (ForwardController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -23,6 +25,8 @@ Dnscryptproxy
    "``POST``","dnscryptproxy","forward","setForward","$uuid"
    "``POST``","dnscryptproxy","forward","toggleForward","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Forward.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Forward.xml>`__"
+
 .. csv-table:: Resources (ServerController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -34,12 +38,16 @@ Dnscryptproxy
    "``POST``","dnscryptproxy","server","setServer","$uuid"
    "``POST``","dnscryptproxy","server","toggleServer","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Server.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``GET``","dnscryptproxy","service","dnsbl",""

+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/General.xml>`__"
+
 .. csv-table:: Resources (WhitelistController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -50,3 +58,5 @@ Dnscryptproxy
    "``*``","dnscryptproxy","whitelist","searchWhitelist",""
    "``POST``","dnscryptproxy","whitelist","setWhitelist","$uuid"
    "``POST``","dnscryptproxy","whitelist","toggleWhitelist","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `Whitelist.xml <https://github.com/opnsense/plugins/blob/master/dns/dnscrypt-proxy/src/opnsense/mvc/app/models/OPNsense/Dnscryptproxy/Whitelist.xml>`__"
--- a/source/development/api/plugins/freeradius.rst
+++ b/source/development/api/plugins/freeradius.rst
@ -12,6 +12,8 @@ Freeradius
    "``POST``","freeradius","avpair","setAvpair","$uuid"
    "``POST``","freeradius","avpair","toggleAvpair","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Avpair.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Avpair.xml>`__"
+
 .. csv-table:: Resources (ClientController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -25,6 +27,8 @@ Freeradius
    "``POST``","freeradius","client","setClient","$uuid"
    "``GET``","freeradius","client","toggleClient","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Client.xml>`__"
+
 .. csv-table:: Resources (DhcpController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -36,6 +40,8 @@ Freeradius
    "``POST``","freeradius","dhcp","setDhcp","$uuid"
    "``POST``","freeradius","dhcp","toggleDhcp","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Dhcp.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Dhcp.xml>`__"
+
 .. csv-table:: Resources (EapController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -61,6 +67,8 @@ Freeradius
    "``POST``","freeradius","lease","setLease","$uuid"
    "``POST``","freeradius","lease","toggleLease","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Lease.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/Lease.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -83,3 +91,5 @@ Freeradius
    "``POST``","freeradius","user","set",""
    "``POST``","freeradius","user","setUser","$uuid"
    "``GET``","freeradius","user","toggleUser","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `User.xml <https://github.com/opnsense/plugins/blob/master/net/freeradius/src/opnsense/mvc/app/models/OPNsense/Freeradius/User.xml>`__"
--- a/source/development/api/plugins/gridexample.rst
+++ b/source/development/api/plugins/gridexample.rst
@ -11,3 +11,5 @@ Gridexample
    "``*``","gridexample","settings","searchItem",""
    "``POST``","gridexample","settings","setItem","$uuid"
    "``POST``","gridexample","settings","toggleItem","$uuid,$enabled=null"
+
+    "``<<uses>>``", "", "", "", "*model* `GridExample.xml <https://github.com/opnsense/plugins/blob/master/devel/grid_example/src/opnsense/mvc/app/models/OPNsense/GridExample/GridExample.xml>`__"
--- a/source/development/api/plugins/haproxy.rst
+++ b/source/development/api/plugins/haproxy.rst
@ -7,6 +7,8 @@ Haproxy

    "``GET``","haproxy","service","configtest",""

+    "``<<uses>>``", "", "", "", "*model* `HAProxy.xml <https://github.com/opnsense/plugins/blob/master/net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml>`__"
+
 .. csv-table:: Resources (SettingsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -79,6 +81,8 @@ Haproxy
    "``POST``","haproxy","settings","toggleServer","$uuid,$enabled=null"
    "``POST``","haproxy","settings","toggleUser","$uuid,$enabled=null"

+    "``<<uses>>``", "", "", "", "*model* `HAProxy.xml <https://github.com/opnsense/plugins/blob/master/net/haproxy/src/opnsense/mvc/app/models/OPNsense/HAProxy/HAProxy.xml>`__"
+
 .. csv-table:: Resources (StatisticsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
--- a/source/development/api/plugins/iperf.rst
+++ b/source/development/api/plugins/iperf.rst
@ -8,6 +8,8 @@ Iperf
    "``GET``","iperf","instance","query",""
    "``GET``","iperf","instance","set",""

+    "``<<uses>>``", "", "", "", "*model* `FakeInstance.xml <https://github.com/opnsense/plugins/blob/master/benchmarks/iperf/src/opnsense/mvc/app/models/OPNsense/iperf/FakeInstance.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
--- a/source/development/api/plugins/lldpd.rst
+++ b/source/development/api/plugins/lldpd.rst
@ -6,3 +6,5 @@ Lldpd
   :widths: 4, 15, 15, 30, 40

    "``GET``","lldpd","service","neighbor",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/lldpd/src/opnsense/mvc/app/models/OPNsense/Lldpd/General.xml>`__"
--- a/source/development/api/plugins/netsnmp.rst
+++ b/source/development/api/plugins/netsnmp.rst
@ -11,3 +11,5 @@ Netsnmp
    "``*``","netsnmp","user","searchUser",""
    "``POST``","netsnmp","user","setUser","$uuid"
    "``POST``","netsnmp","user","toggleUser","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `User.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/net-snmp/src/opnsense/mvc/app/models/OPNsense/Netsnmp/User.xml>`__"
--- a/source/development/api/plugins/nginx.rst
+++ b/source/development/api/plugins/nginx.rst
@ -8,6 +8,8 @@ Nginx
    "``POST``","nginx","bans","delban","$uuid"
    "``*``","nginx","bans","searchban",""

+    "``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"
+
 .. csv-table:: Resources (LogsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -27,6 +29,8 @@ Nginx
    "``GET``","nginx","service","stop",""
    "``GET``","nginx","service","vts",""

+    "``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"
+
 .. csv-table:: Resources (SettingsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -122,3 +126,5 @@ Nginx
    "``POST``","nginx","settings","setupstream","$uuid"
    "``POST``","nginx","settings","setupstreamserver","$uuid"
    "``POST``","nginx","settings","setuserlist","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `Nginx.xml <https://github.com/opnsense/plugins/blob/master/www/nginx/src/opnsense/mvc/app/models/OPNsense/Nginx/Nginx.xml>`__"
--- a/source/development/api/plugins/nrpe.rst
+++ b/source/development/api/plugins/nrpe.rst
@ -11,3 +11,5 @@ Nrpe
    "``*``","nrpe","command","searchCommand",""
    "``POST``","nrpe","command","setCommand","$uuid"
    "``POST``","nrpe","command","toggleCommand","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `Command.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/nrpe/src/opnsense/mvc/app/models/OPNsense/Nrpe/Command.xml>`__"
--- a/source/development/api/plugins/ntopng.rst
+++ b/source/development/api/plugins/ntopng.rst
@ -6,3 +6,5 @@ Ntopng
   :widths: 4, 15, 15, 30, 40

    "``GET``","ntopng","service","checkredis",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/ntopng/src/opnsense/mvc/app/models/OPNsense/Ntopng/General.xml>`__"
--- a/source/development/api/plugins/postfix.rst
+++ b/source/development/api/plugins/postfix.rst
@ -12,6 +12,8 @@ Postfix
    "``POST``","postfix","address","setAddress","$uuid"
    "``POST``","postfix","address","toggleAddress","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Address.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Address.xml>`__"
+
 .. csv-table:: Resources (DomainController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -23,6 +25,8 @@ Postfix
    "``POST``","postfix","domain","setDomain","$uuid"
    "``POST``","postfix","domain","toggleDomain","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Domain.xml>`__"
+
 .. csv-table:: Resources (RecipientController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -34,6 +38,8 @@ Postfix
    "``POST``","postfix","recipient","setRecipient","$uuid"
    "``POST``","postfix","recipient","toggleRecipient","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Recipient.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Recipient.xml>`__"
+
 .. csv-table:: Resources (RecipientbccController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -45,6 +51,8 @@ Postfix
    "``POST``","postfix","recipientbcc","setRecipientbcc","$uuid"
    "``POST``","postfix","recipientbcc","toggleRecipientbcc","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Recipientbcc.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Recipientbcc.xml>`__"
+
 .. csv-table:: Resources (SenderController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -56,6 +64,8 @@ Postfix
    "``POST``","postfix","sender","setSender","$uuid"
    "``POST``","postfix","sender","toggleSender","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Sender.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Sender.xml>`__"
+
 .. csv-table:: Resources (SenderbccController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -67,6 +77,8 @@ Postfix
    "``POST``","postfix","senderbcc","setSenderbcc","$uuid"
    "``POST``","postfix","senderbcc","toggleSenderbcc","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Senderbcc.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Senderbcc.xml>`__"
+
 .. csv-table:: Resources (SendercanonicalController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -78,9 +90,13 @@ Postfix
    "``POST``","postfix","sendercanonical","setSendercanonical","$uuid"
    "``POST``","postfix","sendercanonical","toggleSendercanonical","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Sendercanonical.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/Sendercanonical.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40

    "``GET``","postfix","service","checkrspamd",""
    "``POST``","postfix","service","reconfigure",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/mail/postfix/src/opnsense/mvc/app/models/OPNsense/Postfix/General.xml>`__"
--- a/source/development/api/plugins/proxyuseracl.rst
+++ b/source/development/api/plugins/proxyuseracl.rst
@ -11,3 +11,5 @@ Proxyuseracl
    "``GET``","proxyuseracl","settings","searchACL",""
    "``POST``","proxyuseracl","settings","setACL","$uuid"
    "``POST``","proxyuseracl","settings","updownACL","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `ProxyUserACL.xml <https://github.com/opnsense/plugins/blob/master/www/web-proxy-useracl/src/opnsense/mvc/app/models/OPNsense/ProxyUserACL/ProxyUserACL.xml>`__"
--- a/source/development/api/plugins/quagga.rst
+++ b/source/development/api/plugins/quagga.rst
@ -30,6 +30,8 @@ Quagga
    "``POST``","quagga","bgp","togglePrefixlist","$uuid"
    "``POST``","quagga","bgp","toggleRoutemap","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `BGP.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/BGP.xml>`__"
+
 .. csv-table:: Resources (DiagnosticsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -69,6 +71,8 @@ Quagga
    "``POST``","quagga","ospf6settings","setInterface","$uuid"
    "``POST``","quagga","ospf6settings","toggleInterface","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `OSPF6.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/OSPF6.xml>`__"
+
 .. csv-table:: Resources (OspfsettingsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -98,6 +102,8 @@ Quagga
    "``POST``","quagga","ospfsettings","togglePrefixlist","$uuid"
    "``POST``","quagga","ospfsettings","toggleRoutemap","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `OSPF.xml <https://github.com/opnsense/plugins/blob/master/net/frr/src/opnsense/mvc/app/models/OPNsense/Quagga/OSPF.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
--- a/source/development/api/plugins/redis.rst
+++ b/source/development/api/plugins/redis.rst
@ -6,3 +6,5 @@ Redis
   :widths: 4, 15, 15, 30, 40

    "``GET``","redis","service","resetdb",""
+
+    "``<<uses>>``", "", "", "", "*model* `Redis.xml <https://github.com/opnsense/plugins/blob/master/databases/redis/src/opnsense/mvc/app/models/OPNsense/Redis/Redis.xml>`__"
--- a/source/development/api/plugins/relayd.rst
+++ b/source/development/api/plugins/relayd.rst
@ -8,6 +8,8 @@ Relayd
    "``POST``","relayd","service","configtest",""
    "``POST``","relayd","service","reconfigure",""

+    "``<<uses>>``", "", "", "", "*model* `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"
+
 .. csv-table:: Resources (SettingsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -18,6 +20,8 @@ Relayd
    "``POST``","relayd","settings","search","$nodeType=null"
    "``POST``","relayd","settings","set","$nodeType=null,$uuid=null"

+    "``<<uses>>``", "", "", "", "*model* `Relayd.xml <https://github.com/opnsense/plugins/blob/master/net/relayd/src/opnsense/mvc/app/models/OPNsense/Relayd/Relayd.xml>`__"
+
 .. csv-table:: Resources (StatusController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
--- a/source/development/api/plugins/siproxd.rst
+++ b/source/development/api/plugins/siproxd.rst
@ -14,6 +14,8 @@ Siproxd
    "``POST``","siproxd","domain","setDomain","$uuid"
    "``GET``","siproxd","domain","toggleDomain","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Domain.xml <https://github.com/opnsense/plugins/blob/master/net/siproxd/src/opnsense/mvc/app/models/OPNsense/Siproxd/Domain.xml>`__"
+
 .. csv-table:: Resources (GeneralController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -44,3 +46,5 @@ Siproxd
    "``POST``","siproxd","user","set",""
    "``POST``","siproxd","user","setUser","$uuid"
    "``GET``","siproxd","user","toggleUser","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `User.xml <https://github.com/opnsense/plugins/blob/master/net/siproxd/src/opnsense/mvc/app/models/OPNsense/Siproxd/User.xml>`__"
--- a/source/development/api/plugins/telegraf.rst
+++ b/source/development/api/plugins/telegraf.rst
@ -26,6 +26,8 @@ Telegraf
    "``POST``","telegraf","key","setKey","$uuid"
    "``POST``","telegraf","key","toggleKey","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Key.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/telegraf/src/opnsense/mvc/app/models/OPNsense/Telegraf/Key.xml>`__"
+
 .. csv-table:: Resources (OutputController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
--- a/source/development/api/plugins/tinc.rst
+++ b/source/development/api/plugins/tinc.rst
@ -24,3 +24,5 @@ Tinc
    "``POST``","tinc","settings","setNetwork","$uuid=null"
    "``POST``","tinc","settings","toggleHost","$uuid,$enabled=null"
    "``POST``","tinc","settings","toggleNetwork","$uuid,$enabled=null"
+
+    "``<<uses>>``", "", "", "", "*model* `Tinc.xml <https://github.com/opnsense/plugins/blob/master/security/tinc/src/opnsense/mvc/app/models/OPNsense/Tinc/Tinc.xml>`__"
--- a/source/development/api/plugins/tor.rst
+++ b/source/development/api/plugins/tor.rst
@ -12,6 +12,8 @@ Tor
    "``POST``","tor","exitacl","setacl","$uuid"
    "``POST``","tor","exitacl","toggleacl","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `ACLExitPolicy.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/ACLExitPolicy.xml>`__"
+
 .. csv-table:: Resources (GeneralController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -24,6 +26,8 @@ Tor
    "``POST``","tor","general","sethidservauth","$uuid"
    "``POST``","tor","general","togglehidservauth","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/General.xml>`__"
+
 .. csv-table:: Service (HiddenserviceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -35,6 +39,8 @@ Tor
    "``POST``","tor","hiddenservice","setservice","$uuid"
    "``POST``","tor","hiddenservice","toggleservice","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `HiddenService.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/HiddenService.xml>`__"
+
 .. csv-table:: Service (HiddenserviceaclController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -46,6 +52,8 @@ Tor
    "``POST``","tor","hiddenserviceacl","setacl","$uuid"
    "``POST``","tor","hiddenserviceacl","toggleacl","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `HiddenServiceACL.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/HiddenServiceACL.xml>`__"
+
 .. csv-table:: Service (ServiceController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -69,3 +77,5 @@ Tor
    "``*``","tor","socksacl","searchacl",""
    "``POST``","tor","socksacl","setacl","$uuid"
    "``POST``","tor","socksacl","toggleacl","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `ACLSocksPolicy.xml <https://github.com/opnsense/plugins/blob/master/security/tor/src/opnsense/mvc/app/models/OPNsense/Tor/ACLSocksPolicy.xml>`__"
--- a/source/development/api/plugins/unboundplus.rst
+++ b/source/development/api/plugins/unboundplus.rst
@ -7,3 +7,5 @@ Unboundplus

    "``GET``","unboundplus","service","dnsbl",""
    "``GET``","unboundplus","service","reloadunbound",""
+
+    "``<<uses>>``", "", "", "", "*model* `Dnsbl.xml <https://github.com/opnsense/plugins/blob/master/dns/unbound-plus/src/opnsense/mvc/app/models/OPNsense/Unboundplus/Dnsbl.xml>`__"
--- a/source/development/api/plugins/vnstat.rst
+++ b/source/development/api/plugins/vnstat.rst
@ -9,3 +9,5 @@ Vnstat
    "``GET``","vnstat","service","hourly",""
    "``GET``","vnstat","service","monthly",""
    "``GET``","vnstat","service","resetdb",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/vnstat/src/opnsense/mvc/app/models/OPNsense/Vnstat/General.xml>`__"
--- a/source/development/api/plugins/wireguard.rst
+++ b/source/development/api/plugins/wireguard.rst
@ -12,6 +12,8 @@ Wireguard
    "``POST``","wireguard","client","setClient","$uuid"
    "``POST``","wireguard","client","toggleClient","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Client.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/Client.xml>`__"
+
 .. csv-table:: Resources (ServerController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -23,9 +25,13 @@ Wireguard
    "``POST``","wireguard","server","setServer","$uuid=null"
    "``POST``","wireguard","server","toggleServer","$uuid"

+    "``<<uses>>``", "", "", "", "*model* `Server.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/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

    "``GET``","wireguard","service","showconf",""
    "``GET``","wireguard","service","showhandshake",""
+
+    "``<<uses>>``", "", "", "", "*model* `General.xml <https://github.com/opnsense/plugins/blob/master/net/wireguard/src/opnsense/mvc/app/models/OPNsense/Wireguard/General.xml>`__"
--- a/source/development/api/plugins/wol.rst
+++ b/source/development/api/plugins/wol.rst
@ -13,3 +13,5 @@ Wol
    "``POST``","wol","wol","set",""
    "``POST``","wol","wol","setHost","$uuid"
    "``POST``","wol","wol","wakeall",""
+
+    "``<<uses>>``", "", "", "", "*model* `Wol.xml <https://github.com/opnsense/plugins/blob/master/net/wol/src/opnsense/mvc/app/models/OPNsense/Wol/Wol.xml>`__"
--- a/source/development/api/plugins/zabbixagent.rst
+++ b/source/development/api/plugins/zabbixagent.rst
@ -17,3 +17,5 @@ Zabbixagent
    "``POST``","zabbixagent","settings","setUserparameter","$uuid"
    "``POST``","zabbixagent","settings","toggleAlias","$uuid"
    "``POST``","zabbixagent","settings","toggleUserparameter","$uuid"
+
+    "``<<uses>>``", "", "", "", "*model* `ZabbixAgent.xml <https://github.com/opnsense/plugins/blob/master/net-mgmt/zabbix-agent/src/opnsense/mvc/app/models/OPNsense/ZabbixAgent/ZabbixAgent.xml>`__"
--- a/source/development/api/plugins/zerotier.rst
+++ b/source/development/api/plugins/zerotier.rst
@ -13,6 +13,8 @@ Zerotier
    "``POST``","zerotier","network","set","$uuid=null"
    "``POST``","zerotier","network","toggle","$uuid=null"

+    "``<<uses>>``", "", "", "", "*model* `Zerotier.xml <https://github.com/opnsense/plugins/blob/master/net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Zerotier.xml>`__"
+
 .. csv-table:: Resources (SettingsController.php)
   :header: "Method", "Module", "Controller", "Command", "Parameters"
   :widths: 4, 15, 15, 30, 40
@ -20,3 +22,5 @@ Zerotier
    "``GET``","zerotier","settings","get",""
    "``POST``","zerotier","settings","set",""
    "``GET``","zerotier","settings","status",""
+
+    "``<<uses>>``", "", "", "", "*model* `Zerotier.xml <https://github.com/opnsense/plugins/blob/master/net/zerotier/src/opnsense/mvc/app/models/OPNsense/Zerotier/Zerotier.xml>`__"