Mercurial > prosody-modules

changeset 4949:2ff1fa824c5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_rest: Document /archive/ in openapi spec
author Kim Alvefur <zash@zash.se>
date Sat, 21 May 2022 22:57:57 +0200
parents b171ddf1bc3e
children 8f625a7dc957
files mod_rest/res/openapi.yaml
diffstat 1 files changed, 52 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mod_rest/res/openapi.yaml	Sat May 21 22:55:41 2022 +0200
+++ b/mod_rest/res/openapi.yaml	Sat May 21 22:57:57 2022 +0200
@@ -151,6 +151,58 @@
         '200':
           $ref: '#/components/responses/success'
 
+
+  /rest/archive/{to}:
+    get:
+      tags:
+      - query
+      summary: Query a message archive
+      security:
+      - basic: []
+      - token: []
+      parameters:
+      - $ref: '#/components/parameters/to'
+      - name: with
+        in: query
+        schema:
+          type: string
+      - name: start
+        in: query
+        schema:
+          type: string
+      - name: end
+        in: query
+        schema:
+          type: string
+      - name: before-id
+        in: query
+        schema:
+          type: string
+      - name: after-id
+        in: query
+        schema:
+          type: string
+      - name: ids
+        in: query
+        schema:
+          type: string
+        description: comma-separated list of archive ids
+      - name: after
+        in: query
+        schema:
+          type: string
+      - name: before
+        in: query
+        schema:
+          type: string
+      - name: max
+        in: query
+        schema:
+          type: integer
+      responses:
+        '200':
+          $ref: '#/components/responses/success'
+
 components:
   schemas:
     stanza: