Merge pull request #15 from znsio/multi-value-dict

Add multi-value dictionary documentation

Author: ketan

documentation/contract_tests.md

@@ -63,11 +63,6 @@ Contract Tests
   - [Advanced Features](#advanced-features)
     - [Generative Tests](#generative-tests)
     - [Limiting the Count of Tests](#limiting-the-count-of-tests)
-    - [Dictionary](#dictionary)
-      - [Create the Specification](#create-the-specification)
-      - [Create a Dictionary](#create-a-dictionary)
-      - [Run the tests Tests](#run-the-tests-tests)
-      - [Generative Tests](#generative-tests-1)
     - [Sample Project](#sample-project)
 
 ### Overview
@@ -1648,174 +1643,6 @@ In this example, we may ensure that just the first 2 tests run with the followin
 System.setProperty("MAX_TEST_REQUEST_COMBINATIONS", "2");
 ```
 
-### Dictionary
-
-When Specmatic generates requests for tests and does not find any examples, it will create the requests using the structure and keys defined by the request schema in the specifications, and it will fill in the structure with random values, based again on the same schema.
-
-In order to obtain domain-specific requests without examples, you can supply a dictionary of values to Specmatic. Specmatic will then reference this dictionary when it needs to generate a request.
-
-#### Create the Specification
-To understand how this works, create the `employees.yaml` specification file as follows:
-
-```yaml
-openapi: 3.0.0
-info:
-  title: Employees
-  version: '1.0'
-servers: []
-paths:
-  /employees:
-    post:
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/EmployeeDetails'
-      responses:
-        200:
-          description: Employee Created
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Employee'
-
-        400:
-          description: Bad Request
-components:
-  schemas:
-    Employee:
-      type: object
-      required:
-        - id
-        - name
-        - department
-      properties:
-        id:
-          type: integer
-        employeeCode:
-          type: string
-        name:
-          type: string
-        department:
-          type: string
-
-    EmployeeDetails:
-      type: object
-      required:
-        - name
-        - department
-      properties:
-        name:
-          type: string
-        department:
-          type: string
-        employeeCode:
-          type: string
-```
-
-
-#### Create a Dictionary
-Now create a dictionary file named `employees_dictionary.yaml` in the same directory, the dictionary can also be in `JSON` format,
-following the naming convention `<spec-name>_dictionary.<format>` as follows:
-
-{% tabs dictionary %}
-{% tab dictionary yaml %}
-```yaml
-EmployeeDetails.name: John Doe
-EmployeeDetails.department: IT
-EmployeeDetails.employeeCode: "12345"
-```
-{% endtab %}
-{% tab dictionary json %}
-```json
-{
-  "EmployeeDetails.name": "John Doe",
-  "EmployeeDetails.department": "IT",
-  "EmployeeDetails.employeeCode": "12345"
-}
-```
-{% endtab %}
-{% endtabs %}
-
-> **Note:** The order of priority for dictionary formats is as follows: `.yml`, `.yaml`, and then `.json`.
-<br/>To understand the syntax of dictionary refer to [service-virtualization](/documentation/service_virtualization_tutorial.html#use-meaningful-response-values-from-an-external-dictionary)
-
-#### Run the tests Tests
-Now to execute contract tests on the specification using the dictionary a service is required, we will utilize [service-virtualization](/documentation/service_virtualization_tutorial.html) for this purpose.
-
-{% tabs test %}
-{% tab test java %}
-```shell
-java -jar specmatic.jar stub employees.yaml
-```
-{% endtab %}
-{% tab test npm %}
-```shell
-npx specmatic stub employees.yaml
-```
-{% endtab %}
-{% tab test docker %}
-```shell
-docker run --rm --network host -v "$(pwd)/employees.yaml:/usr/src/app/employees.yaml" -v "$(pwd)/employees_dictionary.yaml:/usr/src/app/employees_dictionary.yaml" znsio/specmatic stub "employees.yaml"
-```
-{% endtab %}
-{% endtabs %}
-
-Next, execute the contract tests by running the following command:
-
-{% tabs test %}
-{% tab test java %}
-```shell
-java -jar specmatic.jar test employees.yaml
-```
-{% endtab %}
-{% tab test npm %}
-```shell
-npx specmatic test employees.yaml
-```
-{% endtab %}
-{% tab test docker %}
-```shell
-docker run --rm --network host -v "$(pwd)/employees.yaml:/usr/src/app/employees.yaml" -v "$(pwd)/employees_dictionary.yaml:/usr/src/app/employees_dictionary.yaml" znsio/specmatic test "employees.yaml"
-```
-{% endtab %}
-{% endtabs %}
-
-We can now examine the request sent to the service by reviewing the logs.
-```shell
-POST /employees
-Accept-Charset: UTF-8
-Accept: */*
-Content-Type: application/json
-{
-  "name": "John Doe",
-  "department": "IT",
-  "employeeCode": "12345"
-}
-```
-Notice that the values from the dictionary are utilized in the requests.
-
-#### Generative Tests
-
-As it's evident that only valid values can be included in the dictionary. hence, generative tests will ignore the values in the dictionary for the key being mutated.
-The other keys will still retrieve values from the dictionary if available; otherwise, random values will be generated.
-
-For instance, if you execute the specification with generative tests enabled, one of the request will appear as follows:
-```shell
-POST /employees
-Accept-Charset: UTF-8
-Accept: */*
-Content-Type: application/json
-{
-  "name": null,
-  "department": "IT",
-  "employeeCode": "12345"
-}
-```
-
-In this case, the key `name` is being mutated, which results in the value from the dictionary being disregarded.
-While the values for `department` and `employeeCode` are still being retrieved from the dictionary.
-
 ### Sample Project
 
 [https://github.com/znsio/specmatic-order-api-java](https://github.com/znsio/specmatic-order-api-java)