models.swagger.examples.petstore-examples.petstore.yaml Maven / Gradle / Ivy
swagger: "2.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
host: petstore.swagger.io
basePath: /v1
schemes:
- http
consumes:
- application/json
produces:
- application/json
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
type: integer
format: int32
responses:
200:
description: An paged array of pets
headers:
x-next:
type: string
description: A link to the next page of responses
examples:
application/json:
-
id: 1
tag: dog
name: Toto
-
id: 2
tag: cat
name: Garfield
-
id: 3
tag: dog
name: Snoopy
-
id: 4
tag: rat
name: Remy
-
id: 5
tag: lizard
name: Rango
schema:
$ref: "#/definitions/Pets"
default:
description: unexpected error
schema:
$ref: "#/definitions/Error"
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
201:
description: New Pet record added successfully
examples:
application/json:
id: 1
tag: dog
name: Toto
default:
description: unexpected error
schema:
$ref: "#/definitions/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
type: string
responses:
200:
description: Expected response to a valid request
schema:
$ref: "#/definitions/Pet"
examples:
application/json:
id: 1
name: Toto
tag: dog
default:
description: unexpected error
schema:
$ref: "#/definitions/Error"
definitions:
Pet:
type: object
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: "#/definitions/Pet"
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string