docs: Remove remaining API V1 documentation (DEV-3073) (#2970)

Co-authored-by: Christian Kleinbölting <[email protected]>
dasch-swiss · Dec 20, 2023 · 2d3d4c4 · 2d3d4c4
1 parent eac5751
commit 2d3d4c4
Show file tree

Hide file tree

Showing 22 changed files with 404 additions and 2,198 deletions.
diff --git a/docs/02-dsp-ontologies/knora-base.md b/docs/02-dsp-ontologies/knora-base.md
diff --git a/docs/02-dsp-ontologies/salsah-gui.md b/docs/02-dsp-ontologies/salsah-gui.md
@@ -19,7 +19,7 @@ brevity, we omit the prefix in this document.
 ## Properties
 
 ### guiOrder
- 
+
 `guiOrder` can be attached to a cardinality
 in a resource class, to indicate the order in which properties
 should be displayed in the GUI. The object is a non-negative
@@ -112,7 +112,7 @@ recording.
 
 `List` is a GUI element for selecting an item in a hierarchical list (see
 [ListValue](knora-base.md#listvalue)). A property definition that
-uses this element must also contain this `guiAttribute` predicate: 
+uses this element must also contain this `guiAttribute` predicate:
 
 `"hlist=<LIST_IRI>"`, where `LIST_IRI` is the IRI of a
 `knora-base:ListNode` that is the root node of a hierarchical list.
@@ -122,7 +122,7 @@ uses this element must also contain this `guiAttribute` predicate:
 `Pulldown` is a GUI element for selecting an item in a flat list (see
 [ListValue](knora-base.md#listvalue)) using a pull-down menu. A
 property definition that uses this element must also contain this
-`guiAttribute` predicate: 
+`guiAttribute` predicate:
 
 `"hlist=<LIST_IRI>"`, where `LIST_IRI` is the IRI of a
 `knora-base:ListNode` that is the root node of a hierarchical list.
@@ -143,62 +143,55 @@ definition that uses this element must also contain this
 
 ### Searchbox
 
-`Searchbox` is a GUI element for searching for a resource by matching text in its
-`rdfs:label`. For DSP-API v1, a property definition that uses this
-element may also contain this `guiAttribute` predicate:
-
-`"numprops=N"`, where `N` is an integer specifying the number of
-describing properties to be returned for each found resource.
-
-For DSP-API v2, the `guiAttribute` has no effect.
+`Searchbox` is a GUI element for searching for a resource by matching text in its `rdfs:label`.
 
 ### SimpleText
 
 `SimpleText` is a GUI element for editing a single line of unformatted text. A
 property definition that uses this element may also contain a
 `guiAttribute` predicate with one or both of the following objects:
 
--   `"size=N"`, where `N` is an integer specifying the size of the
-text field.
--   `"maxlength=N"`, where `N` is an integer specifying the maximum
-length of the string to be input.
+- `"size=N"`, where `N` is an integer specifying the size of the
+  text field.
+- `"maxlength=N"`, where `N` is an integer specifying the maximum
+  length of the string to be input.
 
 ### Slider
 
 `Slider` is a GUI element for choosing numerical values using a slider. A
 property definition that uses this element must also contain a
 `guiAttribute` predicate with both of the following objects:
 
--   `"min=N"`, where `N` is an integer specifying the minimum value
-of the input.
--   `"max=N"`, where `N` is an integer specifying the maximum value 
-of the input.
+- `"min=N"`, where `N` is an integer specifying the minimum value
+  of the input.
+- `"max=N"`, where `N` is an integer specifying the maximum value
+  of the input.
 
 ### Spinbox
 
 `Spinbox` is a GUI element for choosing numerical values using a spinbox. A
 property definition that uses this element may also contain a
 `guiAttribute` predicate with one or both of the following objects:
 
--   `"min=N"`, where `N` is an integer specifying the minimum value
-of the input.
--   `"max=N"`, where `N` is an integer specifying the maximum value
-of the input.
+- `"min=N"`, where `N` is an integer specifying the minimum value
+  of the input.
+- `"max=N"`, where `N` is an integer specifying the maximum value
+  of the input.
 
 ### Textarea
 
 `Textarea` is a GUI element for editing multi-line unformatted text. A property
 definition that uses this element may also contain a `guiAttribute`
 predicate with one or more of the following objects:
 
--   `"width=N"`, where `N` is a percentage of the window width (an
-integer followed by `%`).
--   `"cols=N"`, where `N` is an integer representing the number of
-colums in the text entry box.
--   `"rows=N"`, where `N` is an integer specifying the height of the
-text entry box in rows.
--   `"wrap=W"`, where `W` is `soft` or `hard` (see
-[wrap](https://www.w3.org/TR/html5/sec-forms.html#element-attrdef-textarea-wrap)).
+- `"width=N"`, where `N` is a percentage of the window width (an
+  integer followed by `%`).
+- `"cols=N"`, where `N` is an integer representing the number of
+  colums in the text entry box.
+- `"rows=N"`, where `N` is an integer specifying the height of the
+  text entry box in rows.
+- `"wrap=W"`, where `W` is `soft` or `hard` (see
+  [wrap](https://www.w3.org/TR/html5/sec-forms.html#element-attrdef-textarea-wrap)).
 
 ### Checkbox
 

diff --git a/docs/03-endpoints/api-admin/groups.md b/docs/03-endpoints/api-admin/groups.md
@@ -20,52 +20,62 @@
 
 - `GET: /admin/groups/<groupIri>/members` : return all group members
 
-
 ## Group Operations
 
 ### Create Group
 
 - Required permission: SystemAdmin / hasProjectAllAdminPermission
-/ hasProjectAllGroupAdminPermission
+  / hasProjectAllGroupAdminPermission
 - Required information: name (unique inside project), project IRI
 - Optional information: group descriptions
 - Returns information about the newly created group
-- TypeScript Docs: groupFormats - CreateGroupApiRequestV1
 - POST: `/admin/groups`
 - BODY:
 
 ```json
     {
-      "name": "NewGroup",
-      "descriptions": [
-        {"value": "NewGroupDescription", "language": "en"},
-        {"value": "NeueGruppenBeschreibung", "language": "de"}
-      ],
-      "project": "http://rdfh.ch/projects/00FF",
-      "status": true,
-      "selfjoin": false
+  "name": "NewGroup",
+  "descriptions": [
+    {
+      "value": "NewGroupDescription",
+      "language": "en"
+    },
+    {
+      "value": "NeueGruppenBeschreibung",
+      "language": "de"
     }
+  ],
+  "project": "http://rdfh.ch/projects/00FF",
+  "status": true,
+  "selfjoin": false
+}
 ```
 
-Additionally, each group can have an optional custom IRI (of @ref:[Knora IRI](../api-v2/knora-iris.md#iris-for-data) form) 
+Additionally, each group can have an optional custom IRI (of @ref:[Knora IRI](../api-v2/knora-iris.md#iris-for-data)
+form)
 specified by the `id` in the request body as below:
 
 ```json
-    { 
-      "id": "http://rdfh.ch/groups/00FF/a95UWs71KUklnFOe1rcw1w",  
-      "name": "GroupWithCustomIRI",
-      "descriptions": [{"value": "A new group with a custom IRI", "language": "en"}],
-      "project": "http://rdfh.ch/projects/00FF",
-      "status": true,
-      "selfjoin": false
+    {
+  "id": "http://rdfh.ch/groups/00FF/a95UWs71KUklnFOe1rcw1w",
+  "name": "GroupWithCustomIRI",
+  "descriptions": [
+    {
+      "value": "A new group with a custom IRI",
+      "language": "en"
     }
+  ],
+  "project": "http://rdfh.ch/projects/00FF",
+  "status": true,
+  "selfjoin": false
+}
 ```
 
 ### Update group information
 
 - Required permission: SystemAdmin / hasProjectAllAdminPermission
-/ hasProjectAllGroupAdminPermission /
-hasProjectRestrictedGroupAdminPermission (for this group)
+  / hasProjectAllGroupAdminPermission /
+  hasProjectRestrictedGroupAdminPermission (for this group)
 - Changeable information: `name`, `descriptions`, `selfjoin`
 - TypeScript Docs: groupFormats - ChangeGroupApiRequestADM
 - PUT: `/admin/groups/<groupIri>`
@@ -74,7 +84,12 @@ hasProjectRestrictedGroupAdminPermission (for this group)
 ```json
 {
   "name": "UpdatedGroupName",
-  "descriptions": [{"value": "UpdatedGroupDescription", "language": "en"}],
+  "descriptions": [
+    {
+      "value": "UpdatedGroupDescription",
+      "language": "en"
+    }
+  ],
   "selfjoin": false
 }
 ```
@@ -97,7 +112,7 @@ hasProjectRestrictedGroupAdminPermission (for this group)
 
 - Required permission: SystemAdmin / hasProjectAllAdminPermission
 - Remark: The same as changing the groups `status` to
-`false`. To un-delete, set `status` to `true`.
+  `false`. To un-delete, set `status` to `true`.
 - DELETE: `/admin/groups/<groupIri>`
 
 Example Group Information stored in admin named graph: :