-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.yaml
149 lines (143 loc) · 3.34 KB
/
api.yaml
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
145
146
147
148
149
swagger: '2.0'
info:
title: 'Travelist app'
version: '1.0'
basePath: '/v1'
schemes:
- 'http'
tags:
- name: 'offer'
description: 'Offers operations'
definitions:
Offer:
type: object
required:
- id
- title
- description
- img_url
- price
- status
- created_at
properties:
id:
type: integer
format: int64
title:
type: string
maxLength: 255
description:
type: string
maxLength: 1024
img_url:
type: string
maxLength: 1024
price:
type: integer
format: 'int32'
minimum: 1
maximum: 1000
discount:
type: integer
format: 'int32'
minimum: 1
maximum: 99
rating:
type: integer
format: 'int32'
minimum: 1
maximum: 5
status:
type: string
enum: &offerStatusEnum
- 'published'
- 'in_progress'
- 'waiting_for_approval'
- 'canceled'
created_at:
type: string
format: date-time
paths:
/offers:
get:
summary: 'Get list of all offers'
tags:
- 'offer'
security:
- oath:
- "read:offer"
produces:
- 'application/json'
parameters:
- name: 'limit'
in: 'query'
type: 'integer'
minimum: 1
default: 20
maximum: 50
- name: 'offset'
in: 'query'
type: 'integer'
minimum: 0
- name: 'sort'
in: 'query'
type: 'string'
default: 'id'
enum:
- 'id'
- '-id'
- 'title'
- '-title'
- 'price'
- '-price'
- 'discount'
- '-discount'
- name: 'title'
in: 'query'
type: 'string'
description: 'Filter for query by title'
- name: 'status'
in: 'query'
description: 'Filter for query by status'
type: 'string'
enum: *offerStatusEnum
responses:
200:
description: 'Successful response'
schema:
type: 'array'
minItems: 10
items:
$ref: '#/definitions/Offer'
headers:
X-Limit: &XLimit
type: 'integer'
minimum: 10
description: "Limit of results used in query"
X-Offset: &XOffset
type: 'integer'
minimum: 0
description: "Offset of results used in query"
X-Total-Count: &XTotalCount
type: 'integer'
minimum: 0
description: "Total records"
/offers/{offer_id}:
get:
summary: 'Get offer data in json format'
tags:
- 'offer'
produces:
- 'application/json'
parameters:
- name: 'offer_id'
in: 'path'
type: 'integer'
required: true
responses:
200:
description: 'Successful response'
schema:
$ref: '#/definitions/Offer'
404:
description: 'Invalid id'