docs: explain what export routes actually do in OpenAPI documentation (…

…#10836)
NodeBB · Aug 16, 2022 · 72e7b9f · 72e7b9f
1 parent 4a3e36a
commit 72e7b9f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/public/openapi/read/user/userslug/export/posts.yaml b/public/openapi/read/user/userslug/export/posts.yaml
@@ -2,6 +2,7 @@ get:
   tags:
     - users
   summary: Export a user's posts (.csv)
+  description: This route retrieves an existing export of user's posts. To create one go to `/user/{userslug}/consent`
   parameters:
     - name: userslug
       in: path

diff --git a/public/openapi/read/user/userslug/export/profile.yaml b/public/openapi/read/user/userslug/export/profile.yaml
@@ -2,6 +2,7 @@ get:
   tags:
     - users
   summary: Export a user's profile data (.json)
+  description: This route retrieves an existing export of user's profile data. To create one go to `/user/{userslug}/consent`
   parameters:
     - name: userslug
       in: path

diff --git a/public/openapi/read/user/userslug/export/uploads.yaml b/public/openapi/read/user/userslug/export/uploads.yaml
@@ -2,6 +2,7 @@ get:
   tags:
     - users
   summary: Export a user's uploads (.zip)
+  description: This route retrieves an existing export of user's profile data. To create one go to `/user/{userslug}/consent`
   parameters:
     - name: userslug
       in: path