From 72e7b9f7d87306a7d41021bc63c0baf3fe485ac3 Mon Sep 17 00:00:00 2001 From: Opliko Date: Tue, 16 Aug 2022 21:57:24 +0200 Subject: [PATCH] docs: explain what export routes actually do in OpenAPI documentation (#10836) --- public/openapi/read/user/userslug/export/posts.yaml | 1 + public/openapi/read/user/userslug/export/profile.yaml | 1 + public/openapi/read/user/userslug/export/uploads.yaml | 1 + 3 files changed, 3 insertions(+) diff --git a/public/openapi/read/user/userslug/export/posts.yaml b/public/openapi/read/user/userslug/export/posts.yaml index ce2da2309a..80132ab8ad 100644 --- 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 index ffa6b105cc..da0b6bec45 100644 --- 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 index 1f29cce6a2..cbe7a9aefa 100644 --- 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