-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathsample-petstore.yaml
More file actions
169 lines (169 loc) · 3.93 KB
/
sample-petstore.yaml
File metadata and controls
169 lines (169 loc) · 3.93 KB
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
openapi: 3.0.0
info:
title: Petstore API
version: 1.0.0
description: A simple API for managing a pet store
servers:
- url: https://petstore.example.com/api/v1
paths:
/pets:
get:
summary: List all pets
operationId: listPets
tags:
- pets
parameters:
- name: limit
in: query
description: How many items to return at one time (max 100)
required: false
schema:
type: integer
format: int32
minimum: 1
maximum: 100
responses:
'200':
description: A paged array of pets
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Pet'
'400':
description: Bad request
'500':
description: Internal server error
post:
summary: Create a pet
operationId: createPet
tags:
- pets
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
responses:
'201':
description: Pet created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
'400':
description: Invalid input
'500':
description: Internal server error
/pets/{petId}:
get:
summary: Info for a specific pet
operationId: showPetById
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to retrieve
schema:
type: string
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
'404':
description: Pet not found
'500':
description: Internal server error
put:
summary: Update a pet
operationId: updatePet
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to update
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
responses:
'200':
description: Pet updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Pet'
'400':
description: Invalid input
'404':
description: Pet not found
'500':
description: Internal server error
delete:
summary: Delete a pet
operationId: deletePet
tags:
- pets
parameters:
- name: petId
in: path
required: true
description: The id of the pet to delete
schema:
type: string
responses:
'204':
description: Pet deleted successfully
'404':
description: Pet not found
'500':
description: Internal server error
components:
schemas:
Pet:
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
minLength: 1
maxLength: 100
tag:
type: string
maxLength: 50
status:
type: string
enum:
- available
- pending
- sold
price:
type: number
format: float
minimum: 0
category:
type: string
enum:
- dog
- cat
- bird
- fish
- other