... | ... | @@ -5,10 +5,11 @@ https://<hostname>/api/<endpoint> |
|
|
|
|
|
*Note that some methods are stroke as they are not activated right now but are ready to be*
|
|
|
|
|
|
|
|
|
# Model-based endpoints
|
|
|
|
|
|
## Cotisations
|
|
|
|
|
|
## Cotisations
|
|
|
|
|
|
<details><summary><b>/cotisations/facture/</b></summary>
|
|
|
<table>
|
... | ... | @@ -412,6 +413,7 @@ https://<hostname>/api/<endpoint> |
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
|
|
|
## Machines
|
|
|
|
|
|
<details><summary><b>/machines/machines/</b></summary>
|
... | ... | @@ -1687,8 +1689,12 @@ https://<hostname>/api/<endpoint> |
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
|
|
|
## Preferences
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Topologie
|
|
|
|
|
|
<details><summary><b>/topologie/stacks/</b></summary>
|
... | ... | @@ -2295,9 +2301,611 @@ https://<hostname>/api/<endpoint> |
|
|
</details>
|
|
|
|
|
|
|
|
|
|
|
|
## Users
|
|
|
|
|
|
<details><summary><b>/users/users/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all users </th>
|
|
|
<th> Retrieve the list of all users </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a user </del></th>
|
|
|
<th><del> Create a new user </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a user </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/users/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all users <br \>
|
|
|
- Can view this user </th>
|
|
|
<th> Retrieve the data about this user </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this user </del></th>
|
|
|
<th><del> Delete this user </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this user </del></th>
|
|
|
<th><del> Edit this user partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a user you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this user </del></th>
|
|
|
<th><del> Edit this user entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a user </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/clubs/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all clubs </th>
|
|
|
<th> Retrieve the list of all clubs </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a club </del></th>
|
|
|
<th><del> Create a new club </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a club </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/clubs/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all clubs <br \>
|
|
|
- Can view this club </th>
|
|
|
<th> Retrieve the data about this club </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this club </del></th>
|
|
|
<th><del> Delete this club </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this club </del></th>
|
|
|
<th><del> Edit this club partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a club you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this club </del></th>
|
|
|
<th><del> Edit this club entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a club </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/adherents/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all adherents </th>
|
|
|
<th> Retrieve the list of all adherents </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create an adherent </del></th>
|
|
|
<th><del> Create a new adherent </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create an adherent </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/adherents/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all adherents <br \>
|
|
|
- Can view this adherent </th>
|
|
|
<th> Retrieve the data about this adherent </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this adherent </del></th>
|
|
|
<th><del> Delete this adherent </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this adherent </del></th>
|
|
|
<th><del> Edit this adherent partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of an adherent you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this adherent </del></th>
|
|
|
<th><del> Edit this adherent entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of an adherent </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/serviceusers/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all serviceusers </th>
|
|
|
<th> Retrieve the list of all serviceusers </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a serviceuser </del></th>
|
|
|
<th><del> Create a new serviceuser </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a serviceuser </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/serviceusers/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all serviceusers <br \>
|
|
|
- Can view this serviceuser </th>
|
|
|
<th> Retrieve the data about this serviceuser </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this serviceuser </del></th>
|
|
|
<th><del> Delete this serviceuser </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this serviceuser </del></th>
|
|
|
<th><del> Edit this serviceuser partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a serviceuser you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this serviceuser </del></th>
|
|
|
<th><del> Edit this serviceuser entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a serviceuser </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/schools/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all schools </th>
|
|
|
<th> Retrieve the list of all schools </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a school </del></th>
|
|
|
<th><del> Create a new school </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a school </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/schools/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all schools <br \>
|
|
|
- Can view this school </th>
|
|
|
<th> Retrieve the data about this school </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this school </del></th>
|
|
|
<th><del> Delete this school </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this school </del></th>
|
|
|
<th><del> Edit this school partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a school you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this school </del></th>
|
|
|
<th><del> Edit this school entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a school </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/listrights/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all listrights </th>
|
|
|
<th> Retrieve the list of all listrights </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a listright </del></th>
|
|
|
<th><del> Create a new listright </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a listright </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/listrights/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all listrights <br \>
|
|
|
- Can view this listright </th>
|
|
|
<th> Retrieve the data about this listright </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this listright </del></th>
|
|
|
<th><del> Delete this listright </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this listright </del></th>
|
|
|
<th><del> Edit this listright partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a listright you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this listright </del></th>
|
|
|
<th><del> Edit this listright entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a listright </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/shells/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all shells </th>
|
|
|
<th> Retrieve the list of all shells </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a shell </del></th>
|
|
|
<th><del> Create a new shell </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a shell </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/shells/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all shells <br \>
|
|
|
- Can view this shell </th>
|
|
|
<th> Retrieve the data about this shell </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this shell </del></th>
|
|
|
<th><del> Delete this shell </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this shell </del></th>
|
|
|
<th><del> Edit this shell partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a shell you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this shell </del></th>
|
|
|
<th><del> Edit this shell entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a shell </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/bans/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all bans </th>
|
|
|
<th> Retrieve the list of all bans </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a ban </del></th>
|
|
|
<th><del> Create a new ban </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a ban </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/bans/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all bans <br \>
|
|
|
- Can view this ban </th>
|
|
|
<th> Retrieve the data about this ban </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this ban </del></th>
|
|
|
<th><del> Delete this ban </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this ban </del></th>
|
|
|
<th><del> Edit this ban partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a ban you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this ban </del></th>
|
|
|
<th><del> Edit this ban entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a ban </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/whitelists/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all whitelists </th>
|
|
|
<th> Retrieve the list of all whitelists </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> POST </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can create a whitelist </del></th>
|
|
|
<th><del> Create a new whitelist </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> Fields to create a whitelist </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
<details><summary><b>/users/whitelists/<id>/</b></summary>
|
|
|
<table>
|
|
|
<tr>
|
|
|
<th> Method </th>
|
|
|
<th> ACL required </th>
|
|
|
<th> Effect </th>
|
|
|
<th> Params </th>
|
|
|
<th> Data </th>
|
|
|
</tr><tr>
|
|
|
<th> GET </th>
|
|
|
<th> - Can view the api <br \>
|
|
|
- Can view all whitelists <br \>
|
|
|
- Can view this whitelist </th>
|
|
|
<th> Retrieve the data about this whitelist </th>
|
|
|
<th> N/A </th>
|
|
|
<th> N/A </th>
|
|
|
</tr><tr>
|
|
|
<th><del> DELETE </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can delete this whitelist </del></th>
|
|
|
<th><del> Delete this whitelist </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PATCH </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this whitelist </del></th>
|
|
|
<th><del> Edit this whitelist partially </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> The fields of a whitelist you want to modify </del></th>
|
|
|
</tr><tr>
|
|
|
<th><del> PUT </del></th>
|
|
|
<th><del> - Can view the api <br \>
|
|
|
- Can edit this whitelist </del></th>
|
|
|
<th><del> Edit this whitelist entirely </del></th>
|
|
|
<th><del> N/A </del></th>
|
|
|
<th><del> All the fields of a whitelist </del></th>
|
|
|
</tr>
|
|
|
</table>
|
|
|
</details>
|
|
|
|
|
|
# DNS-specific endpoints
|
|
|
|
|
|
# DHCP-specific endpoints
|
... | ... | |