forked from verkhovin/team.ktrep
-
Notifications
You must be signed in to change notification settings - Fork 0
/
nsoa-contract.yml
144 lines (144 loc) · 3.12 KB
/
nsoa-contract.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
openapi: "3.0.0"
info:
title: NSOA
version: "1.0"
paths:
/content/preview/{userId}:
get:
description: |
Returns tiles list for specific user.
parameters:
- name: userId
in: path
description: ID of user
required: true
schema:
type: integer
format: int64
responses:
'200':
description: tiles
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tile'
/content/feed/{userId}/{tileId}:
get:
description: |
Get feed for user by that are relevant to selected tile
parameters:
- name: userId
in: path
required: true
schema:
type: integer
format: int64
- name: tileId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: feed
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Item'
/content/article/{id}:
get:
description: |
get article content
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: article
content:
application/json:
schema:
$ref: '#/components/schemas/Article'
components:
schemas:
Tile:
type: object
properties:
id:
type: string
type:
$ref: '#/components/schemas/ContentType'
score:
type: number
isWatched:
type: boolean
body:
$ref: '#/components/schemas/TileBody'
TileBody:
type: object
properties:
text:
type: string
image:
type: string
videoUrl:
type: string
Item:
type: object
properties:
id:
type: string
type:
$ref: '#/components/schemas/ContentType'
score:
type: number
created:
type: string
format: date
body:
$ref: '#/components/schemas/ItemBody'
ItemBody:
type: object
properties:
reaction:
$ref: '#/components/schemas/Reaction'
text:
type: string
image:
type: string
video:
type: string
articleId:
type: string
Reaction:
type: object
properties:
action:
type: string
enum: [like, dislike, none]
isBookmarked:
type: boolean
Article:
type: object
properties:
id:
type: string
reaction:
$ref: '#/components/schemas/Reaction'
created:
type: string
format: date
content:
type: string
ContentType:
type: string
enum: [alert, warning, content]