diff --git a/examples/v2.0/json/api-with-examples.json b/examples/v2.0/json/api-with-examples.json
new file mode 100644
index 0000000000..e1b371a070
--- /dev/null
+++ b/examples/v2.0/json/api-with-examples.json
@@ -0,0 +1,58 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Simple API overview",
+ "version": "v2"
+ },
+ "paths": {
+ "/": {
+ "get": {
+ "operationId": "listVersionsv2",
+ "summary": "List API versions",
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "200 300 response",
+ "examples": {
+ "application/json": "{\n \"versions\": [\n {\n \"status\": \"CURRENT\",\n \"updated\": \"2011-01-21T11:33:21Z\",\n \"id\": \"v2.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v2/\",\n \"rel\": \"self\"\n }\n ]\n },\n {\n \"status\": \"EXPERIMENTAL\",\n \"updated\": \"2013-07-23T11:33:21Z\",\n \"id\": \"v3.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v3/\",\n \"rel\": \"self\"\n }\n ]\n }\n ]\n}"
+ }
+ },
+ "300": {
+ "description": "200 300 response",
+ "examples": {
+ "application/json": "{\n \"versions\": [\n {\n \"status\": \"CURRENT\",\n \"updated\": \"2011-01-21T11:33:21Z\",\n \"id\": \"v2.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v2/\",\n \"rel\": \"self\"\n }\n ]\n },\n {\n \"status\": \"EXPERIMENTAL\",\n \"updated\": \"2013-07-23T11:33:21Z\",\n \"id\": \"v3.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v3/\",\n \"rel\": \"self\"\n }\n ]\n }\n ]\n}"
+ }
+ }
+ }
+ }
+ },
+ "/v2": {
+ "get": {
+ "operationId": "getVersionDetailsv2",
+ "summary": "Show API version details",
+ "produces": [
+ "application/json"
+ ],
+ "responses": {
+ "200": {
+ "description": "200 203 response",
+ "examples": {
+ "application/json": "{\n \"version\": {\n \"status\": \"CURRENT\",\n \"updated\": \"2011-01-21T11:33:21Z\",\n \"media-types\": [\n {\n \"base\": \"application/xml\",\n \"type\": \"application/vnd.openstack.compute+xml;version=2\"\n },\n {\n \"base\": \"application/json\",\n \"type\": \"application/vnd.openstack.compute+json;version=2\"\n }\n ],\n \"id\": \"v2.0\",\n \"links\": [\n {\n \"href\": \"http://127.0.0.1:8774/v2/\",\n \"rel\": \"self\"\n },\n {\n \"href\": \"http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf\",\n \"type\": \"application/pdf\",\n \"rel\": \"describedby\"\n },\n {\n \"href\": \"http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl\",\n \"type\": \"application/vnd.sun.wadl+xml\",\n \"rel\": \"describedby\"\n },\n {\n \"href\": \"http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl\",\n \"type\": \"application/vnd.sun.wadl+xml\",\n \"rel\": \"describedby\"\n }\n ]\n }\n}"
+ }
+ },
+ "203": {
+ "description": "200 203 response",
+ "examples": {
+ "application/json": "{\n \"version\": {\n \"status\": \"CURRENT\",\n \"updated\": \"2011-01-21T11:33:21Z\",\n \"media-types\": [\n {\n \"base\": \"application/xml\",\n \"type\": \"application/vnd.openstack.compute+xml;version=2\"\n },\n {\n \"base\": \"application/json\",\n \"type\": \"application/vnd.openstack.compute+json;version=2\"\n }\n ],\n \"id\": \"v2.0\",\n \"links\": [\n {\n \"href\": \"http://23.253.228.211:8774/v2/\",\n \"rel\": \"self\"\n },\n {\n \"href\": \"http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf\",\n \"type\": \"application/pdf\",\n \"rel\": \"describedby\"\n },\n {\n \"href\": \"http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl\",\n \"type\": \"application/vnd.sun.wadl+xml\",\n \"rel\": \"describedby\"\n }\n ]\n }\n}"
+ }
+ }
+ }
+ }
+ }
+ },
+ "consumes": [
+ "application/json"
+ ]
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-expanded.json b/examples/v2.0/json/petstore-expanded.json
index 01d280973d..0c59f9a48e 100644
--- a/examples/v2.0/json/petstore-expanded.json
+++ b/examples/v2.0/json/petstore-expanded.json
@@ -207,4 +207,4 @@
}
}
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-separate/common/Error.json b/examples/v2.0/json/petstore-separate/common/Error.json
index 9f0e0aeec0..dd0e65a0fa 100644
--- a/examples/v2.0/json/petstore-separate/common/Error.json
+++ b/examples/v2.0/json/petstore-separate/common/Error.json
@@ -13,4 +13,4 @@
"type": "string"
}
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-separate/spec/NewPet.json b/examples/v2.0/json/petstore-separate/spec/NewPet.json
index 9966fb0278..9104f7f68a 100644
--- a/examples/v2.0/json/petstore-separate/spec/NewPet.json
+++ b/examples/v2.0/json/petstore-separate/spec/NewPet.json
@@ -16,4 +16,4 @@
}
}
]
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-separate/spec/Pet.json b/examples/v2.0/json/petstore-separate/spec/Pet.json
index 28e7d61c32..c7ee9fbb05 100644
--- a/examples/v2.0/json/petstore-separate/spec/Pet.json
+++ b/examples/v2.0/json/petstore-separate/spec/Pet.json
@@ -16,4 +16,4 @@
"type": "string"
}
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-separate/spec/parameters.json b/examples/v2.0/json/petstore-separate/spec/parameters.json
index 98bb1ace91..a7c11b0a0c 100644
--- a/examples/v2.0/json/petstore-separate/spec/parameters.json
+++ b/examples/v2.0/json/petstore-separate/spec/parameters.json
@@ -18,4 +18,4 @@
"type": "integer",
"format": "int32"
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-separate/spec/swagger.json b/examples/v2.0/json/petstore-separate/spec/swagger.json
index 01e8b1b602..542b76fc2a 100644
--- a/examples/v2.0/json/petstore-separate/spec/swagger.json
+++ b/examples/v2.0/json/petstore-separate/spec/swagger.json
@@ -143,4 +143,4 @@
}
}
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore-simple.json b/examples/v2.0/json/petstore-simple.json
index a088d1a1be..306dc90c9c 100644
--- a/examples/v2.0/json/petstore-simple.json
+++ b/examples/v2.0/json/petstore-simple.json
@@ -86,7 +86,7 @@
"description": "Pet to add to the store",
"required": true,
"schema": {
- "$ref": "#/definitions/PetInput"
+ "$ref": "#/definitions/NewPet"
}
}
],
@@ -170,33 +170,14 @@
},
"definitions": {
"Pet": {
- "type": "object",
- "required": [
- "id",
- "name"
- ],
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "tag": {
- "type": "string"
- }
- }
- },
- "PetInput": {
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Pet"
+ "$ref": "#/definitions/NewPet"
},
{
"required": [
- "name"
+ "id"
],
"properties": {
"id": {
@@ -207,6 +188,20 @@
}
]
},
+ "NewPet": {
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "tag": {
+ "type": "string"
+ }
+ }
+ },
"ErrorModel": {
"type": "object",
"required": [
diff --git a/examples/v2.0/json/petstore-with-external-docs.json b/examples/v2.0/json/petstore-with-external-docs.json
index 3e0fb73187..4c5154c233 100644
--- a/examples/v2.0/json/petstore-with-external-docs.json
+++ b/examples/v2.0/json/petstore-with-external-docs.json
@@ -181,37 +181,14 @@
},
"definitions": {
"Pet": {
- "type": "object",
- "required": [
- "id",
- "name"
- ],
- "externalDocs": {
- "description": "find more info here",
- "url": "https://swagger.io/about"
- },
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "tag": {
- "type": "string"
- }
- }
- },
- "NewPet": {
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Pet"
+ "$ref": "#/definitions/NewPet"
},
{
"required": [
- "name"
+ "id"
],
"properties": {
"id": {
@@ -222,6 +199,20 @@
}
]
},
+ "NewPet": {
+ "type": "object",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "tag": {
+ "type": "string"
+ }
+ }
+ },
"ErrorModel": {
"type": "object",
"required": [
@@ -239,4 +230,4 @@
}
}
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/petstore.json b/examples/v2.0/json/petstore.json
index bb1fcb3b94..16889b3c0b 100644
--- a/examples/v2.0/json/petstore.json
+++ b/examples/v2.0/json/petstore.json
@@ -3,38 +3,99 @@
"info": {
"version": "1.0.0",
"title": "Swagger Petstore",
- "contact": {
- "name": "Swagger API Team",
- "url": "http://swagger.io"
- },
"license": {
- "name": "Creative Commons 4.0 International",
- "url": "http://creativecommons.org/licenses/by/4.0/"
+ "name": "MIT"
}
},
"host": "petstore.swagger.io",
- "basePath": "/api",
+ "basePath": "/v1",
"schemes": [
"http"
],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
"paths": {
"/pets": {
"get": {
- "tags": [ "Pet Operations" ],
- "summary": "finds pets in the system",
+ "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": "pet response",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Pet"
- }
- },
+ "description": "An paged array of pets",
"headers": {
- "x-expires": {
- "type": "string"
+ "x-next": {
+ "type": "string",
+ "description": "A link to the next page of responses"
}
+ },
+ "schema": {
+ "$ref": "#/definitions/Pets"
+ }
+ },
+ "default": {
+ "description": "unexpected error",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ },
+ "post": {
+ "summary": "Create a pet",
+ "operationId": "createPets",
+ "tags": [
+ "pets"
+ ],
+ "responses": {
+ "201": {
+ "description": "Null response"
+ },
+ "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",
+ "description": "The id of the pet to retrieve",
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Expected response to a valid request",
+ "schema": {
+ "$ref": "#/definitions/Pets"
}
},
"default": {
@@ -49,7 +110,6 @@
},
"definitions": {
"Pet": {
- "type": "object",
"required": [
"id",
"name"
@@ -67,8 +127,13 @@
}
}
},
+ "Pets": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Pet"
+ }
+ },
"Error": {
- "type": "object",
"required": [
"code",
"message"
@@ -84,4 +149,4 @@
}
}
}
-}
+}
\ No newline at end of file
diff --git a/examples/v2.0/json/uber.json b/examples/v2.0/json/uber.json
new file mode 100644
index 0000000000..5c9a637785
--- /dev/null
+++ b/examples/v2.0/json/uber.json
@@ -0,0 +1,372 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "Uber API",
+ "description": "Move your app forward with the Uber API",
+ "version": "1.0.0"
+ },
+ "host": "api.uber.com",
+ "schemes": [
+ "https"
+ ],
+ "basePath": "/v1",
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/products": {
+ "get": {
+ "summary": "Product Types",
+ "description": "The Products endpoint returns information about the Uber products offered at a given location. The response includes the display name and other details about each product, and lists the products in the proper display order.",
+ "parameters": [
+ {
+ "name": "latitude",
+ "in": "query",
+ "description": "Latitude component of location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ },
+ {
+ "name": "longitude",
+ "in": "query",
+ "description": "Longitude component of location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ }
+ ],
+ "tags": [
+ "Products"
+ ],
+ "responses": {
+ "200": {
+ "description": "An array of products",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Product"
+ }
+ }
+ },
+ "default": {
+ "description": "Unexpected error",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/estimates/price": {
+ "get": {
+ "summary": "Price Estimates",
+ "description": "The Price Estimates endpoint returns an estimated price range for each product offered at a given location. The price estimate is provided as a formatted string with the full price range and the localized currency symbol.
The response also includes low and high estimates, and the [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code for situations requiring currency conversion. When surge is active for a particular product, its surge_multiplier will be greater than 1, but the price estimate already factors in this multiplier.",
+ "parameters": [
+ {
+ "name": "start_latitude",
+ "in": "query",
+ "description": "Latitude component of start location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ },
+ {
+ "name": "start_longitude",
+ "in": "query",
+ "description": "Longitude component of start location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ },
+ {
+ "name": "end_latitude",
+ "in": "query",
+ "description": "Latitude component of end location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ },
+ {
+ "name": "end_longitude",
+ "in": "query",
+ "description": "Longitude component of end location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ }
+ ],
+ "tags": [
+ "Estimates"
+ ],
+ "responses": {
+ "200": {
+ "description": "An array of price estimates by product",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PriceEstimate"
+ }
+ }
+ },
+ "default": {
+ "description": "Unexpected error",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/estimates/time": {
+ "get": {
+ "summary": "Time Estimates",
+ "description": "The Time Estimates endpoint returns ETAs for all products offered at a given location, with the responses expressed as integers in seconds. We recommend that this endpoint be called every minute to provide the most accurate, up-to-date ETAs.",
+ "parameters": [
+ {
+ "name": "start_latitude",
+ "in": "query",
+ "description": "Latitude component of start location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ },
+ {
+ "name": "start_longitude",
+ "in": "query",
+ "description": "Longitude component of start location.",
+ "required": true,
+ "type": "number",
+ "format": "double"
+ },
+ {
+ "name": "customer_uuid",
+ "in": "query",
+ "type": "string",
+ "format": "uuid",
+ "description": "Unique customer identifier to be used for experience customization."
+ },
+ {
+ "name": "product_id",
+ "in": "query",
+ "type": "string",
+ "description": "Unique identifier representing a specific product for a given latitude & longitude."
+ }
+ ],
+ "tags": [
+ "Estimates"
+ ],
+ "responses": {
+ "200": {
+ "description": "An array of products",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Product"
+ }
+ }
+ },
+ "default": {
+ "description": "Unexpected error",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/me": {
+ "get": {
+ "summary": "User Profile",
+ "description": "The User Profile endpoint returns information about the Uber user that has authorized with the application.",
+ "tags": [
+ "User"
+ ],
+ "responses": {
+ "200": {
+ "description": "Profile information for a user",
+ "schema": {
+ "$ref": "#/definitions/Profile"
+ }
+ },
+ "default": {
+ "description": "Unexpected error",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/history": {
+ "get": {
+ "summary": "User Activity",
+ "description": "The User Activity endpoint returns data about a user's lifetime activity with Uber. The response will include pickup locations and times, dropoff locations and times, the distance of past requests, and information about which products were requested.
The history array in the response will have a maximum length based on the limit parameter. The response value count may exceed limit, therefore subsequent API requests may be necessary.",
+ "parameters": [
+ {
+ "name": "offset",
+ "in": "query",
+ "type": "integer",
+ "format": "int32",
+ "description": "Offset the list of returned results by this amount. Default is zero."
+ },
+ {
+ "name": "limit",
+ "in": "query",
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of items to retrieve. Default is 5, maximum is 100."
+ }
+ ],
+ "tags": [
+ "User"
+ ],
+ "responses": {
+ "200": {
+ "description": "History information for the given user",
+ "schema": {
+ "$ref": "#/definitions/Activities"
+ }
+ },
+ "default": {
+ "description": "Unexpected error",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Product": {
+ "properties": {
+ "product_id": {
+ "type": "string",
+ "description": "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles."
+ },
+ "description": {
+ "type": "string",
+ "description": "Description of product."
+ },
+ "display_name": {
+ "type": "string",
+ "description": "Display name of product."
+ },
+ "capacity": {
+ "type": "string",
+ "description": "Capacity of product. For example, 4 people."
+ },
+ "image": {
+ "type": "string",
+ "description": "Image URL representing the product."
+ }
+ }
+ },
+ "PriceEstimate": {
+ "properties": {
+ "product_id": {
+ "type": "string",
+ "description": "Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles"
+ },
+ "currency_code": {
+ "type": "string",
+ "description": "[ISO 4217](http://en.wikipedia.org/wiki/ISO_4217) currency code."
+ },
+ "display_name": {
+ "type": "string",
+ "description": "Display name of product."
+ },
+ "estimate": {
+ "type": "string",
+ "description": "Formatted string of estimate in local currency of the start location. Estimate could be a range, a single number (flat rate) or \"Metered\" for TAXI."
+ },
+ "low_estimate": {
+ "type": "number",
+ "description": "Lower bound of the estimated price."
+ },
+ "high_estimate": {
+ "type": "number",
+ "description": "Upper bound of the estimated price."
+ },
+ "surge_multiplier": {
+ "type": "number",
+ "description": "Expected surge multiplier. Surge is active if surge_multiplier is greater than 1. Price estimate already factors in the surge multiplier."
+ }
+ }
+ },
+ "Profile": {
+ "properties": {
+ "first_name": {
+ "type": "string",
+ "description": "First name of the Uber user."
+ },
+ "last_name": {
+ "type": "string",
+ "description": "Last name of the Uber user."
+ },
+ "email": {
+ "type": "string",
+ "description": "Email address of the Uber user"
+ },
+ "picture": {
+ "type": "string",
+ "description": "Image URL of the Uber user."
+ },
+ "promo_code": {
+ "type": "string",
+ "description": "Promo code of the Uber user."
+ }
+ }
+ },
+ "Activity": {
+ "properties": {
+ "uuid": {
+ "type": "string",
+ "description": "Unique identifier for the activity"
+ }
+ }
+ },
+ "Activities": {
+ "properties": {
+ "offset": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Position in pagination."
+ },
+ "limit": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Number of items to retrieve (100 max)."
+ },
+ "count": {
+ "type": "integer",
+ "format": "int32",
+ "description": "Total number of items available."
+ },
+ "history": {
+ "type": "array",
+ "items": [
+ {
+ "$ref": "#/definitions/Activity"
+ }
+ ]
+ }
+ }
+ },
+ "Error": {
+ "properties": {
+ "code": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "message": {
+ "type": "string"
+ },
+ "fields": {
+ "type": "string"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/examples/v2.0/yaml/petstore-minimal.yaml b/examples/v2.0/yaml/petstore-minimal.yaml
new file mode 100644
index 0000000000..170e3ac3dc
--- /dev/null
+++ b/examples/v2.0/yaml/petstore-minimal.yaml
@@ -0,0 +1,47 @@
+---
+ swagger: "2.0"
+ info:
+ version: "1.0.0"
+ title: "Swagger Petstore"
+ description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
+ termsOfService: "http://swagger.io/terms/"
+ contact:
+ name: "Swagger API Team"
+ license:
+ name: "MIT"
+ host: "petstore.swagger.io"
+ basePath: "/api"
+ schemes:
+ - "http"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ paths:
+ /pets:
+ get:
+ description: "Returns all pets from the system that the user has access to"
+ produces:
+ - "application/json"
+ responses:
+ 200:
+ description: "A list of pets."
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Pet"
+ definitions:
+ Pet:
+ type: "object"
+ required:
+ - "id"
+ - "name"
+ properties:
+ id:
+ type: "integer"
+ format: "int64"
+ name:
+ type: "string"
+ tag:
+ type: "string"
+
diff --git a/examples/v2.0/yaml/petstore-simple.yaml b/examples/v2.0/yaml/petstore-simple.yaml
new file mode 100644
index 0000000000..78145d4653
--- /dev/null
+++ b/examples/v2.0/yaml/petstore-simple.yaml
@@ -0,0 +1,157 @@
+---
+ swagger: "2.0"
+ info:
+ version: "1.0.0"
+ title: "Swagger Petstore"
+ description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
+ termsOfService: "http://swagger.io/terms/"
+ contact:
+ name: "Swagger API Team"
+ license:
+ name: "MIT"
+ host: "petstore.swagger.io"
+ basePath: "/api"
+ schemes:
+ - "http"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ paths:
+ /pets:
+ get:
+ description: "Returns all pets from the system that the user has access to"
+ operationId: "findPets"
+ produces:
+ - "application/json"
+ - "application/xml"
+ - "text/xml"
+ - "text/html"
+ parameters:
+ -
+ name: "tags"
+ in: "query"
+ description: "tags to filter by"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "csv"
+ -
+ name: "limit"
+ in: "query"
+ description: "maximum number of results to return"
+ required: false
+ type: "integer"
+ format: "int32"
+ responses:
+ 200:
+ description: "pet response"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Pet"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ post:
+ description: "Creates a new pet in the store. Duplicates are allowed"
+ operationId: "addPet"
+ produces:
+ - "application/json"
+ parameters:
+ -
+ name: "pet"
+ in: "body"
+ description: "Pet to add to the store"
+ required: true
+ schema:
+ $ref: "#/definitions/NewPet"
+ responses:
+ 200:
+ description: "pet response"
+ schema:
+ $ref: "#/definitions/Pet"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ /pets/{id}:
+ get:
+ description: "Returns a user based on a single ID, if the user does not have access to the pet"
+ operationId: "findPetById"
+ produces:
+ - "application/json"
+ - "application/xml"
+ - "text/xml"
+ - "text/html"
+ parameters:
+ -
+ name: "id"
+ in: "path"
+ description: "ID of pet to fetch"
+ required: true
+ type: "integer"
+ format: "int64"
+ responses:
+ 200:
+ description: "pet response"
+ schema:
+ $ref: "#/definitions/Pet"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ delete:
+ description: "deletes a single pet based on the ID supplied"
+ operationId: "deletePet"
+ parameters:
+ -
+ name: "id"
+ in: "path"
+ description: "ID of pet to delete"
+ required: true
+ type: "integer"
+ format: "int64"
+ responses:
+ 204:
+ description: "pet deleted"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ definitions:
+ Pet:
+ type: "object"
+ allOf:
+ -
+ $ref: "#/definitions/NewPet"
+ -
+ required:
+ - "id"
+ properties:
+ id:
+ type: "integer"
+ format: "int64"
+ NewPet:
+ type: "object"
+ required:
+ - "name"
+ properties:
+ name:
+ type: "string"
+ tag:
+ type: "string"
+ ErrorModel:
+ type: "object"
+ required:
+ - "code"
+ - "message"
+ properties:
+ code:
+ type: "integer"
+ format: "int32"
+ message:
+ type: "string"
+
diff --git a/examples/v2.0/yaml/petstore-with-external-docs.yaml b/examples/v2.0/yaml/petstore-with-external-docs.yaml
new file mode 100644
index 0000000000..cd6ddc7357
--- /dev/null
+++ b/examples/v2.0/yaml/petstore-with-external-docs.yaml
@@ -0,0 +1,166 @@
+---
+ swagger: "2.0"
+ info:
+ version: "1.0.0"
+ title: "Swagger Petstore"
+ description: "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification"
+ termsOfService: "http://swagger.io/terms/"
+ contact:
+ name: "Swagger API Team"
+ email: "apiteam@swagger.io"
+ url: "http://swagger.io"
+ license:
+ name: "MIT"
+ url: "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
+ externalDocs:
+ description: "find more info here"
+ url: "https://swagger.io/about"
+ host: "petstore.swagger.io"
+ basePath: "/api"
+ schemes:
+ - "http"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ paths:
+ /pets:
+ get:
+ description: "Returns all pets from the system that the user has access to"
+ operationId: "findPets"
+ externalDocs:
+ description: "find more info here"
+ url: "https://swagger.io/about"
+ produces:
+ - "application/json"
+ - "application/xml"
+ - "text/xml"
+ - "text/html"
+ parameters:
+ -
+ name: "tags"
+ in: "query"
+ description: "tags to filter by"
+ required: false
+ type: "array"
+ items:
+ type: "string"
+ collectionFormat: "csv"
+ -
+ name: "limit"
+ in: "query"
+ description: "maximum number of results to return"
+ required: false
+ type: "integer"
+ format: "int32"
+ responses:
+ 200:
+ description: "pet response"
+ schema:
+ type: "array"
+ items:
+ $ref: "#/definitions/Pet"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ post:
+ description: "Creates a new pet in the store. Duplicates are allowed"
+ operationId: "addPet"
+ produces:
+ - "application/json"
+ parameters:
+ -
+ name: "pet"
+ in: "body"
+ description: "Pet to add to the store"
+ required: true
+ schema:
+ $ref: "#/definitions/NewPet"
+ responses:
+ 200:
+ description: "pet response"
+ schema:
+ $ref: "#/definitions/Pet"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ /pets/{id}:
+ get:
+ description: "Returns a user based on a single ID, if the user does not have access to the pet"
+ operationId: "findPetById"
+ produces:
+ - "application/json"
+ - "application/xml"
+ - "text/xml"
+ - "text/html"
+ parameters:
+ -
+ name: "id"
+ in: "path"
+ description: "ID of pet to fetch"
+ required: true
+ type: "integer"
+ format: "int64"
+ responses:
+ 200:
+ description: "pet response"
+ schema:
+ $ref: "#/definitions/Pet"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ delete:
+ description: "deletes a single pet based on the ID supplied"
+ operationId: "deletePet"
+ parameters:
+ -
+ name: "id"
+ in: "path"
+ description: "ID of pet to delete"
+ required: true
+ type: "integer"
+ format: "int64"
+ responses:
+ 204:
+ description: "pet deleted"
+ default:
+ description: "unexpected error"
+ schema:
+ $ref: "#/definitions/ErrorModel"
+ definitions:
+ Pet:
+ type: "object"
+ allOf:
+ -
+ $ref: "#/definitions/NewPet"
+ -
+ required:
+ - "id"
+ properties:
+ id:
+ type: "integer"
+ format: "int64"
+ NewPet:
+ type: "object"
+ required:
+ - "name"
+ properties:
+ name:
+ type: "string"
+ tag:
+ type: "string"
+ ErrorModel:
+ type: "object"
+ required:
+ - "code"
+ - "message"
+ properties:
+ code:
+ type: "integer"
+ format: "int32"
+ message:
+ type: "string"
+
diff --git a/examples/v2.0/yaml/petstore.yaml b/examples/v2.0/yaml/petstore.yaml
index b4b71280a0..bc3fc4111a 100644
--- a/examples/v2.0/yaml/petstore.yaml
+++ b/examples/v2.0/yaml/petstore.yaml
@@ -34,11 +34,11 @@ paths:
type: string
description: A link to the next page of responses
schema:
- $ref: Pets
+ $ref: '#/definitions/Pets'
default:
description: unexpected error
schema:
- $ref: Error
+ $ref: '#/definitions/Error'
post:
summary: Create a pet
operationId: createPets
@@ -50,7 +50,7 @@ paths:
default:
description: unexpected error
schema:
- $ref: Error
+ $ref: '#/definitions/Error'
/pets/{petId}:
get:
summary: Info for a specific pet
@@ -67,11 +67,11 @@ paths:
200:
description: Expected response to a valid request
schema:
- $ref: Pets
+ $ref: '#/definitions/Pets'
default:
description: unexpected error
schema:
- $ref: Error
+ $ref: '#/definitions/Error'
definitions:
Pet:
required:
@@ -88,7 +88,7 @@ definitions:
Pets:
type: array
items:
- $ref: Pet
+ $ref: '#/definitions/Pet'
Error:
required:
- code
diff --git a/examples/v2.0/yaml/uber.yaml b/examples/v2.0/yaml/uber.yaml
index 3916c6030e..40fed224eb 100644
--- a/examples/v2.0/yaml/uber.yaml
+++ b/examples/v2.0/yaml/uber.yaml
@@ -45,11 +45,13 @@ paths:
200:
description: An array of products
schema:
- $ref: "#/definitions/ProductList"
+ type: array
+ items:
+ $ref: '#/definitions/Product'
default:
description: Unexpected error
schema:
- $ref: "#/definitions/Error"
+ $ref: '#/definitions/Error'
/estimates/price:
get:
summary: Price Estimates
@@ -87,11 +89,11 @@ paths:
schema:
type: array
items:
- $ref: "#/definitions/PriceEstimate"
+ $ref: '#/definitions/PriceEstimate'
default:
description: Unexpected error
schema:
- $ref: "#/definitions/Error"
+ $ref: '#/definitions/Error'
/estimates/time:
get:
summary: Time Estimates
@@ -126,11 +128,11 @@ paths:
schema:
type: array
items:
- $ref: "#/definitions/Product"
+ $ref: '#/definitions/Product'
default:
description: Unexpected error
schema:
- $ref: "#/definitions/Error"
+ $ref: '#/definitions/Error'
/me:
get:
summary: User Profile
@@ -141,11 +143,11 @@ paths:
200:
description: Profile information for a user
schema:
- $ref: "#/definitions/Profile"
+ $ref: '#/definitions/Profile'
default:
description: Unexpected error
schema:
- $ref: "#/definitions/Error"
+ $ref: '#/definitions/Error'
/history:
get:
summary: User Activity
@@ -167,11 +169,11 @@ paths:
200:
description: History information for the given user
schema:
- $ref: "#/definitions/Activities"
+ $ref: '#/definitions/Activities'
default:
description: Unexpected error
schema:
- $ref: "#/definitions/Error"
+ $ref: '#/definitions/Error'
definitions:
Product:
properties:
@@ -259,7 +261,7 @@ definitions:
history:
type: array
items:
- $ref: "#/definitions/Activity"
+ - $ref: '#/definitions/Activity'
Error:
properties:
code:
@@ -269,4 +271,3 @@ definitions:
type: string
fields:
type: string
-