From 653c107f5f797f159b7b4dd02097baa2a2b031e7 Mon Sep 17 00:00:00 2001 From: Kester Date: Tue, 24 Sep 2024 17:54:51 -0400 Subject: [PATCH] added openapi documentation --- public/openapi/write.yaml | 4 +++- public/openapi/write/posts/pid/verify.yaml | 26 ++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 public/openapi/write/posts/pid/verify.yaml diff --git a/public/openapi/write.yaml b/public/openapi/write.yaml index c59b9bce29..aea404e425 100644 --- a/public/openapi/write.yaml +++ b/public/openapi/write.yaml @@ -186,6 +186,8 @@ paths: $ref: 'write/posts/pid/upvoters.yaml' /posts/{pid}/bookmark: $ref: 'write/posts/pid/bookmark.yaml' + /posts/{pid}/verify: + $ref: 'write/posts/pid/verify.yaml' /posts/{pid}/diffs: $ref: 'write/posts/pid/diffs.yaml' /posts/{pid}/diffs/{since}: @@ -261,4 +263,4 @@ paths: /files/: $ref: 'write/files.yaml' /files/folder: - $ref: 'write/files/folder.yaml' \ No newline at end of file + $ref: 'write/files/folder.yaml' diff --git a/public/openapi/write/posts/pid/verify.yaml b/public/openapi/write/posts/pid/verify.yaml new file mode 100644 index 0000000000..d5f6c8517f --- /dev/null +++ b/public/openapi/write/posts/pid/verify.yaml @@ -0,0 +1,26 @@ +put: + tags: + - posts + summary: verifies a post + description: This operation verifies a post. + parameters: + - in: path + name: pid + schema: + type: string + required: true + description: a valid post id + example: 2 + responses: + '200': + description: Post successfully verified + content: + application/json: + schema: + type: object + properties: + status: + $ref: ../../../components/schemas/Status.yaml#/Status + response: + type: object + properties: {}