From 18d89768ffe78ca02f8c3580cdf91d87d09ac056 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org>
Date: Thu, 14 Oct 2021 17:43:13 +0200
Subject: [PATCH] DOCS: remove outdated, reorganize
---
src/doc/index.rst | 2 +-
src/doc/specification/Fileserver.md | 29 +----------------------------
src/doc/specification/index.rst | 12 ++++++------
3 files changed, 8 insertions(+), 35 deletions(-)
diff --git a/src/doc/index.rst b/src/doc/index.rst
index 21fd891c..9f6e4aef 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -15,7 +15,7 @@ Welcome to caosdb-server's documentation!
Development <development/devel>
specification/index.rst
Glossary
- API documentation<_apidoc/packages>
+ Java Code Documentation<_apidoc/packages>
Welcome to the CaosDB, the flexible semantic data management toolkit!
diff --git a/src/doc/specification/Fileserver.md b/src/doc/specification/Fileserver.md
index dd3e0f37..efd78d38 100644
--- a/src/doc/specification/Fileserver.md
+++ b/src/doc/specification/Fileserver.md
@@ -1,36 +1,9 @@
# Fileserver
## Info
-There are several ways to utilize the file server component of CaosDB. It is possible to upload a file or a whole folder including subfolders via HTTP and the _drop off box_. It is possible to download a file via HTTP identified by its ID or by its path in the internal file system. Furthermore, it is possible to get the files metadata via HTTP as an xml.
+There are several ways to utilize the file server component of CaosDB. It is possible to upload a file or a whole folder including subfolders via HTTP. It is possible to download a file via HTTP identified by its ID or by its path in the internal file system. Furthermore, it is possible to get the files metadata via HTTP as an xml.
## File upload
-### Drop off box
-
-The drop off box is a directory on the CaosDB server's local file system, specified in the `server.conf` file in the server's basepath (something like `~/CaosDB/server/server.conf`). The key in the `server.conf` is called `dropoffbox`. Since the drop off box directory is writable for all, users can push their files or complete folders via a `mv` or a `cp` (recommended!) in that folder. The server deletes files older than their maximum lifetime (24 hours by default, specified `in server.conf`). But within their lifetime a user can prompt the server to pick up the file (or folder) from the drop off box in order to transfer it to the internal file system.
-
-Now, the user may send a pick up request to `POST http://host:port/mpidsserver/FilesDropOff` with a similar body:
-
- <Post>
- <File pickup="$path_dropoffbox" destination="$path_filesystem" description="$description" generator="$generator"/>
- ...
- </Post>
-
-where
-* $path_dropoffbox is the actual relative path of the dropped file or folder in the DropOffBox,
-* $path_filesystem is the designated relative path of that object in the internal file system,
-* $description is a description of the file to be uploaded,
-* $generator is the tool or client used for pushing this file.
-
-After a successful pick up the server will return:
-
- <Response>
- <File description="$description" path="$path" id="$id" checksum="$checksum" size="$size" />
- ...
- </Response>
-
-where
-* $id is the new generated id of that file and
-* $path is the path of the submitted file or folder relative to the file system's root.
### HTTP upload stream
#### Files
diff --git a/src/doc/specification/index.rst b/src/doc/specification/index.rst
index 69677277..8db44e85 100644
--- a/src/doc/specification/index.rst
+++ b/src/doc/specification/index.rst
@@ -6,13 +6,13 @@ Specification
:caption: Contents:
:hidden:
- AbstractProperty
+ Specification of the Entity API <entity_api>
+ Specification of the Message API <Specification-of-the-Message-API>
+ Server side scripting <Server-side-scripting>
Fileserver
- Record
Authentication
- Datatype
Paging
RecordType
- Server side scripting <Server-side-scripting>
- Specification of the Message API <Specification-of-the-Message-API>
- Specification of the Entity API <entity_api>
+ Record
+ AbstractProperty
+ Datatype
--
GitLab