aboutsummaryrefslogtreecommitdiffstats
path: root/www/swagger/spec-files/heroku-pets.yaml
diff options
context:
space:
mode:
Diffstat (limited to 'www/swagger/spec-files/heroku-pets.yaml')
-rw-r--r--www/swagger/spec-files/heroku-pets.yaml82
1 files changed, 82 insertions, 0 deletions
diff --git a/www/swagger/spec-files/heroku-pets.yaml b/www/swagger/spec-files/heroku-pets.yaml
new file mode 100644
index 0000000..ea93a93
--- /dev/null
+++ b/www/swagger/spec-files/heroku-pets.yaml
@@ -0,0 +1,82 @@
+swagger: '2.0'
+info:
+ version: 1.0.0
+ title: PetStore on Heroku
+ description: |
+ **This example has a working backend hosted in Heroku**
+
+ You can try all HTTP operation described in this Swagger spec.
+host: petstore-api.herokuapp.com
+basePath: /pet
+schemes:
+ - http
+ - https
+consumes:
+ - application/json
+ - text/xml
+produces:
+ - application/json
+ - text/html
+paths:
+ /:
+ get:
+ parameters:
+ - name: limit
+ in: query
+ description: number of pets to return
+ type: integer
+ default: 11
+ minimum: 11
+ maximum: 10000
+ responses:
+ 200:
+ description: List all pets
+ schema:
+ title: Pets
+ type: array
+ items:
+ $ref: '#/definitions/Pet'
+ post:
+ parameters:
+ - name: pet
+ in: body
+ description: The pet JSON you want to post
+ schema:
+ $ref: '#/definitions/Pet'
+ required: true
+ responses:
+ 200:
+ description: Make a new pet
+ put:
+ parameters:
+ - name: pet
+ in: body
+ description: The pet JSON you want to post
+ schema:
+ $ref: '#/definitions/Pet'
+ required: true
+ responses:
+ 200:
+ description: Updates the pet
+ /{petId}:
+ get:
+ parameters:
+ - name: petId
+ in: path
+ type: string
+ description: ID of the pet
+ required: true
+ responses:
+ 200:
+ description: Sends the pet with pet Id
+
+definitions:
+ Pet:
+ type: object
+ properties:
+ name:
+ type: string
+ birthday:
+ type: integer
+ format: int32
+