Skip to content

Instantly share code, notes, and snippets.

@shockey
Created November 30, 2017 21:37
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save shockey/51637bfa7443ffff0e422208f977eff2 to your computer and use it in GitHub Desktop.
Save shockey/51637bfa7443ffff0e422208f977eff2 to your computer and use it in GitHub Desktop.
3.0.0 Petstore with path and operation level `servers`
openapi: "3.0.0"
info:
version: 1.0.0
title: Swagger Petstore
license:
name: MIT
servers:
- url: http://petstore.swagger.io/v1
- url: http://petstore.swagger.io/v1/{myNum}/{myEnum}
variables:
myNum:
default: "1"
description: A number that accepts any value
myEnum:
default: "1"
enum: ["1", "2", "3"]
description: An enum number
paths:
/pets:
servers:
- url: http://path-level-server.swagger.io/v2
- url: http://path-level-server-2.swagger.io/v2/{myNum}/{myEnum}
variables:
myNum:
default: "1"
description: A number that accepts any value
myEnum:
default: "1"
enum: ["1", "2", "3"]
description: An enum number
get:
servers:
- url: http://operation-level-server.swagger.io/v3
- url: http://operation-level-server.swagger.io/v3/{myNum}/{myEnum}
description: An operation-level server definition
variables:
myNum:
default: "1"
description: A number that accepts any value
myEnum:
default: "1"
enum: ["1", "2", "3"]
description: An enum number
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
responses:
'200':
description: An paged array of pets
headers:
x-next:
description: A link to the next page of responses
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
post:
summary: Create a pet
operationId: createPets
tags:
- pets
responses:
'201':
description: Null response
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/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/Pets"
default:
description: unexpected error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
components:
schemas:
Pet:
required:
- id
- name
properties:
id:
type: integer
format: int64
name:
type: string
tag:
type: string
Pets:
type: array
items:
$ref: "#/components/schemas/Pet"
Error:
required:
- code
- message
properties:
code:
type: integer
format: int32
message:
type: string
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment