mirror of
https://github.com/NodeBB/NodeBB.git
synced 2026-08-02 01:10:51 +02:00
fix(writeapi): added examples to all parameter objects in schema
This commit is contained in:
@@ -3,6 +3,14 @@ put:
|
||||
- posts
|
||||
summary: edit a post
|
||||
description: This operation edits a post
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
@@ -38,6 +46,14 @@ delete:
|
||||
- posts
|
||||
summary: purge a post
|
||||
description: This operation purges a post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Post successfully purged
|
||||
|
||||
@@ -3,6 +3,14 @@ put:
|
||||
- posts
|
||||
summary: bookmark a post
|
||||
description: This operation bookmarks a post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Post successfully bookmarked
|
||||
@@ -21,6 +29,14 @@ delete:
|
||||
- posts
|
||||
summary: unbookmark a post
|
||||
description: This operation unbookmarks a post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Post successfully unbookmarked
|
||||
|
||||
@@ -3,6 +3,14 @@ put:
|
||||
- posts
|
||||
summary: restore a post
|
||||
description: This operation restores a post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Topic successfully restored
|
||||
@@ -21,6 +29,14 @@ delete:
|
||||
- posts
|
||||
summary: deletes a post
|
||||
description: This operation soft deletes a post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Post successfully deleted
|
||||
|
||||
@@ -3,6 +3,14 @@ put:
|
||||
- posts
|
||||
summary: vote on a post
|
||||
description: This operation casts a vote on a post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: pid
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: a valid post id
|
||||
example: 1
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
|
||||
Reference in New Issue
Block a user