maketank/Froxlor
2
0
Fork 0
Code Pull Requests Releases Activity

api documentation additions for Customers.add()/update() and Admins.add()/update()

Browse Source 
Signed-off-by: Michael Kaufmann <d00p@froxlor.org>
This commit is contained in:
Michael Kaufmann
2024-01-28 10:03:56 +01:00
parent bcf0818faf
commit f03b49d0db
2 changed files with 21 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/Froxlor/Api/Commands/Admins.php
View File

@@ -140,12 +140,16 @@ class Admins extends ApiCommand implements ResourceEntity
* create a new admin user * create a new admin user
* *
* @param string $name * @param string $name
* required, name of the adminstrator
* @param string $email * @param string $email
* required, email address of the administrator
* @param string $new_loginname * @param string $new_loginname
* required, loginname/username of the administrator
* @param string $admin_password * @param string $admin_password
* optional, default auto-generated * optional, default auto-generated
* @param string $def_language * @param string $def_language
* optional, default is system-default language * * optional, ISO 639-1 language code (e.g. 'en', 'de', see lng-folder for supported languages),
* * default is system-default language
* @param bool $gui_access * @param bool $gui_access
* optional, allow login via webui, if false ONLY the login via webui is disallowed; default true * optional, allow login via webui, if false ONLY the login via webui is disallowed; default true
* @param bool $api_allowed * @param bool $api_allowed
@@ -435,7 +439,8 @@ class Admins extends ApiCommand implements ResourceEntity
* @param string $admin_password * @param string $admin_password
* optional, default auto-generated * optional, default auto-generated
* @param string $def_language * @param string $def_language
* optional, default is system-default language * * optional, ISO 639-1 language code (e.g. 'en', 'de', see lng-folder for supported languages),
* * default is system-default language
* @param bool $gui_access * @param bool $gui_access
* * optional, allow login via webui, if false ONLY the login via webui is disallowed; default true * * optional, allow login via webui, if false ONLY the login via webui is disallowed; default true
* @param bool $api_allowed * @param bool $api_allowed

14
lib/Froxlor/Api/Commands/Customers.php
View File

@@ -171,6 +171,7 @@ class Customers extends ApiCommand implements ResourceEntity
* create a new customer with default ftp-user and standard-subdomain (if wanted) * create a new customer with default ftp-user and standard-subdomain (if wanted)
* *
* @param string $email * @param string $email
* required, email address of new customer
* @param string $name * @param string $name
* optional if company is set, else required * optional if company is set, else required
* @param string $firstname * @param string $firstname
@@ -189,8 +190,9 @@ class Customers extends ApiCommand implements ResourceEntity
* optional * optional
* @param int $customernumber * @param int $customernumber
* optional * optional
* @param string $def_language , * @param string $def_language
* optional, default is system-default language * optional, ISO 639-1 language code (e.g. 'en', 'de', see lng-folder for supported languages),
* default is system-default language
* @param bool $gui_access * @param bool $gui_access
* optional, allow login via webui, if false ONLY the login via webui is disallowed; default true * optional, allow login via webui, if false ONLY the login via webui is disallowed; default true
* @param bool $api_allowed * @param bool $api_allowed
@@ -933,6 +935,7 @@ class Customers extends ApiCommand implements ResourceEntity
* @param string $loginname * @param string $loginname
* optional, the loginname * optional, the loginname
* @param string $email * @param string $email
* optional
* @param string $name * @param string $name
* optional if company is set, else required * optional if company is set, else required
* @param string $firstname * @param string $firstname
@@ -951,8 +954,9 @@ class Customers extends ApiCommand implements ResourceEntity
* optional * optional
* @param int $customernumber * @param int $customernumber
* optional * optional
* @param string $def_language , * @param string $def_language
* optional, default is system-default language * * optional, ISO 639-1 language code (e.g. 'en', 'de', see lng-folder for supported languages),
* * default is system-default language
* @param bool $gui_access * @param bool $gui_access
* optional, allow login via webui, if false ONLY the login via webui is disallowed; default true * optional, allow login via webui, if false ONLY the login via webui is disallowed; default true
* @param bool $api_allowed * @param bool $api_allowed
@@ -965,7 +969,7 @@ class Customers extends ApiCommand implements ResourceEntity
* optional, whether to show the content of custom_notes to the customer, default 0 * optional, whether to show the content of custom_notes to the customer, default 0
* (false) * (false)
* @param string $new_customer_password * @param string $new_customer_password
* optional, iset new password * optional, set new password
* @param bool $sendpassword * @param bool $sendpassword
* optional, whether to send the password to the customer after creation, default 0 * optional, whether to send the password to the customer after creation, default 0
* (false) * (false)