diff --git a/README.md b/README.md index d0df49b..b9d9c0f 100644 --- a/README.md +++ b/README.md @@ -66,14 +66,14 @@ Set to true if you want this page to be the first to load in your app. If you ha A list of key-value headers you wish to add to every request we're making. For example: ``{ Authentication: 'SECRET_KEY', 'X-USER-ID': 'USER_ID' }``. ##### `methods` (object) -A list of all methods which are available in your RESTfull API. Available methods: +A list of all methods which are available in your RESTful API. Available methods: * get * post * put * post ##### `customActions` (array) -A list of extra (non RESTfull) endpoints available in your ~RESTfull~ API. Specifically `customActions` is a list of PUT or POST method objects. For example this could enable an endpoint like: ``PUT http://website.com/users/:id/disable`` +A list of extra (non RESTful) endpoints available in your ~RESTful~ API. Specifically `customActions` is a list of PUT or POST method objects. For example this could enable an endpoint like: ``PUT /users/:id/disable`` > These use the same format as the method objects defined below. diff --git a/dist/config.json b/dist/config.json index f8f596b..f2be5d3 100644 --- a/dist/config.json +++ b/dist/config.json @@ -1,22 +1,21 @@ { - "name": "RESTool for GOT", - "baseUrl": "https://restool-sample-app.herokuapp.com/api", + "name": "RESTool sample app", "pages": [ { "default": true, - "name": "Cast & Characters", - "id": "characters", - "description": "Manage GOT characters location and budget.", + "name": "Contacts", + "id": "contacts", + "description": "An example of RESTool configuration file usage with a simple mocking server", "methods": { "getAll": { - "label": "Get All", - "url": "/character", + "label": "Get Contacts", + "url": "https://restool-sample-app.herokuapp.com/api/contacts", "dataPath": null, "queryParams": [ { - "name": "search", + "name": "q", "value": "", - "label": "Search" + "label": "Query" } ], "display": { @@ -35,158 +34,80 @@ { "name": "name", "type": "text", - "label": "Name", - "filterable": true + "label": "Name" }, { - "name": "realName", + "name": "email", "type": "text", - "label": "Real Name" + "label": "Email" }, { - "name": "location", + "name": "work", "type": "text", - "label": "Current Location" - }, - { - "name": "isAlive", - "type": "boolean", - "label": "Alive?" + "label": "Phone #", + "dataPath": "phone" } ] } }, "getSingle": { - "url": "/character/:id", + "url": "https://restool-sample-app.herokuapp.com/api/contacts/:id", "dataPath": null, "queryParams": [], "requestHeaders": {} }, "put": { - "url": "/character/:id", + "url": "https://restool-sample-app.herokuapp.com/api/contacts/:id", "actualMethod": null, "fields": [ { - "name": "location", - "label": "Location", - "type": "select", - "options": ["Kings Landing", "Beyond the Wall", "Winterfell"] + "name": "name", + "label": "Name", + "type": "text" }, { - "name": "isAlive", - "label": "Alive?", - "type": "boolean" - } - ] - }, - "post": { - "url": "/character", - "fields": [ + "name": "email", + "label": "Email", + "type": "email" + }, { "name": "thumbnail", "label": "Thumbnail", "type": "text" }, { - "name": "name", - "label": "Name", - "type": "text" + "name": "work", + "label": "Work Phone", + "type": "text", + "dataPath": "phone" }, { - "name": "realName", - "label": "Real Name", - "type": "text" + "name": "mobile", + "label": "Mobile Phone", + "type": "text", + "dataPath": "phone" }, { - "name": "location", - "label": "Location", - "type": "select", - "options": ["Kings Landing", "Beyond the Wall", "Winterfell"] - }, - { - "name": "isAlive", - "label": "Alive?", - "type": "boolean" - } - ] - }, - "delete": { - "url": "/character/:id" - } - } - }, - { - "name": "Employees", - "id": "employees", - "description": "Manage GOT employees, people and employees.", - "methods": { - "getAll": { - "label": "Get All", - "url": "/employee", - "dataPath": null, - "queryParams": [ - { - "name": "search", - "value": "", - "label": "Search" - } - ], - "display": { - "type": "table", - "fields": [ - { - "name": "id", - "type": "text", - "label": "ID" - }, - { - "name": "name", - "type": "text", - "label": "Name" - }, - { - "name": "jobTitle", - "type": "text", - "label": "Job Title" - }, - { - "name": "isFired", - "type": "boolean", - "label": "Fired?" - } - ] - } - }, - "getSingle": { - "url": "/employee/:id", - "dataPath": null, - "queryParams": [], - "requestHeaders": {} - }, - "put": { - "url": "/employee/:id", - "actualMethod": null, - "fields": [ - { - "name": "name", - "label": "Name", - "type": "text" + "name": "favoriteNumber", + "label": "Favorite Number", + "type": "number" }, { - "name": "jobTitle", - "type": "select", - "label": "Job Title", - "options": ["Executive Producer", "Co-Executive Producer", "RESTool creator 😎", "A Knows nothing dude."] + "name": "numbers", + "label": "Numbers", + "type": "array", + "arrayType": "text" }, { - "name": "isFired", - "type": "boolean", - "label": "Fired?" + "name": "friends", + "label": "Friends", + "type": "array", + "arrayType": "object" } ] }, "post": { - "url": "/employee", + "url": "https://restool-sample-app.herokuapp.com/api/contacts", "fields": [ { "name": "name", @@ -194,163 +115,49 @@ "type": "text" }, { - "name": "jobTitle", - "type": "select", - "label": "Job Title", - "options": ["Executive Producer", "Co-Executive Producer", "RESTool creator 😎", "A Knows nothing dude."] + "name": "email", + "label": "Email", + "type": "email" }, { - "name": "isFired", - "type": "boolean", - "label": "Fired?" - } - ] - }, - "delete": { - "url": "/employee/:id" - } - } - }, - { - "name": "Deads", - "id": "deads", - "description": "Manage GOT deads 😵", - "methods": { - "getAll": { - "label": "Get All", - "url": "/dead", - "dataPath": null, - "queryParams": [ - { - "name": "search", - "value": "", - "label": "Search" - } - ], - "display": { - "type": "table", - "fields": [ - { - "name": "id", - "type": "text", - "label": "ID" - }, - { - "name": "name", - "type": "text", - "label": "Name" - }, - { - "name": "reason", - "type": "text", - "label": "Death Reason" - } - ] - } - }, - "getSingle": { - "url": "/dead/:id", - "dataPath": null, - "queryParams": [], - "requestHeaders": {} - }, - "put": { - "url": "/dead/:id", - "actualMethod": null, - "fields": [ - { - "name": "name", - "label": "Name", + "name": "thumbnail", + "label": "Thumbnail", "type": "text" }, { - "name": "reason", - "label": "Reason", - "type": "text" - } - ] - }, - "post": { - "url": "/dead", - "fields": [ - { - "name": "name", - "label": "Name", - "type": "text" + "name": "work", + "label": "Work Phone", + "type": "text", + "dataPath": "phone" }, + { - "name": "reason", - "label": "Reason", - "type": "text" - } - ] - }, - "delete": { - "url": "/dead/:id" - } - } - }, - { - "name": "Extras", - "id": "extras", - "description": "Manage GOT extras location and budget.", - "methods": { - "getAll": { - "label": "Get All", - "url": "/extra", - "dataPath": null, - "queryParams": [ + "name": "mobile", + "label": "Mobile Phone", + "type": "text", + "dataPath": "phone" + }, { - "name": "search", - "value": "", - "label": "Search" - } - ], - "display": { - "type": "table", - "fields": [ - { - "name": "id", - "type": "text", - "label": "ID" - }, - { - "name": "name", - "type": "text", - "label": "Name" - } - ] - } - }, - "getSingle": { - "url": "/extra/:id", - "dataPath": null, - "queryParams": [], - "requestHeaders": {} - }, - "put": { - "url": "/extra/:id", - "actualMethod": null, - "fields": [ + "name": "favoriteNumber", + "label": "Favorite Number", + "type": "number" + }, { - "name": "name", - "label": "Name", - "type": "text" - } - ] - }, - "post": { - "url": "/extra", - "fields": [ + "name": "numbers", + "label": "Numbers", + "type": "array", + "arrayType": "text" + }, { - "name": "name", - "label": "Name", - "type": "text" + "name": "friends", + "label": "Friends", + "type": "array", + "arrayType": "object" } ] }, "delete": { - "url": "/extra/:id" + "url": "https://restool-sample-app.herokuapp.com/api/contacts/:id" } } } diff --git a/dist/fontawesome-webfont.674f50d287a8c48dc19b.eot b/dist/fontawesome-webfont.674f50d287a8c48dc19b.eot new file mode 100644 index 0000000..e9f60ca Binary files /dev/null and b/dist/fontawesome-webfont.674f50d287a8c48dc19b.eot differ diff --git a/dist/fontawesome-webfont.912ec66d7572ff821749.svg b/dist/fontawesome-webfont.912ec66d7572ff821749.svg new file mode 100644 index 0000000..855c845 --- /dev/null +++ b/dist/fontawesome-webfont.912ec66d7572ff821749.svg @@ -0,0 +1,2671 @@ + + + diff --git a/dist/fontawesome-webfont.af7ae505a9eed503f8b8.woff2 b/dist/fontawesome-webfont.af7ae505a9eed503f8b8.woff2 new file mode 100644 index 0000000..4d13fc6 Binary files /dev/null and b/dist/fontawesome-webfont.af7ae505a9eed503f8b8.woff2 differ diff --git a/dist/fontawesome-webfont.b06871f281fee6b241d6.ttf b/dist/fontawesome-webfont.b06871f281fee6b241d6.ttf new file mode 100644 index 0000000..35acda2 Binary files /dev/null and b/dist/fontawesome-webfont.b06871f281fee6b241d6.ttf differ diff --git a/dist/fontawesome-webfont.fee66e712a8a08eef580.woff b/dist/fontawesome-webfont.fee66e712a8a08eef580.woff new file mode 100644 index 0000000..400014a Binary files /dev/null and b/dist/fontawesome-webfont.fee66e712a8a08eef580.woff differ diff --git a/dist/index.html b/dist/index.html index 7e321d9..75778dc 100644 --- a/dist/index.html +++ b/dist/index.html @@ -5,9 +5,8 @@