Skip to content

Commit 5fb6c56

Browse files
committed
Merge pull request #71 from earth2marsh/patch-3
Adding a simple YAML example
2 parents 060e8b3 + 9b7342d commit 5fb6c56

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

examples/wordnik/petstore.yaml

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
swagger: 2.0
2+
info:
3+
version: 1.0.0
4+
title: Swagger Petstore
5+
host: petstore.swagger.wordnik.com
6+
basePath: /v1
7+
license:
8+
name: MIT
9+
schemes:
10+
- http
11+
consumes:
12+
- application/json
13+
produces:
14+
- application/json
15+
paths:
16+
/pets:
17+
get:
18+
summary: List all pets
19+
operationId: listPets
20+
tags:
21+
- pets
22+
parameters:
23+
- name: limit
24+
in: query
25+
description: How many items to return at one time (max 100)
26+
required: false
27+
type: integer
28+
responses:
29+
200:
30+
description: An paged array of pets
31+
headers:
32+
- x-next:
33+
type: string
34+
description: A link to the next page of responses
35+
schema:
36+
$ref: Pets
37+
default:
38+
description: unexpected error
39+
schema:
40+
$ref: Error
41+
post:
42+
summary: Create a pet
43+
operationId: createPets
44+
tags:
45+
- pets
46+
responses:
47+
201:
48+
description: Null response
49+
default:
50+
description: unexpected error
51+
schema:
52+
$ref: Error
53+
/pets/{petId}:
54+
get:
55+
summary: Info for a specific pet
56+
operationId: showPetById
57+
tags:
58+
- pets
59+
parameters:
60+
- name: petId
61+
in: path
62+
description: The id of the pet to retrieve
63+
type: string
64+
responses:
65+
200:
66+
description: Expected response to a valid request
67+
schema:
68+
$ref: Pets
69+
default:
70+
description: unexpected error
71+
schema:
72+
$ref: Error
73+
schemas:
74+
Pet:
75+
required:
76+
- id
77+
- name
78+
properties:
79+
id:
80+
type: integer
81+
format: int64
82+
name:
83+
type: string
84+
tag:
85+
type: string
86+
Pets:
87+
type: array
88+
items:
89+
$ref: Pet
90+
Error:
91+
required:
92+
- code
93+
- message
94+
properties:
95+
code:
96+
type: integer
97+
format: int32
98+
message:
99+
type: string

0 commit comments

Comments
 (0)