Added collision prevention to aliases, added todo for the reverse, promoted numbers...

[hermes] / api-nodes.txt

diff --git a/api-nodes.txt b/api-nodes.txt
index 376beb1a7db4634a0685664ac4a31db2787822ac..1a26ef8b0c0ce51c2ea9b4ff9dd9a38aa2a101fc 100644 (file)
--- a/api-nodes.txt
+++ b/api-nodes.txt
@@ -33,6 +33,7 @@ user/add_remote?username=foo&domain=bar&password=S3cr3t&displayname=baz&registra
        Adds a provisioning user for a remote SIP account. This allows locally provisioned hardphones
        to be associated with non-local SIP accounts.
        Returns a full user object, the same form as user/get
+       Returns 'failed' with  'cause' = 'domain' if an attempt is made to add_remote for a local domain.
 
 user/remove?username=foo&domain=bar
        Removes user account from Kamailio, if present, and removes user from provisioning.
@@ -106,17 +107,14 @@ numbers/remove?number=%2B4761123456
        Returns 'response' as 'ok' with 'number' set to the number that was pulled from the pool.
 
 numbers/inpool?number=%2B4761123456
-       A debug-node, may disappear at any time ^_^
        Tests if the given E164 number is in the pool.
        Returns 'response' = 'ok' with 'number' = '<number>' If the number is in the pool
        Returns response = 'failed' with 'cause' = 'nonexistant' if not.
 
-
 alias/list
-       Currently not implemented.
-
-alias/user?destination=foo@bar.bz
-alias/user?destination=foo@bar.bz&e164=true
+alias/list?destination=foo@bar.bz
+alias/list?destination=foo@bar.bz&e164=true
+alias/list?alias=foo@bar.bz
        Currently not implemented
 
 alias/add?alias_username=foo&alias_domain=bar.bz&destination=bar@qux.zx
@@ -153,16 +151,8 @@ Planned, but not implemented nodes/functions:
        alias/list
        alias/user?destination=foo@bar.bz
 
-Parameter updates:
-       Update nodes where username=foo&domain=bar.bz is used, to also support user=foo@bar.bz
-               user/get
-               user/add_local
-               user/add_remote
-               user/remove
-               user/change_pw
-               user/update
-               phone/get (reverse, needs username & domain param)
-               alias/add
-               alias/remove
-
 authentication-mechanism :)
+
+Add collision prevention for users, make sure that no user can be added when the user
+address would overlap/collide with a valid alias-address
+