[incubator-ponymail-foal] branch master updated: add API for mbox.json

[hu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

humbedooh pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-ponymail-foal.git


The following commit(s) were added to refs/heads/master by this push:
     new 77b384a  add API for mbox.json
77b384a is described below

commit 77b384a61bf5f383fd2720467b809437d398767f
Author: Daniel Gruno <hu...@apache.org>
AuthorDate: Fri Jun 4 19:42:30 2021 +0200

    add API for mbox.json
---
 server/openapi.yaml | 26 ++++++++++++++++++++++++--
 1 file changed, 24 insertions(+), 2 deletions(-)

diff --git a/server/openapi.yaml b/server/openapi.yaml
index 3444d1e..ede01ad 100644
--- a/server/openapi.yaml
+++ b/server/openapi.yaml
@@ -393,8 +393,30 @@ paths:
       security:
       - cookieAuth: []
       summary: Fetches a single email and returns it as a JSON object
-  # /api/mbox.json:
-  #   TBA
+  /api/mbox.json:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SearchRequest'
+        description: Search parameters
+        required: true
+      responses:
+        '200':
+          content:
+            text/plain:
+              example: "[mbox file contents]"
+          description: 200 Response
+        default:
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          description: unexpected error
+      security:
+      - cookieAuth: []
+      summary: Returns a list or a search result in mbox file format
   # /api/mgmt.json:
   #   TBA
   # /api/oauth.json: