summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLeon Overweel <l.overweel@gmail.com>2017-01-24 13:37:27 +0100
committerGitHub <noreply@github.com>2017-01-24 13:37:27 +0100
commitbd4da9f120d3d2beb262172882ed6d9ea19d6e8f (patch)
treeb792f9e0bf3a2bc10b69d8be8f5654e45f16e096 /README.md
parent145ed598733027dfe12854544067ff4b1b055f0c (diff)
Fix "plane" -> "plain" typo in README.md
😭
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6042970b..89f554e8 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@
OpenDC consists of four components: a C++ simulator, a SQLite database, a Python Flask web server, and a TypeScript frontend.
-On the frontend, users can construct a topology by specifying a datacenter's rooms, racks and machines, and create experiments to see how a workload trace runs on that topology. The frontend communicates with the web server over SocketIO, through a custom REST request/response layer. For example, the frontend might make a `GET` request to `/api/v1/users/{userId}`, but this request is completed via SocketIO, not plane HTTP requests.
+On the frontend, users can construct a topology by specifying a datacenter's rooms, racks and machines, and create experiments to see how a workload trace runs on that topology. The frontend communicates with the web server over SocketIO, through a custom REST request/response layer. For example, the frontend might make a `GET` request to `/api/v1/users/{userId}`, but this request is completed via SocketIO, not plain HTTP requests.
The (Swagger/ OpenAPI compliant) API specification specifies what requests the frontend can make to the web server. To view this specification, go to the [Swagger UI](http://petstore.swagger.io/) and "Explore" [opendc-api-spec.json](https://raw.githubusercontent.com/tudelft-atlarge/opendc/master/opendc-api-spec.json).