README.md in fakeit-0.6.3 vs README.md in fakeit-0.7.0
- old
+ new
@@ -46,25 +46,49 @@
## Usage
$ fakeit --spec <Local file or remote url>
-Command line options:
+### Command line options
$ fakeit --help
usage:
--spec spec file uri (required)
-p, --port custom port
-q, --quiet mute request and response log
+ -l, --log-file redirect log to a file
--permissive log validation error as warning instead of denying request
--use-example use example provided in spec if exists
--static generate static response
--static-types generate static value for specified types, e.g. --static-types integer,string
--static-properties generate static value for specified properties, e.g. --static-properties id,uuid
other options:
-v, --version
-h, --help
+
+### Configuration endpoint
+
+Mock server behaviour can be changed on the fly
+
+Retrieve current config:
+
+ GET /__fakeit_config__
+
+Update config:
+
+ PUT /__fakeit_config__
+
+Request and response:
+```json
+{
+ 'permissive' => false,
+ 'use_example' => true,
+ 'static' => false,
+ 'static_types' => ['integer'],
+ 'static_properties' => ['id']
+}
+```
**Notes:**
* See [here](docs/random.md) for Openapi properties supported in random response generation
* See [here](docs/static.md) for default value in static response generation
* Regarding `--use-example` mode, property without example specified will still be randomly or statically generated