issue #336

CHANGELOG

@@ -6,6 +6,8 @@ v1.1.2 (XXXX-XX-XX)
 
 * fixed issue #332: arangoimp --use-ids parameter seems to have no impact
 
+* fixed issue #336: Collections REST API docs
+
 * added option '--server.disable-authentication' for arangosh as well. No more passwd
   prompts if not needed
 

Documentation/Examples/api-collection-all-collections

@@ -7,30 +7,30 @@ content-type: application/json
   "collections": [
     {
       "name": "employees",
-      "waitForSync": true,
       "id": 64091684,
-      "status": 3
+      "status": 3,
+      "type": 2
     },
     {
       "name": "units",
-      "waitForSync": true,
       "id": 63043108,
-      "status": 3
+      "status": 3,
+      "type": 2
     }
   ],
   "code": 200,
   "names": {
     "units": {
       "name": "units",
-      "waitForSync": true,
       "id": 63043108,
-      "status": 3
+      "status": 3,
+      "type": 2
     },
     "employees": {
       "name": "employees",
-      "waitForSync": true,
       "id": 64091684,
-      "status": 3
+      "status": 3,
+      "type": 2
     }
   },
   "error": false

Documentation/Examples/api-collection-get-collection-count

@@ -9,7 +9,9 @@ location: /_api/collection/73482/count
   "code": 200,
   "waitForSync": true,
   "id": 73482,
+  "journalSize": 33554432,
   "count": 0,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-get-collection-figures

@@ -30,5 +30,6 @@ location: /_api/collection/73482/figures
   "journalSize": 134217728,
   "count": 0,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-get-collection-identifier

@@ -7,8 +7,8 @@ location: /_api/collection/73482
 {
   "name": "UnitTestsCollectionBasics",
   "code": 200,
-  "waitForSync": true,
   "id": 73482,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-get-collection-name

@@ -7,8 +7,8 @@ location: /_api/collection/73482
 {
   "name": "UnitTestsCollectionBasics",
   "code": 200,
-  "waitForSync": true,
   "id": 73482,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-identifier-load

@@ -9,5 +9,6 @@ content-type: application/json
   "id": 55144253,
   "count": 0,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-identifier-properties-sync

@@ -11,5 +11,6 @@ content-type: application/json
   "id": 70109828,
   "journalSize": 134217728,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-identifier-rename

@@ -9,5 +9,6 @@ content-type: application/json
   "code": 200,
   "id": 59230852,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-identifier-truncate

@@ -8,5 +8,6 @@ content-type: application/json
   "code": 200,
   "id": 56478340,
   "status": 3,
+  "type": 2,
   "error": false
 }

Documentation/Examples/api-collection-identifier-unload

@@ -8,5 +8,6 @@ content-type: application/json
   "code": 200,
   "id": 57765693,
   "status": 4,
+  "type": 2,
   "error": false
 }

js/actions/system/api-collection.js

@@ -115,8 +115,8 @@
 ///
 /// - @LIT{type} (optional, default is @LIT{2}): the type of the collection to
 ///   create. The following values for @FA{type} are valid:
-///   - @LIT{2}: document collections
-///   - @LIT{3}: edge collection
+///   - @LIT{2}: document collection
+///   - @LIT{3}: edges collection
 ///
 /// @EXAMPLES
 ///
@@ -427,7 +427,8 @@
 ///
 /// @REST{PUT /_api/collection/@FA{collection-identifier}/load}
 ///
-/// Loads a collection into memory.  On success an object with the following
+/// Loads a collection into memory. On success an object with the following
+/// attributes is returned:
 ///
 /// - @LIT{id}: The identifier of the collection.
 ///
@@ -437,6 +438,10 @@
 ///
 /// - @LIT{status}: The status of the collection as number.
 ///
+/// - @LIT{type}: The collection type. Valid types are:
+///   - 2: document collection
+///   - 3: edges collection
+///
 /// If the @FA{collection-identifier} is missing, then a @LIT{HTTP 400} is
 /// returned.  If the @FA{collection-identifier} is unknown, then a @LIT{HTTP
 /// 404} is returned.
@@ -470,7 +475,8 @@
 ///
 /// Removes a collection from memory. This call does not delete any documents.
 /// You can use the collection afterwards; in which case it will be loaded into
-/// memory, again. On success an object with the following
+/// memory, again. On success an object with the following attributes is
+/// returned:
 ///
 /// - @LIT{id}: The identifier of the collection.
 ///
@@ -478,6 +484,10 @@
 ///
 /// - @LIT{status}: The status of the collection as number.
 ///
+/// - @LIT{type}: The collection type. Valid types are:
+///   - 2: document collection
+///   - 3: edges collection
+///
 /// If the @FA{collection-identifier} is missing, then a @LIT{HTTP 400} is
 /// returned.  If the @FA{collection-identifier} is unknown, then a @LIT{HTTP
 /// 404} is returned.
@@ -548,6 +558,12 @@
 ///
 /// - @LIT{waitForSync}: The new value.
 ///
+/// - @LIT{status}: The status of the collection as number.
+///
+/// - @LIT{type}: The collection type. Valid types are:
+///   - 2: document collection
+///   - 3: edges collection
+///
 /// @EXAMPLES
 ///
 /// @verbinclude api-collection-identifier-properties-sync
@@ -589,6 +605,12 @@
 ///
 /// - @LIT{name}: The new name of the collection.
 ///
+/// - @LIT{status}: The status of the collection as number.
+///
+/// - @LIT{type}: The collection type. Valid types are:
+///   - 2: document collection
+///   - 3: edges collection
+///
 /// @EXAMPLES
 ///
 /// @verbinclude api-collection-identifier-rename