Skip to content

Commit 620e905

Browse files
committed
Transferring API Description file from Apiary.io
1 parent c2af154 commit 620e905

File tree

1 file changed

+139
-0
lines changed

1 file changed

+139
-0
lines changed

swagger.yaml

Lines changed: 139 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
1+
swagger: "2.0"
2+
info:
3+
version: 1.0.0
4+
title: Swagger integration test
5+
description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification
6+
termsOfService: http://swagger.io/terms/
7+
contact:
8+
name: Swagger API Team
9+
10+
url: http://madskristensen.net
11+
license:
12+
name: MIT
13+
url: http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT
14+
host: petstore.swagger.io
15+
basePath: /api
16+
schemes:
17+
- http
18+
consumes:
19+
- application/json
20+
produces:
21+
- application/json
22+
paths:
23+
/pets:
24+
get:
25+
description: |
26+
Returns all pets from the system that the user has access to
27+
Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.
28+
Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.
29+
operationId: findPets
30+
parameters:
31+
- name: tags
32+
in: query
33+
description: tags to filter by
34+
required: false
35+
type: array
36+
collectionFormat: csv
37+
items:
38+
type: string
39+
- name: limit
40+
in: query
41+
description: maximum number of results to return
42+
required: false
43+
type: integer
44+
format: int32
45+
responses:
46+
200:
47+
description: pet response
48+
schema:
49+
type: array
50+
items:
51+
$ref: '#/definitions/Pet'
52+
default:
53+
description: unexpected error
54+
schema:
55+
$ref: '#/definitions/Error'
56+
post:
57+
description: Creates a new pet in the store. Duplicates are allowed
58+
operationId: addPet
59+
parameters:
60+
- name: pet
61+
in: body
62+
description: Pet to add to the store
63+
required: true
64+
schema:
65+
$ref: '#/definitions/NewPet'
66+
responses:
67+
200:
68+
description: pet response
69+
schema:
70+
$ref: '#/definitions/Pet'
71+
default:
72+
description: unexpected error
73+
schema:
74+
$ref: '#/definitions/Error'
75+
/pets/{id}:
76+
get:
77+
description: Returns a user based on a single ID, if the user does not have access to the pet
78+
operationId: find pet by id
79+
parameters:
80+
- name: id
81+
in: path
82+
description: ID of pet to fetch
83+
required: true
84+
type: integer
85+
format: int64
86+
responses:
87+
200:
88+
description: pet response
89+
schema:
90+
$ref: '#/definitions/Pet'
91+
default:
92+
description: unexpected error
93+
schema:
94+
$ref: '#/definitions/Error'
95+
delete:
96+
description: deletes a single pet based on the ID supplied
97+
operationId: deletePet
98+
parameters:
99+
- name: id
100+
in: path
101+
description: ID of pet to delete
102+
required: true
103+
type: integer
104+
format: int64
105+
responses:
106+
204:
107+
description: pet deleted
108+
default:
109+
description: unexpected error
110+
schema:
111+
$ref: '#/definitions/Error'
112+
definitions:
113+
Pet:
114+
allOf:
115+
- $ref: '#/definitions/NewPet'
116+
- required:
117+
- id
118+
properties:
119+
id:
120+
type: integer
121+
format: int64
122+
NewPet:
123+
required:
124+
- name
125+
properties:
126+
name:
127+
type: string
128+
tag:
129+
type: string
130+
Error:
131+
required:
132+
- code
133+
- message
134+
properties:
135+
code:
136+
type: integer
137+
format: int32
138+
message:
139+
type: string

0 commit comments

Comments
 (0)