feat: doc add description

4 years ago · cc560ca3f9
parent 8e85a28d85
commit cc560ca3f9
1 changed files with 2 additions and 1 deletions
--- a/public/openapi/read/recent/posts/term.yaml
+++ b/public/openapi/read/recent/posts/term.yaml
@ -8,7 +8,8 @@ get:
      required: true
      schema:
        type: string
-      example: day, week, month. If not passed the latest posts will be returned without limiting by date.
+      example: /api/recent/posts/day
+      description: term is used to limit the returned posts to a specific term. Valid values are day, week, month. If you don't pass it in all posts will be returned.
    - name: page
      in: query
      required: false