-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
113 lines (112 loc) · 2.48 KB
/
swagger.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
swagger: '2.0'
info:
title: Tenlegs API
description: Sample API made for tenlegs
version: "0.0.1"
# the domain of the service
host: api.agrimasthana.com
# array of all schemes that your API supports
schemes:
- http
# will be prefixed to all paths
basePath: /tenlegs
produces:
- application/json
paths:
/user/:
get:
summary: Users
description: |
Get list of users.
parameters:
- name: id
in: query
description: Unique id of user.
required: false
type: number
format: int32
tags:
- User
responses:
200:
description: An array of users
schema:
type: array
items:
$ref: '#/definitions/User'
default:
description: Unexpected error
# /user/:
post:
summary: Create a user
description: |
create a new user.
parameters:
- name: User
in: body
schema:
$ref: '#/definitions/User'
tags:
- User
responses:
200:
description: created user
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
put:
summary: Update user
description: |
Update properties of a user.
parameters:
- name: id
in: query
description: Unique id of user.
required: false
type: number
format: int32
- name: User
in: body
schema:
$ref: '#/definitions/User'
tags:
- User
responses:
201:
description: updated
schema:
$ref: '#/definitions/User'
default:
description: Unexpected error
delete:
summary: Remove a user
description: |
Delete a user from the database.
parameters:
- name: id
in: query
description: Unique id of a user.
required: true
type: number
format: int32
tags:
- User
responses:
200:
description: deleted
default:
description: Something went wrong
definitions:
User:
type: object
properties:
user_id:
type: integer
description: lorem.
name:
type: string
description: Description of product.
date_joined:
type: string
description: Display name of product.