feature #11: describe "get/edit comment to article" in openAPI

This commit is contained in:
2019-08-30 09:42:35 +02:00
parent 639b839058
commit 31f1504e56

View File

@@ -245,6 +245,45 @@ paths:
application/json: application/json:
schema: schema:
$ref: '#/components/schemas/CommentResponse' $ref: '#/components/schemas/CommentResponse'
/articles/{article}/comments:
parameters:
- name: article
in: path
description: The ID of article
example: e74be8e4-6823-47c4-bd1b-789725b2fa8e
required: true
schema:
type: string
format: uuid
get:
summary: Get comment and children of one article
tags:
- comment
responses:
200:
description: Return Comment and children
content:
application/json:
schema:
$ref: '#/components/schemas/CommentResponse'
post:
security:
- JWTAuth: []
summary: Create Comment to article
tags:
- comment
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CommentRequest'
responses:
200:
description: Return Comment and children
content:
application/json:
schema:
$ref: '#/components/schemas/CommentResponse'
components: components: