Draft_BPLSwagger_tv1

HVRetro. Note desc.

getPeople.json

+{
+  "swagger" : "2.0",
+  "info" : {
+    "description" : null,
+    "version" : "1.0.0",
+    "title" : null,
+    "termsOfService" : null,
+    "contact" : null,
+    "license" : null
+  },
+  "host" : "mock.dev.api.wisc.edu",
+  "basePath" : "",
+  "schemes" : [ "https" ],
+  "paths" : {
+    "/people" : {
+      "get" : {
+        "tags" : [ "getPeople" ],
+        "summary" : null,
+        "description" : null,
+        "operationId" : "getPeople",
+        "produces" : [ "application/vnd.api+json" ],
+        "consumes" : [ "application/vnd.api+json" ],
+        "parameters" : [ ],
+        "responses" : {
+          "200" : {
+            "description" : "successful operation",
+            "schema" : {
+              "$ref" : "#/definitions/getPeople"
+            }
+          }
+        }
+      }
+    }
+  },
+  "definitions" : {
+    "getPeople##data##attributes" : {
+      "properties" : {
+        "emailAddress" : {
+          "type" : "string"
+        },
+        "firstName" : {
+          "type" : "string"
+        },
+        "lastName" : {
+          "type" : "string"
+        },
+        "officeAddress" : {
+          "type" : "string"
+        },
+        "officePhoneNumber" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##links" : {
+      "properties" : {
+        "self" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##meta" : {
+      "properties" : {
+        "ferpa" : {
+          "type" : "boolean"
+        },
+        "ferpaAttributes" : {
+          "type" : "array",
+          "items" : {
+            "type" : "string"
+          }
+        },
+        "privateAttributes" : {
+          "type" : "array",
+          "items" : {
+            "type" : "string"
+          }
+        }
+      }
+    },
+    "getPeople##data##relationships##identifiers##data" : {
+      "properties" : {
+        "id" : {
+          "type" : "string"
+        },
+        "type" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##identifiers##links" : {
+      "properties" : {
+        "related" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##identifiers" : {
+      "properties" : {
+        "data" : {
+          "type" : "array",
+          "items" : {
+            "$ref" : "#/definitions/getPeople##data##relationships##identifiers##data"
+          }
+        },
+        "links" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##identifiers##links"
+        }
+      }
+    },
+    "getPeople##data##relationships##jobs##data" : {
+      "properties" : {
+        "id" : {
+          "type" : "string"
+        },
+        "type" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##jobs##links" : {
+      "properties" : {
+        "related" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##jobs" : {
+      "properties" : {
+        "data" : {
+          "type" : "array",
+          "items" : {
+            "$ref" : "#/definitions/getPeople##data##relationships##jobs##data"
+          }
+        },
+        "links" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##jobs##links"
+        }
+      }
+    },
+    "getPeople##data##relationships##names##data" : {
+      "properties" : {
+        "id" : {
+          "type" : "string"
+        },
+        "type" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##names##links" : {
+      "properties" : {
+        "related" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##names" : {
+      "properties" : {
+        "data" : {
+          "type" : "array",
+          "items" : {
+            "$ref" : "#/definitions/getPeople##data##relationships##names##data"
+          }
+        },
+        "links" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##names##links"
+        }
+      }
+    },
+    "getPeople##data##relationships##wiscard##links" : {
+      "properties" : {
+        "related" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data##relationships##wiscard" : {
+      "properties" : {
+        "data" : {
+          "type" : "string"
+        },
+        "links" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##wiscard##links"
+        }
+      }
+    },
+    "getPeople##data##relationships" : {
+      "properties" : {
+        "identifiers" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##identifiers"
+        },
+        "jobs" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##jobs"
+        },
+        "names" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##names"
+        },
+        "wiscard" : {
+          "$ref" : "#/definitions/getPeople##data##relationships##wiscard"
+        }
+      }
+    },
+    "getPeople##data##relationships##wiscard##data" : {
+      "properties" : {
+        "id" : {
+          "type" : "string"
+        },
+        "type" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##data" : {
+      "properties" : {
+        "attributes" : {
+          "$ref" : "#/definitions/getPeople##data##attributes"
+        },
+        "id" : {
+          "type" : "string"
+        },
+        "links" : {
+          "$ref" : "#/definitions/getPeople##data##links"
+        },
+        "meta" : {
+          "$ref" : "#/definitions/getPeople##data##meta"
+        },
+        "relationships" : {
+          "$ref" : "#/definitions/getPeople##data##relationships"
+        },
+        "type" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople##links" : {
+      "properties" : {
+        "self" : {
+          "type" : "string"
+        }
+      }
+    },
+    "getPeople" : {
+      "properties" : {
+        "data" : {
+          "type" : "array",
+          "items" : {
+            "$ref" : "#/definitions/getPeople##data"
+          }
+        },
+        "links" : {
+          "$ref" : "#/definitions/getPeople##links"
+        }
+      }
+    }
+  }
+}
\ No newline at end of file