feat (admin): Add edit list item route

docs/src/paradox/03-apis/api-admin/lists.md

@@ -23,38 +23,49 @@ License along with Knora.  If not, see <http://www.gnu.org/licenses/>.
 
 **List Operations:**
 
-- `GET: /admin/lists[?projectIri=<projectIri>]` : return all lists optionally filtered by project
-- `GET: /admin/lists/<listIri>` : return complete list with children
+- `GET: /admin/lists[?projectIRI=<projectIRI>]` : return all lists optionally filtered by project
+- `GET: /admin/lists/<listIRI>` : return complete list with children
 - `POST: /admin/lists` : create new list
-- `POST: /admin/lists/<nodeIri>` : create new child node under the supplied parent node IRI
-- NOT IMPLEMENTED: `DELETE: /admin/lists/<listIri>` : delete list including children if not used
-- `GET: /admin/lists/infos/<listIri>` : return list information (without children)
-- `PUT: /admin/lists/infos/<listIri>` : update list information
+- NOT IMPLEMENTED: `PUT: /admin/lists/<listIRI>` : create new list with given IRI
+- NOT IMPLEMENTED: `DELETE: /admin/lists/<listIRI>` : delete list including children if not used
+- `GET: /admin/lists/<listIRI>/Info` : return list information (without children)
+- `PUT: /admin/lists/<listIRI>/ListInfoName` : update list name information
+- `PUT: /admin/lists/<listIRI>/ListInfoLabel` : update list label information
+- `PUT: /admin/lists/<listIRI>/ListInfoComment` : update list comment information
+
+
 
 **List Node operations**
 
-- `GET: /admin/lists/nodes/<nodeIri>` : return list node information (without children)
-- NOT IMPLEMENTED: `POST: /admin/lists/nodes/<nodeIri>` : update list node information
-- NOT IMPLEMENTED: `DELETE: /admin/lists/nodes/<nodeIri>` : delete list node including children if not used
+- NOT IMPLEMENTED: `GET: /admin/lists/nodes/<nodeIRI>` : return list node information (with children)
+- `GET: /admin/lists/nodes/<nodeIRI>/Info` : return list node information (without children)
+- `POST: /admin/lists/nodes` : create new child node under the supplied parent node IRI
+- NOT IMPLEMENTED: `PUT: /admin/lists/nodes/<nodeIRI>` : create child node with given IRI und the supplied parent node IRI
+- `PUT: /admin/lists/nodes/<nodeIRI>/NodeInfoName` : update list node name information
+- `PUT: /admin/lists/nodes/<nodeIRI>/NodeInfoLabel` : update list node label information
+- `PUT: /admin/lists/nodes/<nodeIRI>/NodeInfoComment` : update list node comment information
+- NOT IMPLEMENTED: `PUT: /admin/lists/nodes/<nodeIRI>/NodeInfoPosition` : update list node position information
+- NOT IMPLEMENTED: `PUT: /admin/lists/nodes/<nodeIRI>/NodeInfoParent` : update list node parent information
+- NOT IMPLEMENTED: `DELETE: /admin/lists/nodes/<nodeIRI>` : delete list node including children if not used
 
 ## List Operations
 
 ### Get lists
 
  - Required permission: none
  - Return all lists optionally filtered by project
- - GET: `/admin/lists[?projectIri=<projectIri>]`
+ - GET: `/admin/lists[?projectIRI=<projectIRI>]`
 
 ### Get list
 
  - Required permission: none
  - Return complete list with children
- - GET: `/admin/lists/<listIri>`
+ - GET: `/admin/lists/<listIRI>`
 
 
 ### Create new list
 
-  - Required permission: SystemAdmin / ProjectAdmin
+  - Required permission: SystemAdmin or ProjectAdmin
   - POST: `/admin/lists`
   - BODY:
     ```
@@ -65,13 +76,88 @@ License along with Knora.  If not, see <http://www.gnu.org/licenses/>.
     } 
     ```
 
+### Get list's information
+
+ - Required permission: none
+ - Return list information (without children)
+ - GET: `/admin/lists/<listIRI>/Info`
+
+### Update lists's name information
+
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Update list name information
+ - PUT: `/admin/lists/<listIri>/ListInfoName`
+ - BODY
+   ```
+   {
+        "listIri": "listIri",
+        "projectIri": "projectIri",
+        "name": "name"
+   }
+   ```
+ - Submit empty parameter (`"name": ""`) to delete name
+ - `name` must be unique inside project
+
+### Update list's label information
+
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Update list label information
+ - PUT: `/admin/lists/<listIri>/ListInfoLabel`
+ - BODY
+   ```
+   {
+        "listIri": "listIri",
+        "projectIri": "projectIri",
+        "labels": [{"value": "New label", "language": "en"}]
+   }
+   ```
+ - At least one label must be submitted
+
+### Update list's comment information
+
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Update list comment information
+ - PUT: `/admin/lists/<listIri>/ListInfoName`
+ - BODY
+   ```
+   {
+        "listIri": "listIri",
+        "projectIri": "projectIri",
+        "comment": [{"value": "New Comment", "language": "en"}]
+   }
+   ```
+ - Submit empty parameter (`"comment": []`) to delete comments
+
+
+
+### Delete list
+
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Delete List including children if not used
+ - DELETE: `/admin/lists/<listIRI>`
+
+
+## List Node Operations
+
+### Get List Node
+
+ - Required permission: none
+ - Return list node with children
+ - GET: `/admin/lists/nodes/<nodeIRI>`
+
+### Get node's information
+
+ - Required permission: none
+ - Return node information (without children)
+ - GET: `/admin/lists/node/<nodeIRI>/Info`
+
 ### Create new child node
 
-  - Required permission: SystemAdmin / ProjectAdmin
+  - Required permission: SystemAdmin or ProjectAdmin
   - Appends a new child node under the supplied nodeIri. If the supplied nodeIri
     is the listIri, then a new child node is appended to the top level. Children
     are currently only appended.
-  - POST: `/admin/lists/<nodeIri>`
+  - POST: `/admin/lists/nodes`
   - BODY:
     ```
     {
@@ -82,32 +168,56 @@ License along with Knora.  If not, see <http://www.gnu.org/licenses/>.
         "comments": [{ "value": "New First Child List Node Comment", "language": "en"}]
     }
     ```
+
+### Delete List node
 
-### Get list's information
-
- - Required permission: none
- - Return list information (without children)
- - GET: `/admin/lists/infos/<listIri>`
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Delete node including children if not used
+ - DELETE: `/admin/lists/nodes/<nodeIRI>`
 
-### Update list's information
+### Update node's name information
 
- - Required permission: none
- - Update list information
- - PUT: `/admin/lists/infos/<listIri>`
- - BODY:
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Update list node name information
+ - PUT: `/admin/lists/nodes/<nodeIRI>/NodeInfoName`
+ - BODY
    ```
    {
-       "listIri": "listIri",
-       "projectIri": "someprojectiri",
-       "labels": [{ "value": "Neue geönderte Liste", "language": "de"}, { "value": "Changed list", "language": "en"}],
-       "comments": [{ "value": "Neuer Kommentar", "language": "de"}, { "value": "New comment", "language": "en"}]
+        "nodeIri": "nodeIri",
+        "projectIri": "projectIri",
+        "name": "name"
    }
    ```
+ - Submit empty parameter (`"name": ""`) to delete name
+ - `name` must be unique inside project
+
+### Update node's label information
 
-## List Node Operations
-
-### Get List Node Information
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Update list node label information
+ - PUT: `/admin/lists/nodes/<nodeIRI>/NodeInfoLabel`
+ - BODY
+   ```
+   {
+        "nodeIri": "nodeIri",
+        "projectIri": "projectIri",
+        "labels": [{"value": "New label", "language": "en"}]
+   }
+   ```
+ - At least one label must be submitted
+
+### Update node's comment information
 
- - Required permission: none
- - Return list node information (without children)
- - GET: `/admin/lists/nodes/<nodeIri>`
+ - Required permission: SystemAdmin or ProjectAdmin
+ - Update list node comment information
+ - PUT: `/admin/lists/nodes/<nodeIRI>/NodeInfoName`
+ - BODY
+   ```
+   {
+        "nodeIri": "nodeIri",
+        "projectIri": "projectIri",
+        "comment": [{"value": "New Comment", "language": "en"}]
+   }
+   ```
+ - Submit empty parameter (`"comment": []`) to delete comments
+

webapi/src/main/scala/org/knora/webapi/SharedTestDataADM.scala

@@ -29,6 +29,7 @@ import org.knora.webapi.messages.admin.responder.projectsmessages.ProjectADM
 import org.knora.webapi.messages.admin.responder.usersmessages.UserADM
 import org.knora.webapi.messages.store.triplestoremessages.StringLiteralV2
 import org.knora.webapi.util.StringFormatter
+import spray.json.{JsArray, JsObject, JsString}
 
 /**
  * This object holds the same user which are loaded with '_test_data/all_data/admin-data.ttl'. Using this object
@@ -632,19 +633,125 @@ object SharedTestDataADM {
     val createListRequest: String =
         s"""{
            |    "projectIri": "${SharedTestDataADM.ANYTHING_PROJECT_IRI}",
+           |    "name": "newList",
            |    "labels": [{ "value": "Neue Liste", "language": "de"}],
            |    "comments": []
            |}""".stripMargin
 
-    def updateListInfoRequest(listIri: IRI): String = {
+    def updateListNameRequest(listIri: IRI, projectIri: IRI, name: String): String = {
         s"""{
            |    "listIri": "$listIri",
-           |    "projectIri": "${SharedTestDataADM.ANYTHING_PROJECT_IRI}",
-           |    "labels": [{ "value": "Neue geänderte Liste", "language": "de"}, { "value": "Changed list", "language": "en"}],
-           |    "comments": [{ "value": "Neuer Kommentar", "language": "de"}, { "value": "New comment", "language": "en"}]
+           |    "projectIri": "$projectIri",
+           |    "name": "$name"
+           |}""".stripMargin
+    }
+
+    def updateListLabelsRequest(listIri: IRI, projectIri: IRI, labels: Vector[Map[String, String]]): String = {
+        JsObject(
+            Map(
+                "listIri" -> JsString(listIri),
+                "projectIri" -> JsString(projectIri),
+                "labels" -> JsArray(
+                    labels.map {
+                        labelMap =>
+                            JsObject(
+                                labelMap.map {
+                                    case (key, value) => key -> JsString(value)
+                                }
+                            )
+                    }
+                )
+            )
+        ).prettyPrint
+    }
+
+    def updateListCommentsRequest(listIri: IRI, projectIri: IRI, comments: Vector[Map[String, String]]): String = {
+        JsObject(
+            Map(
+                "listIri" -> JsString(listIri),
+                "projectIri" -> JsString(projectIri),
+                "comments" -> JsArray(
+                    comments.map {
+                        labelMap =>
+                            JsObject(
+                                labelMap.map {
+                                    case (key, value) => key -> JsString(value)
+                                }
+                            )
+                    }
+                )
+            )
+        ).prettyPrint
+    }
+
+    def updateListNodeNameRequest(nodeIri: IRI, projectIri: IRI, name: String): String = {
+        s"""{
+           |    "nodeIri": "$nodeIri",
+           |    "projectIri": "$projectIri",
+           |    "name": "$name"
            |}""".stripMargin
     }
 
+    def updateListNodeLabelsRequest(nodeIri: IRI, projectIri: IRI, labels: Vector[Map[String, String]]): String = {
+        JsObject(
+            Map(
+                "nodeIri" -> JsString(nodeIri),
+                "projectIri" -> JsString(projectIri),
+                "labels" -> JsArray(
+                    labels.map {
+                        labelMap =>
+                            JsObject(
+                                labelMap.map {
+                                    case (key, value) => key -> JsString(value)
+                                }
+                            )
+                    }
+                )
+            )
+        ).prettyPrint
+    }
+
+    def updateListNodeCommentsRequest(nodeIri: IRI, projectIri: IRI, comments: Vector[Map[String, String]]): String = {
+        JsObject(
+            Map(
+                "nodeIri" -> JsString(nodeIri),
+                "projectIri" -> JsString(projectIri),
+                "comments" -> JsArray(
+                    comments.map {
+                        labelMap =>
+                            JsObject(
+                                labelMap.map {
+                                    case (key, value) => key -> JsString(value)
+                                }
+                            )
+                    }
+                )
+            )
+        ).prettyPrint
+    }
+
+    val updatedLabels: Vector[Map[String, String]] = Vector(
+        Map(
+            "value" -> "Geändertes Etikett",
+            "language" -> "de"
+        ),
+        Map(
+            "value" -> "Changed label",
+            "language" -> "en"
+        )
+    )
+
+    val updatedComments: Vector[Map[String, String]] = Vector(
+        Map(
+            "value" -> "Geänderter Kommentar",
+            "language" -> "de"
+        ),
+        Map(
+            "value" -> "Changed comment",
+            "language" -> "en"
+        )
+    )
+
     def addChildListNodeRequest(parentNodeIri: IRI,
                                 name: String,
                                 label: String,