tronnet/ProxmoxAAS-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix readme tables

Browse Source
This commit is contained in:
Arthur Lu 2024-06-26 06:46:31 +00:00
parent ab0188a8bc
commit afecfcafd0
1 changed files with 52 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@ -75,25 +75,61 @@ Backend handlers are used to interface with any number and type of backend data
Each backend must implement the following methods: Each backend must implement the following methods:
||| <table>
|-|-| <tr>
|openSession|opens a session to the backend by creating a session token| <td>openSession</td>
|closeSession|closes a session to the backend| <td>opens a session to the backend by creating a session token</td>
</tr>
<tr>
<td>closeSession</td>
<td>closes a session to the backend</td>
</tr>
</table>
Additionally, backends dealing with user data may also need to implement: Additionally, backends dealing with user data may also need to implement:
||| <table>
|-|-| <tr>
|addUser|create a user| <td>addUser</td>
|getUser|retrieve user data including membership| <td>create a user</td>
|setUser|modify a user| </tr>
|delUser|delete a user| <tr>
|addGroup|create a group| <td>getUser</td>
|getGroup|retrieve group data including members| <td>retrieve user data including membership</td>
|setGroup|modify group data except membership| </tr>
|delGroup|delete group| <tr>
|addUserToGroup|add user to group as member| <td>setUser</td>
|deluserFromGroup|remove user from group| <td>modify a user</td>
</tr>
<tr>
<td>delUser</td>
<td>delete a user</td>
</tr>
<tr>
<td>addGroup</td>
<td>create a group</td>
</tr>
<tr>
<td>getGroup</td>
<td>retrieve group data including members</td>
</tr>
<tr>
<td>setGroup</td>
<td>modify group data except membership</td>
</tr>
<tr>
<td>delGroup</td>
<td>delete group</td>
</tr>
<tr>
<td>addUserToGroup</td>
<td>add user to group as member</td>
</tr>
<tr>
<td>deluserFromGroup</td>
<td>remove user from group</td>
</tr>
</table>
Not all user backends will necessarily implement all the methods fully. For example, backends which do not store group data may not need to implement the group related methods. Not all user backends will necessarily implement all the methods fully. For example, backends which do not store group data may not need to implement the group related methods.