Skip to content

Commit

Permalink
Update schemas
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisJamesC committed Oct 13, 2023
1 parent f71a501 commit 24bd9ee
Show file tree
Hide file tree
Showing 31 changed files with 1,225 additions and 1,155 deletions.
1,268 changes: 685 additions & 583 deletions reports/src/types/TestRunReport.d.ts

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion schemas/TODO.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
TODO: Find an elegant way to retrieve interuss/monitoring/schemas/* files.
TODO: Find an elegant way to retrieve interuss/monitoring/schemas/\* files.
18 changes: 18 additions & 0 deletions schemas/monitorlib/dicts/RemovedElement.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/monitorlib/dicts/RemovedElement.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "monitoring.monitorlib.dicts.RemovedElement, as defined in monitoring/monitorlib/dicts.py",
"properties": {
"$ref": {
"description": "Path to content that replaces the $ref",
"type": "string"
},
"address": {
"type": "string"
}
},
"required": [
"address"
],
"type": "object"
}
60 changes: 52 additions & 8 deletions schemas/monitorlib/fetch/Query.json
Original file line number Diff line number Diff line change
@@ -1,22 +1,66 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/monitorlib/fetch/Query.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "monitoring.monitorlib.fetch.Query, as defined in monitoring/monitorlib/fetch/__init__.py",
"properties": {
"$ref": {
"type": "string",
"description": "Path to content that replaces the $ref"
"description": "Path to content that replaces the $ref",
"type": "string"
},
"response": {
"$ref": "ResponseDescription.json"
"query_type": {
"description": "If specified, the recognized type of this query.",
"enum": [
"astm.f3411.v22a.sp.flights",
"astm.f3411.v19.sp.flights",
"astm.f3411.v22a.sp.flight_details",
"astm.f3411.v19.sp.flight_details",
"astm.f3548.v21.dss.queryOperationalIntentReferences",
"astm.f3548.v21.dss.getOperationalIntentReference",
"astm.f3548.v21.dss.createOperationalIntentReference",
"astm.f3548.v21.dss.updateOperationalIntentReference",
"astm.f3548.v21.dss.deleteOperationalIntentReference",
"astm.f3548.v21.dss.queryConstraintReferences",
"astm.f3548.v21.dss.getConstraintReference",
"astm.f3548.v21.dss.createConstraintReference",
"astm.f3548.v21.dss.updateConstraintReference",
"astm.f3548.v21.dss.deleteConstraintReference",
"astm.f3548.v21.dss.querySubscriptions",
"astm.f3548.v21.dss.getSubscription",
"astm.f3548.v21.dss.createSubscription",
"astm.f3548.v21.dss.updateSubscription",
"astm.f3548.v21.dss.deleteSubscription",
"astm.f3548.v21.dss.makeDssReport",
"astm.f3548.v21.uss.setUssAvailability",
"astm.f3548.v21.uss.getUssAvailability",
"astm.f3548.v21.uss.getOperationalIntentDetails",
"astm.f3548.v21.uss.getOperationalIntentTelemetry",
"astm.f3548.v21.uss.notifyOperationalIntentDetailsChanged",
"astm.f3548.v21.uss.getConstraintDetails",
"astm.f3548.v21.uss.notifyConstraintDetailsChanged",
"astm.f3548.v21.uss.makeUssReport"
],
"type": [
"string",
"null"
]
},
"request": {
"$ref": "RequestDescription.json"
},
"response": {
"$ref": "ResponseDescription.json"
},
"server_id": {
"description": "If specified, identifier of the USS/participant hosting the server involved in this query.",
"type": [
"string",
"null"
]
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/monitorlib/fetch/Query.json",
"description": "monitoring.monitorlib.fetch.Query, as defined in monitoring/monitorlib/fetch/__init__.py",
"required": [
"request",
"response"
]
],
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/action_generators/definitions/ActionGeneratorDefinition.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "monitoring.uss_qualifier.action_generators.definitions.ActionGeneratorDefinition, as defined in monitoring/uss_qualifier/action_generators/definitions.py",
"properties": {
"$ref": {
"type": "string",
"description": "Path to content that replaces the $ref"
"description": "Path to content that replaces the $ref",
"type": "string"
},
"generator_type": {
"type": "string",
"description": "Type of action generator"
"description": "Type of action generator",
"type": "string"
},
"resources": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Mapping of the ID a resource will be known by in the child action -> the ID a resource is known by in the parent test suite.\n\nThe child action resource ID <key> is supplied by the parent test suite resource ID <value>.\n\nResources not included in this field will not be available to the child action.\n\nIf the parent resource ID is suffixed with ? then the resource will not be required (and will not be populated for the child action when not present in the parent)",
"properties": {
"$ref": {
"type": "string",
"description": "Path to content that replaces the $ref"
"description": "Path to content that replaces the $ref",
"type": "string"
}
},
"additionalProperties": {
"type": "string"
},
"description": "Mapping of the ID a resource will be known by in the child action -> the ID a resource is known by in the parent test suite.\n\nThe child action resource ID <key> is supplied by the parent test suite resource ID <value>.\n\nResources not included in this field will not be available to the child action.\n\nIf the parent resource ID is suffixed with ? then the resource will not be required (and will not be populated for the child action when not present in the parent)"
"type": "object"
},
"specification": {
"type": "object",
"description": "Specification of action generator; format is the ActionGeneratorSpecificationType that corresponds to the `generator_type`"
"description": "Specification of action generator; format is the ActionGeneratorSpecificationType that corresponds to the `generator_type`",
"type": "object"
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/suites/definitions/ActionGeneratorDefinition.json",
"description": "monitoring.uss_qualifier.suites.definitions.ActionGeneratorDefinition, as defined in monitoring/uss_qualifier/suites/definitions.py",
"required": [
"generator_type",
"resources"
]
],
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -1,56 +1,89 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/ArtifactsConfiguration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "monitoring.uss_qualifier.configurations.configuration.ArtifactsConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"properties": {
"$ref": {
"type": "string",
"description": "Path to content that replaces the $ref"
"description": "Path to content that replaces the $ref",
"type": "string"
},
"report_html": {
"graph": {
"description": "If specified, configuration describing a desired graph visualization summarizing the test run",
"oneOf": [
{
"type": "null"
},
{
"$ref": "ReportHTMLConfiguration.json"
"$ref": "GraphConfiguration.json"
}
],
"description": "If specified, configuration describing how an HTML version of the report should be generated"
]
},
"redact_access_tokens": {
"description": "When True, look for instances of \"Authorization\" keys in the report with values starting \"Bearer \" and redact the signature from those access tokens",
"type": "boolean"
},
"report": {
"description": "Configuration for report generation",
"oneOf": [
{
"type": "null"
},
{
"$ref": "ReportConfiguration.json"
}
],
"description": "Configuration for report generation"
]
},
"tested_roles": {
"report_html": {
"description": "If specified, configuration describing how an HTML version of the report should be generated",
"oneOf": [
{
"type": "null"
},
{
"$ref": "TestedRolesConfiguration.json"
"$ref": "ReportHTMLConfiguration.json"
}
],
"description": "If specified, configuration describing a desired report summarizing tested requirements for each specified participant and role"
]
},
"graph": {
"sequence_view": {
"description": "If specified, configuration describing a desired report describing the sequence of events that occurred during the test",
"oneOf": [
{
"type": "null"
},
{
"$ref": "GraphConfiguration.json"
"$ref": "SequenceViewConfiguration.json"
}
]
},
"templated_reports": {
"description": "List of report templates to be rendered",
"items": {
"$ref": "TemplatedReportConfiguration.json"
},
"type": "array"
},
"tested_requirements": {
"description": "If specified, configuration describing a desired report summarizing all tested requirements for each participant",
"oneOf": [
{
"type": "null"
},
{
"$ref": "TestedRequirementsConfiguration.json"
}
],
"description": "If specified, configuration describing a desired graph visualization summarizing the test run"
]
},
"tested_roles": {
"description": "If specified, configuration describing a desired report summarizing tested requirements for each specified participant and role",
"oneOf": [
{
"type": "null"
},
{
"$ref": "TestedRolesConfiguration.json"
}
]
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/ArtifactsConfiguration.json",
"description": "monitoring.uss_qualifier.configurations.configuration.ArtifactsConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py"
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/ReportConfiguration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "monitoring.uss_qualifier.configurations.configuration.ReportConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"properties": {
"$ref": {
"type": "string",
"description": "Path to content that replaces the $ref"
"description": "Path to content that replaces the $ref",
"type": "string"
},
"report_path": {
"type": "string",
"description": "File name of the report to write (if test_config provided) or read (if test_config not provided)"
},
"redact_access_tokens": {
"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"
"description": "File name of the report to write (if test_config provided) or read (if test_config not provided)",
"type": "string"
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/ReportConfiguration.json",
"description": "monitoring.uss_qualifier.configurations.configuration.ReportConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"required": [
"report_path"
]
],
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/ReportHTMLConfiguration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"description": "monitoring.uss_qualifier.configurations.configuration.ReportHTMLConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"properties": {
"$ref": {
"type": "string",
"description": "Path to content that replaces the $ref"
"description": "Path to content that replaces the $ref",
"type": "string"
},
"html_path": {
"type": "string",
"description": "Path of HTML file to contain an HTML rendering of the test report"
"description": "Path of HTML file to contain an HTML rendering of the raw test report object",
"type": "string"
}
},
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/ReportHTMLConfiguration.json",
"description": "monitoring.uss_qualifier.configurations.configuration.ReportHTMLConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"required": [
"html_path"
]
],
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/SequenceViewConfiguration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "monitoring.uss_qualifier.configurations.configuration.SequenceViewConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"properties": {
"$ref": {
"description": "Path to content that replaces the $ref",
"type": "string"
},
"output_path": {
"description": "Path of a folder into which report HTML files should be written",
"type": "string"
}
},
"required": [
"output_path"
],
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/TemplatedReportConfiguration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "monitoring.uss_qualifier.configurations.configuration.TemplatedReportConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"properties": {
"$ref": {
"description": "Path to content that replaces the $ref",
"type": "string"
},
"configuration": {
"description": "Configuration to be injected in the templated report",
"oneOf": [
{
"type": "null"
},
{
"$ref": "TemplatedReportInjectedConfiguration.json"
}
]
},
"output_path": {
"description": "Path of HTML file to contain the rendered templated report",
"type": "string"
},
"template_url": {
"description": "Url of the template to download from",
"type": "string"
}
},
"required": [
"output_path",
"template_url"
],
"type": "object"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"$id": "https://github.com/interuss/monitoring/blob/main/schemas/monitoring/uss_qualifier/configurations/configuration/TemplatedReportInjectedConfiguration.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "monitoring.uss_qualifier.configurations.configuration.TemplatedReportInjectedConfiguration, as defined in monitoring/uss_qualifier/configurations/configuration.py",
"properties": {
"$ref": {
"description": "Path to content that replaces the $ref",
"type": "string"
}
},
"type": "object"
}
Loading

0 comments on commit 24bd9ee

Please sign in to comment.