Merge branch 'add-missing-aps-remote-documentation' into 'stable-3.1'

Marius Burkard · Marius Burkard · commit c7cc5186a29a · 2019-09-02T16:27:34.000+02:00
Add missing API doc for sites_aps_change_package_status

See merge request ispconfig/ispconfig3!917
diff --git a/remoting_client/API-docs/navigation.html b/remoting_client/API-docs/navigation.html
@@ -2,11 +2,11 @@
 <html><head>
   <title>ISCPConfig 3 API Functions</title>
 
-  
-  
+
+
   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 
-  
+
   <style type="text/css">
 <!--
 .command {
@@ -200,6 +200,7 @@ <h3>S</h3>
 <p><a href="server_get_php_versions.html" target="content">server_get_php_versions</a></p>
 <p><a href="server_get_serverid_by_ip.html" target="content">server_get_serverid_by_ip</a></p>
 <p><a href="sites_aps_available_packages_list.html" target="content">sites_aps_available_packages_list</a></p>
+<p><a href="sites_aps_change_package_status.html" target="content">sites_aps_change_package_status</a></p>
 <p><a href="sites_aps_get_package_details.html" target="content">sites_aps_get_package_details</a></p>
 <p><a href="sites_aps_get_package_file.html" target="content">sites_aps_get_package_file</a></p>
 <p><a href="sites_aps_get_package_settings.html" target="content">sites_aps_get_package_settings</a></p>
diff --git a/remoting_client/API-docs/sites_aps_change_package_status.html b/remoting_client/API-docs/sites_aps_change_package_status.html
@@ -0,0 +1,29 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html><head><title>ISPConfig 3 remote API documentation</title>
+
+
+
+
+
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+  <link rel="stylesheet" type="text/css" href="definitionen.css">
+  <style type="text/css">
+  </style></head>
+
+<body>
+<div style="padding:40px">
+<h1>sites_aps_change_package_status(<span class="var">$session_id</span>, <span class="var">$primary_id</span>, <span class="var">$params</span>);</h1>
+<br>
+<p class="headgrp">Description: </p>
+<p class="margin"> Changes the status for specified APS package. Supply the APS package ID in $primary_id.</p><br>
+<p class="headgrp">Input Variables: </p>
+<p class="margin"> <span class="var">$session_id</span>, <span class="var">$primary_id</span>, <span class="var">$params</span></p>
+<p class="headgrp">Parameters (in <span class="var">$params</span>): </p>
+<p class="margin"> package_status&nbsp;&nbsp;(<span class="paratype">int</span>) - can be 1 (= PACKAGE_LOCKED) or 2 (= PACKAGE_ENABLED)</p>
+<p class="headgrp">Output: </p>
+<p class="margin"> Returns true package status was changed.</p>
+<!--<b>Output:</b>
+<p style="margin-left:100px">Gives a record of </p> -->
+</div>
+
+</body></html>
