From 22fceac337475ed62fb7a33b69c8c989b964090d Mon Sep 17 00:00:00 2001 From: Stef Heyenrath Date: Fri, 10 Feb 2017 20:34:55 +0100 Subject: [PATCH] Updated Admin API Reference (markdown) --- Admin-API-Reference.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/Admin-API-Reference.md b/Admin-API-Reference.md index ce00e17..bd57d9d 100644 --- a/Admin-API-Reference.md +++ b/Admin-API-Reference.md @@ -7,7 +7,7 @@ var server = FluentMockServer.StartWithAdminInterface(); ``` The following interfaces are supported: -### /__admin/mappings +## /__admin/mappings The mappings defined in the mock service. * `GET /__admin/mappings` --> Gets all defined mappings * `POST /__admin/mappings` --> Create a new stub mapping @@ -16,7 +16,7 @@ The mappings defined in the mock service. * `PUT /__admin/mappings/{guid}` --> Update a stub mapping * `DELETE /__admin/mappings/{guid}` --> Delete a single stub mapping -### /__admin/requests +## /__admin/requests Logged requests and responses received by the mock service. * `GET /__admin/requests` --> Get received requests * `DELETE /__admin/requests` --> Delete all received requests @@ -27,7 +27,6 @@ Logged requests and responses received by the mock service. * `GET /__admin/requests/unmatched` --> TODO * `GET /__admin/requests/unmatched/near-misses` --> TODO - *** For some **example requests**, see this [PostMan Collection](https://www.getpostman.com/collections/b69dcea7ec19473bff1e) *** @@ -124,7 +123,7 @@ Example response: ] ``` -## `POST /__admin/mappings` +### `POST /__admin/mappings` Create a new stub mapping Example request: @@ -172,13 +171,13 @@ Example request: } ``` -## `DELETE /__admin/mappings` +### `DELETE /__admin/mappings` Delete all stub mappings. -## `GET /__admin/mappings/{guid}` +### `GET /__admin/mappings/{guid}` Get a single stub mapping -## `PUT /__admin/mappings/{guid}` +### `PUT /__admin/mappings/{guid}` Update a single stub mapping Example request @@ -213,25 +212,25 @@ Example request } ``` -## `DELETE /__admin/mappings/{guid}` +### `DELETE /__admin/mappings/{guid}` Delete a single stub mapping. ## /__admin/requests Logged requests and responses received by the mock service. -## `GET /__admin/requests` +### `GET /__admin/requests` Get received requests -## `DELETE /__admin/requests` +### `DELETE /__admin/requests` Delete all received requests -## `GET /__admin/requests/{guid}` +### `GET /__admin/requests/{guid}` Get a single request. -### `POST /__admin/requests/reset` --> TODO -### `POST /__admin/requests/count` --> TODO -### `POST /__admin/requests/find` --> TODO -### `GET /__admin/requests/unmatched` --> TODO -### `GET /__admin/requests/unmatched/near-misses` --> TODO \ No newline at end of file +#### `POST /__admin/requests/reset` --> TODO +#### `POST /__admin/requests/count` --> TODO +#### `POST /__admin/requests/find` --> TODO +#### `GET /__admin/requests/unmatched` --> TODO +#### `GET /__admin/requests/unmatched/near-misses` --> TODO \ No newline at end of file