Test openapi schema of /follow/*

This commit is contained in:
2021-03-20 02:43:53 +01:00
parent 46cc61fc25
commit 0e5943864d
3 changed files with 87 additions and 2 deletions

View File

@@ -729,6 +729,48 @@ paths:
schema:
$ref: '#/components/schemas/ConstitutionResponse'
/articles/{article}/follows:
parameters:
- $ref: '#/components/parameters/article'
get:
security:
- JWTAuth: [ ]
summary: Return Follow or nothing if you not follow
tags:
- follow
- article
responses:
200:
description: Return your follow
content:
application/json:
schema:
$ref: '#/components/schemas/FollowResponse'
404:
description: You not follow this article
post:
security:
- JWTAuth: [ ]
summary: Follow one article
tags:
- follow
- article
responses:
201:
description: Return only http status 201 on success
delete:
security:
- JWTAuth: [ ]
summary: Unfollow one article
tags:
- follow
- article
responses:
204:
description: Return only http status 204 on success
401:
$ref: '#/components/responses/401'
components:
parameters:
page:
@@ -1343,6 +1385,32 @@ components:
type: string
format: 'date-time'
FollowResponse:
additionalProperties: false
required:
- id
- createdBy
- createdAt
- target
properties:
id:
$ref: '#/components/schemas/UUID'
createdBy:
$ref: '#/components/schemas/CitizenCreator'
createdAt:
type: string
format: 'date-time'
target:
required:
- id
- reference
additionalProperties: false
properties:
id:
$ref: '#/components/schemas/UUID'
reference:
type: string
securitySchemes:
JWTAuth:
type: http