Archived
Fancier docs.
This commit is contained in:
1 parent
6e5c3a89c7
commit
9943fb1165
4 files changed
+168
-37
No files matched your search
@@ -1,6 +1,8 @@
|
||||
Group
|
||||
=====
|
||||
|
||||
GET /group/
|
||||
-----------
|
||||
.. http:get:: /group/
|
||||
|
||||
Return information about all groups.
|
||||
@@ -13,6 +15,8 @@ Group
|
||||
|
||||
:statuscode 200: OK!
|
||||
|
||||
GET /group/(int)/
|
||||
-----------------
|
||||
.. http:get:: /group/(int:group_id)/
|
||||
|
||||
Return information about a specific group.
|
||||
@@ -24,6 +28,8 @@ Group
|
||||
:statuscode 200: OK!
|
||||
:statuscode 404: Group (`group_id`) was not found.
|
||||
|
||||
POST /group/
|
||||
------------
|
||||
.. http:post:: /group/
|
||||
|
||||
Create new group.
|
||||
@@ -41,6 +47,8 @@ Group
|
||||
:statuscode 403: You don't have necessary permissions.
|
||||
:statuscode 500: Group with this `posix_name` alredy exists or malformed body.
|
||||
|
||||
PATCH /group/(int)/
|
||||
-------------------
|
||||
.. http:patch:: /group/(int:group_id)/
|
||||
|
||||
Change name of a group.
|
||||
@@ -57,3 +65,11 @@ Group
|
||||
:statuscode 202: Changed!
|
||||
:statuscode 403: You don't have enough permissions to change this group.
|
||||
:statuscode 500: Group (`group_id`) does not exist or malformed body.
|
||||
|
||||
DELETE /group/(int)/
|
||||
--------------------
|
||||
.. http:delete:: /group/(int:group_id)/
|
||||
|
||||
Delete a group.
|
||||
|
||||
:statuscode 204: Deleted!
|
||||
+70
-13
@@ -1,6 +1,8 @@
|
||||
Member
|
||||
======
|
||||
|
||||
GET /member/
|
||||
------------
|
||||
.. http:get:: /member/
|
||||
|
||||
Returns info about all members.
|
||||
@@ -16,6 +18,51 @@ Member
|
||||
:query limit: limit number. default is 20
|
||||
:statuscode 200: Everything is gonna be alright.
|
||||
|
||||
GET /member/(int)/
|
||||
------------------
|
||||
.. http:get:: /member/(int:member_id)/
|
||||
|
||||
Returns info about member (`member_id`).
|
||||
|
||||
**Example request**:
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /member/1337/?format=json HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
:statuscode 200: OK!
|
||||
:statuscode 403: No permissions, mate.
|
||||
:statuscode 404: There's no user with given id.
|
||||
|
||||
GET /member/(int)/group/
|
||||
------------------------
|
||||
.. http:get:: /member/(int:member_id)/group/
|
||||
|
||||
Gets all groups member (`member_id`) is a member of.
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /member/1337/group/?format=json HTTP/1.1
|
||||
|
||||
:statuscode 200: OK!
|
||||
:statuscode 403: You don't have enough permissions.
|
||||
|
||||
GET /member/(int)/group/(int)/
|
||||
------------------------------
|
||||
.. http:get:: /member/(int:member_id)/group/(int:group_id)/
|
||||
|
||||
Checks if member (`member_id`) is a member of group (`group_id`).
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /member/1337/group/42/?format=json HTTP/1.1
|
||||
|
||||
:statuscode 200: OK!
|
||||
:statuscode 403: No go, brother :(
|
||||
|
||||
POST /member/
|
||||
-------------
|
||||
.. http:post:: /member/
|
||||
|
||||
Creates a new member with data given in body (json)
|
||||
@@ -35,20 +82,17 @@ Member
|
||||
:statuscode 201: User created.
|
||||
:statuscode 500: Invalid body or username already exists.
|
||||
|
||||
.. http:get:: /member/(int:member_id)/
|
||||
POST /member/(int)/group/(int)/
|
||||
-------------------------------
|
||||
.. http:post:: /member/(int:member_id)/group/(int:group_id)/
|
||||
|
||||
Returns info about member (`member_id`).
|
||||
Adds member (`member_id`) to group (`group_id`).
|
||||
|
||||
**Example request**:
|
||||
|
||||
.. sourcecode:: http
|
||||
|
||||
GET /member/1337/?format=json HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
:statuscode 200: OK!
|
||||
:statuscode 404: There's no user with given id.
|
||||
:statuscode 201: User added!
|
||||
:statuscode 403: Yeah...no.
|
||||
|
||||
PATCH /member/(int)/
|
||||
--------------------
|
||||
.. http:patch:: /member/(int:member_id)/
|
||||
|
||||
Updates fields of a member (`member_id`). Can't update username.
|
||||
@@ -65,9 +109,11 @@ Member
|
||||
}
|
||||
|
||||
:statuscode 202: User changed.
|
||||
:statuscode 403: Returned if request contains `"username"` field.
|
||||
:statuscode 403: Returned if request contains `"username"` field or you're missing necessary permissions.
|
||||
:statuscode 500: Invalid body.
|
||||
|
||||
DELETE /member/(int)/
|
||||
---------------------
|
||||
.. http:delete:: /member/(int:member_id)/
|
||||
|
||||
Deactivates a member.
|
||||
@@ -76,4 +122,15 @@ Member
|
||||
|
||||
DELETE /member/1337/?format=json HTTP/1.1
|
||||
|
||||
:statusc:de 403:
|
||||
:statuscode 204: User deactivated.
|
||||
:statuscode 403: You don't have enough permissions to deactivate users.
|
||||
|
||||
DELETE /member/(int)/group/(int)/
|
||||
---------------------------------
|
||||
|
||||
.. http:delete:: /member/(int:member_id)/group/(group_id)/
|
||||
|
||||
Removes a member from a group.
|
||||
|
||||
:statuscode 204: User removed from group.
|
||||
:statuscode 403: I can't let you do that, Dave.
|
||||
Reference in new issue
Block a user