fix(writeapi): added examples to all parameter objects in schema

This commit is contained in:
Julian Lam
2020-10-24 12:40:52 -04:00
parent b156b8b573
commit 93f65f89e7
19 changed files with 186 additions and 0 deletions

View File

@@ -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

View File

@@ -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

View File

@@ -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

View File

@@ -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: