Skip to content

Commit

Permalink
[schemas] Update types (#10)
Browse files Browse the repository at this point in the history
Update typing from current main version :
interuss/monitoring@ede4ca6
  • Loading branch information
barroco authored Aug 14, 2023
1 parent 134356d commit 04f514d
Show file tree
Hide file tree
Showing 6 changed files with 94 additions and 94 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"description": "File name of the report to write (if test_config provided) or read (if test_config not provided)"
},
"redact_access_tokens": {
"type": "integer",
"type": "boolean",
"description": "When True, look for instances of \"Authorization\" keys in the report with values starting \"Bearer \" and redact the signature from those access tokens"
}
},
Expand Down
16 changes: 8 additions & 8 deletions schemas/uss_qualifier/reports/report/CheckedCapability.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@
"type": "string",
"description": "Path to content that replaces the $ref"
},
"capability_id": {
"capability_verified": {
"type": "boolean",
"description": "Whether this capability was successfully verified"
},
"capability_location": {
"type": "string",
"description": "ID of the existing/previous participant-verifiable capability."
"description": "The location of the ParticipantCapabilityConditionEvaluationReport for the capability, relative to the TestSuiteReport in which this checked requirement is located."
},
"report_location": {
"type": "string",
"description": "Location of the ParticipantCapabilityEvaluationReport for the existing/previous capability, relative to the TestSuiteReport in which the CapabilityVerifiedConditionEvaluationReport containing this CheckedCapability is located."
},
"capability_verified": {
"type": "integer",
"description": "Whether this capability was successfully verified"
},
"capability_location": {
"capability_id": {
"type": "string",
"description": "The location of the ParticipantCapabilityConditionEvaluationReport for the capability, relative to the TestSuiteReport in which this checked requirement is located."
"description": "ID of the existing/previous participant-verifiable capability."
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/reports/report/CheckedCapability.json",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,21 @@
],
"description": "When specified, the condition evaluated was CapabilityVerifiedCondition."
},
"no_failed_checks": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "NoFailedChecksConditionEvaluationReport.json"
}
],
"description": "When specified, the condition evaluated was NoFailedChecksCondition."
},
"condition_satisfied": {
"type": "boolean",
"description": "Whether the condition was satisfied for the relevant participant."
},
"any_conditions": {
"oneOf": [
{
Expand All @@ -39,10 +54,6 @@
],
"description": "When specified, the condition evaluated was RequirementsCheckedCondition."
},
"condition_satisfied": {
"type": "integer",
"description": "Whether the condition was satisfied for the relevant participant."
},
"all_conditions": {
"oneOf": [
{
Expand All @@ -53,17 +64,6 @@
}
],
"description": "When specified, the condition evaluated was AllConditions."
},
"no_failed_checks": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "NoFailedChecksConditionEvaluationReport.json"
}
],
"description": "When specified, the condition evaluated was NoFailedChecksCondition."
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/reports/report/ParticipantCapabilityConditionEvaluationReport.json",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@
"type": "string",
"description": "Path to content that replaces the $ref"
},
"capability_id": {
"type": "string",
"description": "ID of capability being evaluated."
"condition_evaluation": {
"$ref": "ParticipantCapabilityConditionEvaluationReport.json",
"description": "Report produced by evaluating the condition for verifying this capability."
},
"verified": {
"type": "boolean",
"description": "Whether the capability was successfully verified."
},
"participant_id": {
"type": "string",
"description": "ID of participant for which capability is being evaluated."
},
"verified": {
"type": "integer",
"description": "Whether the capability was successfully verified."
},
"condition_evaluation": {
"$ref": "ParticipantCapabilityConditionEvaluationReport.json",
"description": "Report produced by evaluating the condition for verifying this capability."
"capability_id": {
"type": "string",
"description": "ID of capability being evaluated."
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/reports/report/ParticipantCapabilityEvaluationReport.json",
Expand Down
78 changes: 39 additions & 39 deletions schemas/uss_qualifier/reports/report/TestScenarioReport.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,37 @@
"type": "string",
"description": "Path to content that replaces the $ref"
},
"name": {
"successful": {
"type": "boolean",
"description": "True iff test scenario completed normally with no failed checks"
},
"start_time": {
"type": "string",
"description": "Name of this test scenario"
"format": "date-time",
"description": "Time at which the test scenario started"
},
"cases": {
"type": "array",
"items": {
"$ref": "TestCaseReport.json"
},
"description": "Reports for each of the test cases in this test scenario"
},
"documentation_url": {
"type": "string",
"description": "URL at which this test scenario is described"
},
"execution_error": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "ErrorReport.json"
}
],
"description": "If there was an error while executing this test scenario, this field describes the error"
},
"end_time": {
"type": [
"string",
Expand All @@ -22,6 +45,17 @@
"format": "date-time",
"description": "Time at which the test scenario completed or encountered an error"
},
"cleanup": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "TestStepReport.json"
}
],
"description": "If this test scenario performed cleanup, this report captures the relevant information."
},
"notes": {
"type": [
"object",
Expand All @@ -38,47 +72,13 @@
},
"description": "Additional information about this scenario that may be useful"
},
"cases": {
"type": "array",
"items": {
"$ref": "TestCaseReport.json"
},
"description": "Reports for each of the test cases in this test scenario"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Time at which the test scenario started"
},
"scenario_type": {
"type": "string",
"description": "Type of this test scenario"
},
"cleanup": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "TestStepReport.json"
}
],
"description": "If this test scenario performed cleanup, this report captures the relevant information."
},
"execution_error": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "ErrorReport.json"
}
],
"description": "If there was an error while executing this test scenario, this field describes the error"
},
"successful": {
"type": "integer",
"description": "True iff test scenario completed normally with no failed checks"
"name": {
"type": "string",
"description": "Name of this test scenario"
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/reports/report/TestScenarioReport.json",
Expand Down
42 changes: 21 additions & 21 deletions schemas/uss_qualifier/reports/report/TestSuiteReport.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@
"type": "string",
"description": "Path to content that replaces the $ref"
},
"suite_type": {
"successful": {
"type": "boolean",
"description": "True iff test suite completed normally with no failed checks"
},
"start_time": {
"type": "string",
"description": "Type/location of this test suite"
"format": "date-time",
"description": "Time at which the test suite started"
},
"actions": {
"type": "array",
"items": {
"$ref": "TestSuiteActionReport.json"
},
"description": "Reports from test scenarios and test suites comprising the test suite for this report"
"documentation_url": {
"type": "string",
"description": "URL at which this test suite is described"
},
"capability_evaluations": {
"type": "array",
Expand All @@ -24,19 +26,6 @@
},
"description": "List of capabilities defined in this test suite, evaluated for each participant."
},
"documentation_url": {
"type": "string",
"description": "URL at which this test suite is described"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Time at which the test suite started"
},
"successful": {
"type": "integer",
"description": "True iff test suite completed normally with no failed checks"
},
"end_time": {
"type": [
"string",
Expand All @@ -45,6 +34,17 @@
"format": "date-time",
"description": "Time at which the test suite completed"
},
"actions": {
"type": "array",
"items": {
"$ref": "TestSuiteActionReport.json"
},
"description": "Reports from test scenarios and test suites comprising the test suite for this report"
},
"suite_type": {
"type": "string",
"description": "Type/location of this test suite"
},
"name": {
"type": "string",
"description": "Name of this test suite"
Expand Down

0 comments on commit 04f514d

Please sign in to comment.