diff --git a/docs/api/rest/group.html b/docs/api/rest/group.html new file mode 100644 index 0000000000..6c5a1cb751 --- /dev/null +++ b/docs/api/rest/group.html @@ -0,0 +1,215 @@ + + + REST API - Group + + + + +

REST API - Group

+ + + + +

Get all

+ + + + + + + + + + + + + + + + + + + + + + +
URL/api/rest/groups(.xml|.json)
MethodGET
Returns200 OK
401 Unauthorized
415 Unsupported Media Type
+ +

JSON Example

+ +
+GET /api/rest/groups.json
+
+[
+  {
+    name: 'group1',
+    members: [
+      'hans', 'klaus', 'uwe'
+    ]
+  },
+  {
+    name: 'group2',
+    members: [
+      'peter', 'klaus', 'hans'
+    ]
+  }
+]
+    
+ + +

Get

+ + + + + + + + + + + + + + + + + + + + + + + + + +
URL/api/rest/groups/group name(.xml|.json)
MethodGET
Returns200 OK
401 Unauthorized
404 Not Found
415 Unsupported Media Type
+ +

JSON Example

+ +
+GET /api/rest/groups/group name.json
+
+{
+  name: 'group1',
+  members: [
+    'hans', 'klaus', 'uwe'
+  ]
+}
+    
+ + +

Add

+ + + + + + + + + + + + + + + + + + + + + + +
URL/api/rest/groups(.xml|.json)
MethodPOST
Returns201 Created & Location
401 Unauthorized
415 Unsupported Media Type
+ +

JSON Example

+ +
+POST /api/rest/groups.json
+
+{
+  name: 'group3',
+  members: [
+    'klaus', 'uwe'
+  ]
+}
+    
+ + +

Update

+ + + + + + + + + + + + + + + + + + + + + + + + + +
URL/api/rest/groups/group name(.xml|.json)
MethodPUT
Returns201 Created & Location
401 Unauthorized
404 Not Found
415 Unsupported Media Type
+ +

JSON Example

+ +
+PUT /api/rest/groups.json
+
+{
+  name: 'group3',
+  members: [
+    'hans', 'klaus', 'uwe'
+  ]
+}
+    
+ + +

Delete

+ + + + + + + + + + + + + + + + + + + + + + +
URL/api/rest/groups/group name(.xml|.json)
MethodDELETE
Returns204 No Content
401 Unauthorized
404 Not Found
+ + + \ No newline at end of file diff --git a/docs/api/rest/resources/style.css b/docs/api/rest/resources/style.css new file mode 100644 index 0000000000..fdc6345779 --- /dev/null +++ b/docs/api/rest/resources/style.css @@ -0,0 +1,11 @@ +h1 { font-size: 18px; color: red; border-bottom: 1px solid gray; } +h2 { font-size: 16px; color: red; border-bottom: 1px solid gray; } +h3 { font-size: 16px; color: red; } + +pre, table { margin-left: 20px; } + +pre { border: 1px dashed gray; padding: 10px; background-color: #eee; } + +table { border-collapse: collapse; width: 480px; border: 2px solid black; } +td, th { border: 1px solid black; padding: 3px; } +th { font-weight: normal; text-align: left; width: 80px; vertical-align: top; } \ No newline at end of file