-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
170 lines (170 loc) · 3.86 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
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
swagger: "2.0"
info:
description: "Student enrollment service"
version: "1.0.0"
title: "Student enrollment"
basePath: "/v2"
tags:
- name: "student"
description: "Student enrollment endpoints"
externalDocs:
description: "Git url"
url: "https://github.com/Cinojose/StudentEnrollmentApi"
schemes:
- "http"
paths:
/student:
post:
tags:
- "student"
summary: "Add a new student"
description: ""
operationId: "addStudent"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Student to enroll"
required: true
schema:
$ref: "#/definitions/Student"
responses:
405:
description: "Method not allowed"
500:
description: "Invalid Input"
200:
description: "Student updated"
put:
tags:
- "student"
summary: "Update an existing student"
description: ""
operationId: "updateStudent"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Student object need to update"
required: true
schema:
type: object
properties:
id:
type: "integer"
example: 23454
class:
type: "string"
example: "3 C"
responses:
405:
description: "Invalid input"
200:
description: "Student updated"
delete:
tags:
- "student"
summary: "Deletes a student"
description: ""
operationId: "deleteStudent"
consumes:
- "application/json"
- "application/xml"
produces:
- "application/xml"
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Student object need to delete"
required: true
schema:
type: object
properties:
id:
type: "integer"
example: 23454
responses:
200:
description: "Student deleted"
400:
description: "Invalid ID supplied"
404:
description: "Pet not found"
/fetchStudents:
get:
tags:
- "student"
summary: "Finds students by multiple options"
description: "Multiple status values can be provided with comma separated strings"
operationId: "findStudentsByStatus"
produces:
- "application/json"
parameters:
- name: "Id"
in: "query"
description: "find by id of the student"
type: "integer"
- name: "class"
in: "query"
description: "Find students by class"
type: "string"
responses:
200:
description: "successful operation"
schema:
type: "array"
items:
$ref: '#/definitions/Student'
400:
description: "Invalid status value"
definitions:
Student:
type: "object"
required:
- "id"
- "firstName"
- "lastName"
- "class"
- "nationality"
properties:
id:
type: "integer"
format: "int64"
firstName:
type: "string"
example: "mike"
lastName:
type: "string"
example: "wong"
class:
type: "string"
example: "3 A"
nationality:
type: "string"
example: "Singapore"
xml:
name: "Student"
ApiResponse:
type: "object"
properties:
code:
type: "integer"
format: "int32"
type:
type: "string"
message:
type: "string"
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"