mockaton 13.1.0 → 13.2.1

package/package.json

@@ -2,17 +2,19 @@
 	"name": "mockaton",
 	"description": "HTTP Mock Server",
 	"type": "module",
-	"version": "13.1.0",
+	"version": "13.2.1",
 	"exports": {
 		".": {
 			"import": "./index.js",
 			"types": "./index.d.ts"
-		}
+		},
+		"./openapi.json": "./www/src/assets/openapi.json"
 	},
 	"files": [
 		"src",
 		"index.js",
-		"index.d.ts"
+		"index.d.ts",
+		"www/src/assets/openapi.json"
 	],
 	"license": "MIT",
 	"homepage": "https://mockaton.com",

package/src/client/ApiCommander.js

@@ -42,8 +42,7 @@ export class Commander {
 	/** @returns {JsonPromise<ClientMockBroker>} */
 	toggleStatus = (method, urlMask, status) => this.#patch(API.toggleStatus, [method, urlMask, status])
 
-	// TODO change Status or Toggle404?
-
+	
 	/** @returns {JsonPromise<ClientMockBroker>} */
 	setRouteIsProxied = (method, urlMask, proxied) => this.#patch(API.proxied, [method, urlMask, proxied])
 
@@ -61,7 +60,8 @@ export class Commander {
 
 
 	/**
-	 * SSE - Streams an incremental version when a mock is added, deleted, or renamed
+	 * SSE - Streams an incremental version when a mock is added, deleted, or renamed.
+	 *  Also, when the internal state changes.
 	 * @returns {Promise<Response>}
 	 */
 	getSyncVersion = () => fetch(this.addr + API.syncVersion)

package/src/client/app-store.js

@@ -10,6 +10,7 @@ export const store = {
 	onError(err) {},
 	render() {},
 	renderRow(method, urlMask) {},
+	skipNextRender: false,
 
 	brokersByMethod: /** @type ClientBrokersByMethod */ {},
 
@@ -58,49 +59,53 @@ export const store = {
 			if (store.showProxyField === null) // isFirstCall
 				store.showProxyField = Boolean(store.proxyFallback)
 
-			store.render()
+			if (store.skipNextRender)
+				store.skipNextRender = false
+			else
+				store.render()
 		})
 	},
 
 	reset() {
 		store._request(api.reset, () => {
 			store.setChosenLink('', '')
-			store.fetchState()
 		})
 	},
 
 	bulkSelectByComment(value) {
-		store._request(() => api.bulkSelectByComment(value), () => {
-			store.fetchState()
-		})
+		store._request(() => api.bulkSelectByComment(value))
 	},
 
 	setGlobalDelay(value) {
+		store.skipNextRender = true
 		store._request(() => api.setGlobalDelay(value), () => {
 			store.delay = value
 		})
 	},
 
 	setGlobalDelayJitter(value) {
+		store.skipNextRender = true
 		store._request(() => api.setGlobalDelayJitter(value), () => {
 			store.delayJitter = value
 		})
 	},
 
 	selectCookie(name) {
+		store.skipNextRender = true
 		store._request(() => api.selectCookie(name), async response => {
 			store.cookies = await response.json()
 		})
 	},
 
 	setProxyFallback(value) {
+		store.skipNextRender = true
 		store._request(() => api.setProxyFallback(value), () => {
 			store.proxyFallback = value
-			store.render()
 		})
 	},
 
 	setCollectProxied(checked) {
+		store.skipNextRender = true
 		store._request(() => api.setCollectProxied(checked), () => {
 			store.collectProxied = checked
 		})
@@ -111,7 +116,7 @@ export const store = {
 		return store.brokersByMethod[method]?.[urlMask]
 	},
 
-	setBroker(broker) {
+	_setBroker(broker) {
 		const { method, urlMask } = parseFilename(broker.file)
 		store.brokersByMethod[method] ??= {}
 		store.brokersByMethod[method][urlMask] = broker
@@ -153,33 +158,37 @@ export const store = {
 	},
 
 	selectFile(file) {
+		store.skipNextRender = true
 		store._request(() => api.select(file), async response => {
 			const { method, urlMask } = parseFilename(file)
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		})
 	},
 
 	toggleStatus(method, urlMask, status) {
+		store.skipNextRender = true
 		store._request(() => api.toggleStatus(method, urlMask, status), async response => {
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		})
 	},
 
 	setProxied(method, urlMask, checked) {
+		store.skipNextRender = true
 		store._request(() => api.setRouteIsProxied(method, urlMask, checked), async response => {
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 			store.setChosenLink(method, urlMask)
 			store.renderRow(method, urlMask)
 		})
 	},
 
 	setDelayed(method, urlMask, checked) {
+		store.skipNextRender = true
 		store._request(() => api.setRouteIsDelayed(method, urlMask, checked), async response => {
-			store.setBroker(await response.json())
+			store._setBroker(await response.json())
 		})
 	}
 }

package/src/server/Api.js

@@ -5,24 +5,18 @@
 
 import { join } from 'node:path'
 
-import {
-	sseClientHotReload,
-	DASHBOARD_ASSETS,
-	CLIENT_DIR
-} from './WatcherDevClient.js'
-import { startWatchers, stopWatchers, sseClientSyncVersion, notifyARR } from './Watcher.js'
-
 import pkgJSON from '../../package.json' with { type: 'json' }
 
+import { sseClientHotReload, DASHBOARD_ASSETS, CLIENT_DIR } from './WatcherDevClient.js'
+import { stopMocksDirWatcher, sseClientSyncVersion, uiSyncVersion, watchMocksDir } from './Watcher.js'
+
 import { API } from '../client/ApiConstants.js'
 import { IndexHtml, CSP } from '../client/IndexHtml.js'
 
 import { cookie } from './cookie.js'
 import { config, ConfigValidator } from './config.js'
-
-import { write, rm, isFile, resolveIn } from './utils/fs.js'
-
 import * as mockBrokersCollection from './mockBrokersCollection.js'
+import { write, rm, isFile, resolveIn } from './utils/fs.js'
 
 
 export const apiGetReqs = new Map([
@@ -95,6 +89,7 @@ function getState(_, response) {
 function reset(_, response) {
 	mockBrokersCollection.init()
 	response.ok()
+	uiSyncVersion.increment()
 }
 
 
@@ -106,21 +101,7 @@ async function setCorsAllowed(req, response) {
 	else {
 		config.corsAllowed = corsAllowed
 		response.ok()
-	}
-}
-
-
-async function setWatchMocks(req, response) {
-	const enabled = await req.json()
-
-	if (typeof enabled !== 'boolean')
-		response.unprocessable(`Expected boolean for "watchMocks"`)
-	else {
-		if (enabled)
-			startWatchers()
-		else
-			stopWatchers()
-		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -132,7 +113,9 @@ async function setGlobalDelay(req, response) {
 		response.unprocessable(`Expected non-negative integer for "delay"`)
 	else {
 		config.delay = delay
+		uiSyncVersion.increment()
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -144,6 +127,7 @@ async function setGlobalDelayJitter(req, response) {
 	else {
 		config.delayJitter = jitter
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -154,8 +138,10 @@ async function selectCookie(req, response) {
 	const error = cookie.setCurrent(cookieKey)
 	if (error)
 		response.unprocessable(error?.message || error)
-	else
+	else {
 		response.json(cookie.list())
+		uiSyncVersion.increment()
+	}
 }
 
 
@@ -167,6 +153,7 @@ async function setProxyFallback(req, response) {
 	else {
 		config.proxyFallback = fallback
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -178,6 +165,7 @@ async function setCollectProxied(req, response) {
 	else {
 		config.collectProxied = collectProxied
 		response.ok()
+		uiSyncVersion.increment()
 	}
 }
 
@@ -188,6 +176,7 @@ async function bulkUpdateBrokersByCommentTag(req, response) {
 
 	mockBrokersCollection.setMocksMatchingComment(comment)
 	response.ok()
+	uiSyncVersion.increment()
 }
 
 
@@ -200,6 +189,7 @@ async function selectMock(req, response) {
 	else {
 		broker.selectFile(file)
 		response.json(broker)
+		uiSyncVersion.increment()
 	}
 }
 
@@ -213,6 +203,7 @@ async function toggleRouteStatus(req, response) {
 	else {
 		broker.toggleStatus(status)
 		response.json(broker)
+		uiSyncVersion.increment()
 	}
 }
 
@@ -228,6 +219,7 @@ async function setRouteIsDelayed(req, response) {
 	else {
 		broker.setDelayed(delayed)
 		response.json(broker)
+		uiSyncVersion.increment()	
 	}
 }
 
@@ -245,6 +237,7 @@ async function setRouteIsProxied(req, response) {
 	else {
 		broker.setProxied(proxied)
 		response.json(broker)
+		uiSyncVersion.increment()
 	}
 }
 
@@ -263,7 +256,7 @@ async function writeMock(req, response) {
 
 	if (!config.watcherEnabled) {
 		mockBrokersCollection.registerMock(file, true)
-		notifyARR()
+		uiSyncVersion.increment()
 	}
 	response.ok()
 }
@@ -286,10 +279,24 @@ async function deleteMock(req, response) {
 
 	if (!config.watcherEnabled) {
 		mockBrokersCollection.unregisterMock(file)
-		notifyARR()
+		uiSyncVersion.increment()
 	}
 	response.ok()
 }
 
 
 
+async function setWatchMocks(req, response) {
+	const enabled = await req.json()
+
+	if (typeof enabled !== 'boolean')
+		response.unprocessable(`Expected boolean for "watchMocks"`)
+	else {
+		if (enabled)
+			watchMocksDir()
+		else
+			stopMocksDirWatcher()
+		response.ok()
+	}
+}
+

package/src/server/Watcher.js

@@ -12,24 +12,22 @@ let mocksWatcher = null
 
 
 /**
- * ARR Event = Add, Remove, or Rename Mock
- *
  * The emitter is debounced so it handles e.g. bulk deletes,
  * and also renames, which are two events (delete + add).
  */
-const uiSyncVersion = new class extends EventEmitter {
+export const uiSyncVersion = new class extends EventEmitter {
 	version = 0
 
 	increment = /** @type {function} */ this.#debounce(() => {
 		this.version++
-		super.emit('ARR')
+		super.emit('INC')
 	})
 
 	subscribe(listener) {
-		this.on('ARR', listener)
+		this.on('INC', listener)
 	}
 	unsubscribe(listener) {
-		this.removeListener('ARR', listener)
+		this.removeListener('INC', listener)
 	}
 
 	#debounce(fn) { // TESTME 
@@ -42,11 +40,6 @@ const uiSyncVersion = new class extends EventEmitter {
 }
 
 
-export function notifyARR() {
-	uiSyncVersion.increment()
-}
-
-
 export function watchMocksDir() {
 	const dir = config.mocksDir
 	mocksWatcher = mocksWatcher || watch(dir, { recursive: true, persistent: false }, (_, file) => {
@@ -69,8 +62,12 @@ export function watchMocksDir() {
 	})
 }
 
+export function stopMocksDirWatcher() {
+	mocksWatcher?.close()
+	mocksWatcher = null
+}
+
 
-/** Realtime notify ARR Events */
 export function sseClientSyncVersion(req, response) {
 	response.writeHead(200, {
 		'Content-Type': 'text/event-stream',
@@ -99,11 +96,3 @@ export function sseClientSyncVersion(req, response) {
 }
 
 
-export function startWatchers() {
-	watchMocksDir()
-}
-
-export function stopWatchers() {
-	mocksWatcher?.close()
-	mocksWatcher = null
-}

package/www/src/assets/openapi.json

@@ -0,0 +1,661 @@
+{
+	"openapi": "3.1.2",
+	"info": {
+		"title": "Mockaton Control API",
+		"version": "1.0.0"
+	},
+	"servers": [
+		{
+			"url": "http://localhost:2020"
+		}
+	],
+	"paths": {
+		"/mockaton/reset": {
+			"patch": {
+				"summary": "Re-initialize Mockaton",
+				"description": "The selected mocks, cookies, and delays go back to default, but `proxyFallback`, `collectProxied`, and `corsAllowed` are not affected.",
+				"x-js-client-example": "await mockaton.reset()",
+				"responses": {
+					"200": {
+						"description": "OK"
+					}
+				}
+			}
+		},
+		"/mockaton/bulk-select-by-comment": {
+			"patch": {
+				"summary": "Select all mocks that have a particular comment",
+				"x-js-client-example": "await mockaton.bulkSelectByComment('(demo-a)')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "string",
+								"description": "Parentheses are optional, so you can pass a partial match. For example, passing `'demo-'` (without the final `a`) works too. On routes with many partial matches, their first mock in alphabetical order wins.",
+								"example": "(demo-a)"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"$ref": "#/components/responses/Broker"
+					}
+				}
+			}
+		},
+		"/mockaton/select": {
+			"patch": {
+				"summary": "Select a mock file for a route",
+				"x-js-client-example": "await mockaton.select('api/user/avatar.GET.json')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/Filename"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"$ref": "#/components/responses/Broker"
+					},
+					"422": {
+						"description": "Mock file doesn’t exist",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "string"
+								},
+								"example": "Mock file does not exist"
+							}
+						}
+					}
+				}
+			}
+		},
+		"/mockaton/toggle-status": {
+			"patch": {
+				"summary": "Toggle a specific status for a route",
+				"description": "Selects the first found mock with the given status, which could be the autogenerated one. Or, selects the default file.",
+				"x-js-client-example": "await mockaton.toggleStatus('GET', '/api/user/friends', 500)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "array",
+								"minItems": 3,
+								"maxItems": 3,
+								"prefixItems": [
+									{
+										"$ref": "#/components/schemas/Method"
+									},
+									{
+										"$ref": "#/components/schemas/UrlMask"
+									},
+									{
+										"type": "number",
+										"description": "HTTP Status to toggle",
+										"example": 500
+									}
+								],
+								"additionalItems": false
+							},
+							"example": [
+								"GET",
+								"/api/user",
+								500
+							]
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"$ref": "#/components/responses/Broker"
+					},
+					"422": {
+						"description": "Route does not exist"
+					}
+				}
+			}
+		},
+		"/mockaton/proxied": {
+			"patch": {
+				"summary": "Set whether a route is proxied",
+				"description": "Applicable only when there’s a proxy fallback server URL already set. See `PATCH /mockaton/fallback`",
+				"x-js-client-example": "await mockaton.setRouteIsProxied('GET', '/api/user/friends', true)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "array",
+								"minItems": 3,
+								"maxItems": 3,
+								"prefixItems": [
+									{
+										"$ref": "#/components/schemas/Method"
+									},
+									{
+										"$ref": "#/components/schemas/UrlMask"
+									},
+									{
+										"type": "boolean",
+										"description": "proxied",
+										"example": true
+									}
+								],
+								"additionalItems": false
+							},
+							"example": [
+								"GET",
+								"/api/user",
+								true
+							]
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"$ref": "#/components/responses/Broker"
+					},
+					"422": {
+						"description": "Invalid request. Possible reasons:\n- Route does not exist\n- Expected boolean for `proxied`\n- No `proxyFallback` configured\n"
+					}
+				}
+			}
+		},
+		"/mockaton/delay": {
+			"patch": {
+				"summary": "Set whether a route is delayed",
+				"x-js-client-example": "await mockaton.setRouteIsDelayed('GET', '/api/user/friends', true)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "array",
+								"minItems": 3,
+								"maxItems": 3,
+								"prefixItems": [
+									{
+										"$ref": "#/components/schemas/Method"
+									},
+									{
+										"$ref": "#/components/schemas/UrlMask"
+									},
+									{
+										"type": "boolean",
+										"description": "delayed",
+										"example": true
+									}
+								],
+								"additionalItems": false
+							},
+							"example": [
+								"GET",
+								"/api/user",
+								true
+							]
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"$ref": "#/components/responses/Broker"
+					},
+					"422": {
+						"description": "Invalid request. Possible reasons:\n- Route does not exist\n- Expected boolean for `delayed`\n"
+					}
+				}
+			}
+		},
+		"/mockaton/global-delay": {
+			"patch": {
+				"summary": "Set global delay for all responses",
+				"x-js-client-example": "await mockaton.setGlobalDelay(1500)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "integer",
+								"description": "Delay in milliseconds",
+								"example": 1500
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"422": {
+						"description": "Expected non-negative integer"
+					}
+				}
+			}
+		},
+		"/mockaton/global-delay-jitter": {
+			"patch": {
+				"summary": "Set global delay jitter for all responses",
+				"x-js-client-example": "await mockaton.setGlobalDelayJitter(0.5)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "number",
+								"description": "0 to 3 float percent",
+								"example": 0.5
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"422": {
+						"description": "Expected 0 to 3 float"
+					}
+				}
+			}
+		},
+		"/mockaton/cors": {
+			"patch": {
+				"summary": "Enable or disable CORS",
+				"x-js-client-example": "await mockaton.setCorsAllowed(false)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "boolean",
+								"description": "Is enabled?"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"422": {
+						"description": "Expected boolean"
+					}
+				}
+			}
+		},
+		"/mockaton/fallback": {
+			"patch": {
+				"summary": "Set proxy fallback address",
+				"x-js-client-example": "await mockaton.setProxyFallback('http://example.test')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "string",
+								"description": "URL",
+								"example": "https://example.test"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"422": {
+						"description": "Invalid Proxy Fallback URL"
+					}
+				}
+			}
+		},
+		"/mockaton/collect-proxied": {
+			"patch": {
+				"summary": "Enable or disable collection of proxied responses",
+				"description": "Applicable only when there’s a proxy fallback server URL already set. See `PATCH /mockaton/fallback`",
+				"x-js-client-example": "await mockaton.setCollectProxied(true)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "boolean",
+								"description": "Should Collect?",
+								"example": true
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"422": {
+						"description": "Expected boolean"
+					}
+				}
+			}
+		},
+		"/mockaton/cookies": {
+			"patch": {
+				"summary": "Select a cookie label",
+				"x-js-client-example": "await mockaton.selectCookie('Normal User')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "string",
+								"description": "Cookie key",
+								"example": "Normal User"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "Available cookie labels",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/CookieSelectionList"
+								}
+							}
+						}
+					},
+					"422": {
+						"description": "Cookie key not found"
+					}
+				}
+			}
+		},
+		"/mockaton/watch-mocks": {
+			"patch": {
+				"summary": "Enable or disable mock file watching",
+				"description": "Controls file watchers for mocksDir.",
+				"x-js-client-example": "await mockaton.setWatchMocks(true)",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "boolean",
+								"description": "true to start watchers, false to stop them"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"422": {
+						"description": "Invalid input - expected boolean"
+					}
+				}
+			}
+		},
+		"/mockaton/write-mock": {
+			"patch": {
+				"summary": "Write a mock file",
+				"description": "Writes a mock file to the mocks directory. Guarded by `readOnly` and `mocksDir`.",
+				"x-js-client-example": "await mockaton.writeMock('api/user/friends.GET.200.json', '{ \"friends\": [] }')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "array",
+								"minItems": 2,
+								"maxItems": 2,
+								"prefixItems": [
+									{
+										"$ref": "#/components/schemas/Filename"
+									},
+									{
+										"type": "string",
+										"description": "File content"
+									}
+								],
+								"additionalItems": false
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"403": {
+						"description": "Forbidden (read-only mode or outside mocksDir)"
+					}
+				}
+			}
+		},
+		"/mockaton/delete-mock": {
+			"patch": {
+				"summary": "Delete a mock file",
+				"description": "Deletes a mock file from the mocks directory. Guarded by `readOnly` and `mocksDir`.",
+				"x-js-client-example": "await mockaton.deleteMock('api/user/friends.GET.200.json')",
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/Filename"
+							}
+						}
+					}
+				},
+				"responses": {
+					"200": {
+						"description": "OK"
+					},
+					"403": {
+						"description": "Forbidden (read-only mode or outside mocksDir)"
+					},
+					"422": {
+						"description": "Mock file does not exist"
+					}
+				}
+			}
+		},
+		"/mockaton/state": {
+			"get": {
+				"summary": "Get complete Mockaton state",
+				"x-js-client-example": "await mockaton.getState()",
+				"responses": {
+					"200": {
+						"description": "Mockaton state",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/State"
+								}
+							}
+						}
+					}
+				}
+			}
+		},
+		"/mockaton/sync-version": {
+			"get": {
+				"summary": "Get sync version for long‑polling updates",
+				"description": "A counter that’s incremented when a new mock is added, removed, or renamed. Also, when the internal state changes, e.g., when changing the mock file for a route.",
+				"x-js-client-example": "await mockaton.getSyncVersion()",
+				"parameters": [
+					{
+						"name": "sync_version",
+						"in": "header",
+						"required": false,
+						"example": -1,
+						"schema": {
+							"type": "number"
+						},
+						"description": "When not present, or when the version mismatches it responds right away. Otherwise, it long polls. Times out in 8s."
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Sync version value",
+						"content": {
+							"application/json": {
+								"schema": {
+									"type": "number",
+									"description": "Incremental integer"
+								}
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"responses": {
+			"Broker": {
+				"description": "Updated broker state",
+				"content": {
+					"application/json": {
+						"schema": {
+							"$ref": "#/components/schemas/ClientMockBroker"
+						}
+					}
+				}
+			}
+		},
+		"schemas": {
+			"Method": {
+				"type": "string",
+				"description": "HTTP Method of the mock",
+				"example": "GET"
+			},
+			"UrlMask": {
+				"type": "string",
+				"example": "/api/user/friends"
+			},
+			"Filename": {
+				"type": "string",
+				"description": "Mock filename. The convention is UrlMask.Method.StatusCode.Extension",
+				"example": "api/user/avatar.GET.200.svg"
+			},
+			"ClientMockBroker": {
+				"type": "object",
+				"properties": {
+					"mocks": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/Filename"
+						}
+					},
+					"file": {
+						"$ref": "#/components/schemas/Filename"
+					},
+					"status": {
+						"type": "number"
+					},
+					"autoStatus": {
+						"type": "number"
+					},
+					"isStatic": {
+						"type": "boolean"
+					},
+					"delayed": {
+						"type": "boolean"
+					},
+					"proxied": {
+						"type": "boolean"
+					}
+				},
+				"required": [
+					"mocks",
+					"file",
+					"status",
+					"autoStatus",
+					"isStatic",
+					"delayed",
+					"proxied"
+				]
+			},
+			"State": {
+				"type": "object",
+				"properties": {
+					"brokersByMethod": {
+						"type": "object",
+						"additionalProperties": {
+							"type": "object",
+							"additionalProperties": {
+								"$ref": "#/components/schemas/ClientMockBroker"
+							}
+						}
+					},
+					"cookies": {
+						"$ref": "#/components/schemas/CookieSelectionList"
+					},
+					"comments": {
+						"type": "array",
+						"items": {
+							"type": "string"
+						}
+					},
+					"delay": {
+						"type": "number"
+					},
+					"delayJitter": {
+						"type": "number"
+					},
+					"collectProxied": {
+						"type": "boolean"
+					},
+					"proxyFallback": {
+						"type": "string"
+					},
+					"readOnly": {
+						"type": "boolean"
+					},
+					"corsAllowed": {
+						"type": "boolean"
+					}
+				},
+				"required": [
+					"brokersByMethod",
+					"cookies",
+					"comments",
+					"delay",
+					"delayJitter",
+					"collectProxied",
+					"proxyFallback",
+					"readOnly",
+					"corsAllowed"
+				]
+			},
+			"CookieSelectionList": {
+				"type": "array",
+				"items": {
+					"type": "array",
+					"minItems": 2,
+					"maxItems": 2,
+					"prefixItems": [
+						{
+							"type": "string",
+							"description": "Label"
+						},
+						{
+							"type": "boolean",
+							"description": "Selected"
+						}
+					],
+					"additionalItems": false
+				}
+			}
+		}
+	}
+}