Test openapi schema of

POST/GET /constitutions/{constitution}/comments
GET /citizens/{citizen}/comments/constitutions
This commit is contained in:
2021-03-17 22:07:14 +01:00
parent 564d612e9a
commit 78a6cc417c
4 changed files with 238 additions and 12 deletions

View File

@@ -621,6 +621,75 @@ paths:
$ref: '#/components/schemas/CommentResponse'
401:
$ref: '#/components/responses/401'
/citizens/{citizen}/comments/constitutions:
parameters:
- $ref: '#/components/parameters/citizen'
get:
security:
- JWTAuth: []
summary: all constitution comments for one citizen
tags:
- comment
- constitution
- citizen
responses:
200:
description: Comments
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Paginated'
- type: object
properties:
result:
type: array
items:
$ref: '#/components/schemas/CommentResponse'
401:
$ref: '#/components/responses/401'
/constitutions/{constitution}/comments:
parameters:
- $ref: '#/components/parameters/constitution'
get:
summary: Get comment and children of one constitution
tags:
- comment
- constitution
responses:
200:
description: Return Comment and children
content:
application/json:
schema:
$ref: '#/components/schemas/CommentResponse'
post:
security:
- JWTAuth: []
summary: Create Comment to constitution
tags:
- comment
- constitution
requestBody:
content:
application/json:
schema:
required:
- content
properties:
content:
type: string
example:
Lorem ipsum...
responses:
201:
description: Return created comment
content:
application/json:
schema:
$ref: '#/components/schemas/CommentResponse'
401:
$ref: '#/components/responses/401'
components:
parameters:
@@ -724,6 +793,16 @@ components:
type: string
format: uuid
constitution:
name: constitution
in: path
required: true
description: the ID of constitution
example: e74be8e4-6823-47c4-bd1b-789725b2fa8e
schema:
type: string
format: uuid
responses:
401:
description: Unautorized