added linked example per #5

OAI · Aug 1, 2014 · e95e977 · e95e977
1 parent bd74c1c
commit e95e977
Show file tree

Hide file tree

Showing 2 changed files with 100 additions and 0 deletions.
diff --git a/samples/v2.0/json/resources/resourceWithLinkedDefinitions.json b/samples/v2.0/json/resources/resourceWithLinkedDefinitions.json
@@ -0,0 +1,62 @@
+{
+  "swagger": 2.0,
+  "info": {
+    "version": "1.0.9-abcd",
+    "title": "Swagger Sample API",
+    "description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
+    "termsOfService": "http://helloreverb.com/terms/",
+    "contact": {
+      "name": "wordnik api team",
+      "url": "http://developer.wordnik.com"
+    },
+    "license": {
+      "name": "Creative Commons 4.0 International",
+      "url": "http://creativecommons.org/licenses/by/4.0/"
+    }
+  },
+  "host": "my.api.com",
+  "basePath": "/v1",
+  "schemes": [
+    "http",
+    "https"
+  ],
+  "consumes": [
+    "application/json"
+  ],
+  "produces": [
+    "application/json",
+    "application/xml"
+  ],
+  "paths": {
+    "/pets/{petId}": {
+      "$ref": "https://raw.githubusercontent.com/reverb/swagger-spec/master/samples/2.0/json/resources/resourceWithLinkedDefinitions_part1.json"
+    }
+  },
+  "definitions": {
+    "Pet": {
+      "required": [
+        "name"
+      ],
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "tag": {
+          "type": "string"
+        }
+      }
+    },
+    "ErrorModel": {
+      "required": [ "code", "message" ],
+      "properties": {
+        "code": {
+          "type": "integer",
+          "format": "int32"
+        },
+        "message": {
+          "type": "string"
+        }
+      }
+    }
+  }
+}
diff --git a/samples/v2.0/json/resources/resourceWithLinkedDefinitions_part1.json b/samples/v2.0/json/resources/resourceWithLinkedDefinitions_part1.json
@@ -0,0 +1,38 @@
+{
+  "get": {
+    "description": "Returns a pet based on ID",
+    "summary": "Find pet by ID",
+    "operationId": "getPetsById",
+    "produces": [
+      "application/json",
+      "text/html"
+    ],
+    "parameters": [
+      {
+        "name": "petId",
+        "in": "path",
+        "description": "ID of pet that needs to be fetched",
+        "required": true,
+        "type": "array",
+        "items": {
+          "type": "string"
+        },
+        "collectionFormat": "csv"
+      }
+    ],
+    "responses": {
+      "200": {
+        "description": "pet response",
+        "schema": {
+          "$ref": "Pet"
+        }
+      },
+      "default": {
+        "description": "error payload",
+        "schema": {
+          "$ref": "ErrorModel"
+        }
+      }
+    }
+  }
+}