X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=docs%2Fmodel%2Fcurrent%2Fschema%2Ftest_case.info.schema.json;fp=docs%2Fmodel%2Fcurrent%2Fschema%2Ftest_case.info.schema.json;h=bdfea5990798dc94f22b069942faf89e31b8cde1;hp=7bdfa27f8d6f9b2307aa51cd4698695421b12fbe;hb=86138e3eb1fbaad89eb1f91937ae6bd6ba55da37;hpb=89c40769ccf9558024a23a4de1563355a39db5a8 diff --git a/docs/model/current/schema/test_case.info.schema.json b/docs/model/current/schema/test_case.info.schema.json index 7bdfa27f8d..bdfea59907 100644 --- a/docs/model/current/schema/test_case.info.schema.json +++ b/docs/model/current/schema/test_case.info.schema.json @@ -1,5 +1,5 @@ { - "$id": "https://fd.io/FIXME/CSIT/UTI/test_case/info/1.2.0", + "$id": "https://fd.io/FIXME/CSIT/UTI/test_case/info/1.3.0", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Schema for output of test case.", "allOf": [ @@ -159,9 +159,51 @@ } }, "required": [ + "type", "loss", "aggregate_rate" ] + }, + { + "description": "Result type HOSTSTACK case.", + "additionalProperties": false, + "properties": { + "type": { + "const": "hoststack" + }, + "bandwidth": { + "description": "Goodput measured in bits per second.", + "$ref": "#/$defs/types/bandwidth" + }, + "completed_requests": { + "description": "Number of completed requests.", + "$ref": "#/$defs/types/count_requests" + }, + "failed_requests": { + "description": "Number of failed requests.", + "$ref": "#/$defs/types/count_requests" + }, + "retransmits": { + "description": "Number of retransmits.", + "$ref": "#/$defs/types/count_packets" + }, + "latency": { + "description": "Value and unit of latency.", + "$ref": "#/$defs/types/value_with_unit" + }, + "duration": { + "description": "The relative time difference (in seconds) between program start and end.", + "$ref": "#/$defs/types/time_quantity" + }, + "rate": { + "description": "RPS or CPS rate, with corresponding unit, as reported by TG.", + "$ref": "#/$defs/types/rate_without_bandwidth" + } + }, + "required": [ + "type", + "bandwidth" + ] } ] } @@ -224,7 +266,7 @@ "version": { "description": "CSIT model version (semver format) the exporting code adhered to.", "type": "string", - "const": "1.2.0" + "const": "1.3.0" } }, "required": [ @@ -306,11 +348,12 @@ "maxItems": 0 }, "rate_unit": { - "description": "Packets per second (pps) or connections per second (cps).", + "description": "Packets per second (pps), connections per second (cps), requests per second (rps).", "type": "string", "enum": [ "pps", - "cps" + "cps", + "rps" ] }, "bandwidth_unit": { @@ -340,6 +383,27 @@ } ] }, + "count_requests": { + "description": "Type, for counting requests.", + "allOf": [ + { + "$ref": "#/$defs/types/value_with_unit" + }, + { + "properties": { + "value": { + "description": "A number of requests of interest." + }, + "unit": { + "description": "Unit suitable for displaying request counts.", + "enum": [ + "requests" + ] + } + } + } + ] + }, "time_quantity": { "description": "Reusable type, for various time quantites.", "allOf": [