Import options¶
The import endpoints has multiple options to give which can affect the way your reports are being processed.
Default API variable values¶
curl \
-X POST \
-H "x-api-key:<API_KEY>" \
-F "file[]=@path/to/testresult" \
-F "os=" \
-F "platform=" \
-F "build=" \
-F "smart=true" \
-F "merge_containers=false" \
-F "suppress_files_moved=false" \
-F "suppress_notifications=false" \
-F "ignore_unspecified_formatter=false" \
"https://app.calliope.pro/api/v2/profile/<profile_id>/import"
Metadata options¶
None of the metadata options have any effect on your results. It's all intended to be able to give some extrabackground infromation to your report.
os
¶
- type:
String
- default: Null
platform
¶
- type:
String
- default: Null
build
¶
- type:
String
- default: Null
Functional options¶
smart
¶
- type:
Boolean
- default:
true
Some formatters have a so called smart
-option. Go to the formatter documentation to find out what this means for you.
In general, when smart
is enabled, the system will try to make the structure of your output prettier by grouping it or sorting it.
For example, the JSON of Fink Link checker is one long list of results for every page that was visited. With smart
enabled, we will group the tests by URL. So:
https://test.com/products/product1
https://test.com/products/product2
https://test.com/products/product2/details
Becomes:
https://test.com
/products
/product1
results/product2
- Results
/details
results
merge_containers
¶
- type:
Boolean
- default:
false
(true for some formatters)
Some formatters have merge_containers
on true
by default. Go to the formatter documentation to find out if this is the case for you.
When enabled, this option will trigger a post-processing function that will merge any containers with the same title
, classification
& description
. The means that the following:
Some Feature
Scenario Outline 1
Secnario 1
Scenario Outline 2
Some Feature
Scenario Outline 1
Secnario 2
Becomes:
Some Feature
Scenario Outline 1
Secnario 1
Secnario 2
Scenario Outline 2
This functionality can be very useful when you run your test Asynchronous and generate multiple result files in your pipeline.
Suppression options¶
suppress_files_moved
¶
- type:
Boolean
- default:
false
When multiple files are uploaded using the file[]
parameter, and some of those files are attachments, a files moved warning will be generated. Setting suppress_files_moved
to true will suppress and hide this warning.
suppress_notifications
¶
- type:
Boolean
- default:
false
After processing your import, we will automatically trigger the event to inform users that are following the profile you're uploading to. Setting suppress_notifications
to true will stop this event from triggering.
ignore_unspecified_formatter
¶
- type:
Boolean
- default:
false
When the /profile/{profileId}/import
endpoint is used, without specifying a formatter, it will generate a unspecified formatter warning.