Merge pull request #21 from fehguy/master

added model sample with sample values

Author: fehguy

samples/v2.0/json/06-models-with-sample-data.json

@@ -0,0 +1,58 @@
+{
+  "models": {
+    "Employee": {
+      "description": "A representation of an employee",
+      "properties": {
+        "firstName": {
+          "type": "string",
+          "example": "Phil"
+        },
+        "lastName": {
+          "type": "string",
+          "example": "Dirt"
+        },
+        "address": {
+          "type": "Address",
+          "description": "The employees primary address"
+        }
+      },
+      "required": [ "firstName", "lastName", "address" ]
+    },
+    "Address": {
+      "description": "An address",
+      "properties": {
+        "street1": {
+          "type": "string"
+        },
+        "street2": {
+          "type": "string"
+        },
+        "city": {
+          "type": "string"
+        },
+        "state": {
+          "type": "string"
+        },
+        "postalCode": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "street1", "city", "state", "postalCode"
+      ],
+      "examples": [
+        {
+          "application/json": {
+            "street1": "12345 El Monte Blvd",
+            "city": "Los Altos Hills",
+            "state": "CA",
+            "postalCode": "94110"
+          },
+          "application/xml": {
+            "$ref": "http://foo/bar/examples/definitions/address/xml"
+          }
+        }
+      ]
+    }
+  }
+}

samples/v2.0/json/07-models-with-maps.json

@@ -0,0 +1,26 @@
+{
+  "models": {
+    "StringToIntegerMap": {
+      "additionalProperties": {
+        "type": "integer",
+        "format": "int32"
+      }
+    },
+    "StringToStringMap": {
+      "additionalProperties": {
+        "type": "string"
+      }
+    },
+    "StringToDateMap": {
+      "additionalProperties": {
+        "type": "string",
+        "format": "date-time"
+      }
+    },
+    "NestedMap": {
+      "additionalProperties": {
+        "$ref": "StringToDateMap"
+      }
+    }
+  }
+}

samples/v2.0/json/08-models-with-xml-hints.json

@@ -0,0 +1,47 @@
+{
+  "models": {
+    "Person": {
+      "description": "A representation of a person",
+      "required": [
+        "id",
+        "birthDate"
+      ],
+      "properties": {
+        "id": {
+          "type": "integer",
+          "format": "int64",
+          "description": "the ID of the user",
+          "readOnly": true,
+          "xmlFormat": "attribute"
+        },
+        "firstName": {
+          "type": "string"
+        },
+        "middleInitial": {
+          "type": "string"
+        },
+        "lastName": {
+          "type": "string"
+        },
+        "notes": {
+          "type": "string",
+          "xmlFormat": "text"
+        },
+        "age": {
+          "type": "integer",
+          "format": "int32",
+          "min": 0,
+          "readOnly": true
+        },
+        "birthDate": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "address": {
+          "$ref": "Address",
+          "xmlNamespace": "abc"
+        }
+      }
+    }
+  }
+}

samples/v2.0/json/09-responses.json

@@ -0,0 +1,22 @@
+{
+  "responses": {
+    "200": {
+      "description": "Returns an array of pets",
+      "type": "array",
+      "items": {
+        "$ref": "Pet"
+      }
+    },
+    "400": {
+      "description": "Invalid ID supplied <= this is purely for documentation",
+      "type": "ErrorModel"
+    },
+    "404": {
+      "description": "Pet not found"
+    },
+    "default": {
+      "description": "Some other terrible error",
+      "type": "ErrorModel"
+    }
+  }
+}