-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
106 lines (94 loc) · 2.48 KB
/
openapi.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
openapi: 3.0.2
info:
title: Robotics API
description: My first test API
version: '1'
termsOfService: 'http://localhost:8000/api/'
contact:
name: Robotics API
url: 'http://localhost:8000/api/'
email: [email protected]
servers:
- url: 'http://localhost:8000/api/v1/'
paths:
/user/list:
get:
tags:
- All users data
summary: "Get all users data"
operationId: AllUsers
parameters:
- $ref: '#/components/parameters/id'
- $ref: '#/components/parameters/username'
- $ref: '#/components/parameters/firstname'
- $ref: '#/components/parameters/email'
responses:
'200':
description: Successful response
content:
application/json:
schema:
- $ref: '#/components/schemas/200'
'404':
description: Not found response
content:
text/plain:
schema:
title: User not found
type: string
example: Not found
components:
parameters:
id:
name: id
in: query
description: "unique user id"
schema:
type: string
username:
name: username
in: query
description: "username user"
schema:
type: string
firstname:
name: first_name
in: query
description: "First name user"
schema:
type: string
email:
name: email
in: query
description: "Email [email protected] format"
schema:
type: string
schemas:
200:
title: User list
type: object
properties:
id:
type: number
items:
$ref: '#/components/parameters/id'
description: Placeholder description
example: 1
username:
type: string
items:
$ref: '#/components/parameters/username'
description: Username user
example: username
firstname:
type: string
items:
$ref: '#/components/parameters/firstname'
description: Firstname user
example: Adam
email:
type: string
items:
$ref: '#/components/parameters/email'
description: Email user
example: [email protected]