-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yml
128 lines (128 loc) · 2.67 KB
/
swagger.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
swagger: '2.0'
info:
description: '.'
version: '1.0.0'
title: 'Armold template'
contact:
email: '[email protected]'
tags:
- name: 'country'
description: 'Everything about your countries'
schemes:
- 'https'
- 'http'
paths:
/country:
get:
tags:
- 'country'
summary: 'Finds countries with filter'
description: ''
produces:
- 'application/json'
parameters:
- name: '_limit'
in: 'query'
description: 'Limit'
required: false
type: 'integer'
format: 'int64'
- name: '_page'
in: 'query'
description: 'Page'
required: false
type: 'integer'
format: 'int64'
- name: 'code'
in: 'query'
description: 'Country code'
required: false
type: 'string'
- name: 'name'
in: 'query'
description: 'Country name'
required: false
type: 'string'
- name: 'sort'
in: 'query'
description: 'Sort'
required: false
type: 'array'
items:
type: 'string'
enum:
- 'name'
default: 'name'
responses:
'200':
description: 'successful operation'
schema:
$ref: '#/definitions/ApiResponse'
'400':
description: 'Invalid status value'
'404':
description: 'Invalid status value'
definitions:
Country:
type: 'object'
properties:
id:
type: 'integer'
format: 'int64'
code:
type: 'string'
description: 'int64'
name:
type: 'string'
states:
type: 'array'
items:
$ref: '#/definitions/State'
State:
type: 'object'
properties:
id:
type: 'integer'
format: 'int64'
name:
type: 'string'
cities:
type: 'array'
items:
$ref: '#/definitions/City'
City:
type: 'object'
properties:
id:
type: 'integer'
format: 'int64'
name:
type: 'string'
localities:
type: 'array'
items:
$ref: '#/definitions/Locality'
Locality:
type: 'object'
properties:
id:
type: 'integer'
format: 'int64'
name:
type: 'string'
ApiResponse:
type: 'object'
properties:
limit:
type: 'integer'
format: 'int32'
page:
type: 'integer'
format: 'int32'
total:
type: 'integer'
format: 'int32'
results:
type: 'array'
items:
$ref: '#/definitions/Country'