Skip to content

Commit d298023

Browse files
Updated the documentation
1 parent 2cbc9ca commit d298023

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ This program generates a fully-fledged Excel-based Robot Framework Datadriver te
2020
- __Red__ fields indicate a mandatory parameter
2121
- __Green__ fields indicate optional parameters
2222
- __Grey__ fields indicate fields which are not supported for this API call
23-
- If a parameter has been assigned with an _enum_ list of valid values, the program will add these values as a dropdown to the Excel list. Users can select a value from that list (but are still able to overwrite that value)
23+
- __Beige__ fields indicate test parameters such as test name, tags etc
24+
- You can easily customize these values in the program.
25+
- If a parameter has been assigned with an _enum_ list of valid values, the program will add these values as a pre-populated dropdown to the Excel list. Users can select a value from that list (but are still able to overwrite that value)
2426
- By default, the program will only highlight the optional/mandatory parameter fields (but will not populate them with any content). You can override this setting and tell the program to pre-populate the parameters with example data straight from your OpenAPI file.
2527
- Expected HTTP response codes are extracted from the OpenAPI file and added to the Excel sheet as default value
26-
- All OpenAPI input parameters in the Excel file are alphabetically sorted for a better user convenience when it comes to populating the sheet
28+
- All OpenAPI input parameters in the Excel file are alphabetically sorted for a better user convenience when it comes to populating the sheet with data.
2729

2830
## Robot features
2931

@@ -32,7 +34,7 @@ This program generates a fully-fledged Excel-based Robot Framework Datadriver te
3234
- a JSON request body will only be sent to the API if the respective API service method supports it
3335
- the JSON request body will only contain parameters that belong to this specific API service method
3436
- If a service method requires parameters to be sent as part of the API's URL, the program will generate these URLs for you.
35-
- Some minor adjustments to the Robot file(s) may still be necessary (e.g. initial API setup, nested data structures)
37+
- Some minor adjustments to the Robot file(s) may still be necessary (e.g. initial API setup, nested data structures) - see known issues.
3638

3739
## Documentation
3840

0 commit comments

Comments
 (0)