Skip to content

Commit

Permalink
additional_checks: Link to schema docs
Browse files Browse the repository at this point in the history 
#13 (comment)
  • Loading branch information
@jarofgreen
jarofgreen committed Nov 8, 2022
1 parent 9dd1c5f commit 8b41c2e
Showing 1 changed file with 43 additions and 26 deletions.
69 changes: 43 additions & 26 deletions cove_ofds/templates/cove_ofds/additional_checks_table.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@

{% if 'span_start_node_not_found' in additional_checks or 'span_end_node_not_found' in additional_checks %}
<h3>{% trans 'Node references' %}</h3>
<p>{% trans 'Your data contains spans with node references that cannot be resolved. `Span.start` and `Span.end` must match the `.id` of exactly one node in the `/nodes` array.' %}</p>
{% if 'span_start_node_not_found' in additional_checks %}
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,start">{% trans 'Schema Documentation' %}</a></p>
{% endif %}
{% if 'span_end_node_not_found' in additional_checks %}
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,end">{% trans 'Schema Documentation' %}</a></p>
{% endif %}
<p>
{% trans 'Your data contains spans with node references that cannot be resolved. `Span.start` and `Span.end` must match the `.id` of exactly one node in the `/nodes` array.' %}
For more information, see
<a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,start">`Span.start`</a> and
<a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Span,end">`Span.end`</a>.
</p>
<table class="table">
<thead>
<tr>
Expand Down Expand Up @@ -52,8 +51,10 @@ <h3>{% trans 'Node references' %}</h3>

{% if 'node_location_type_incorrect' in additional_checks %}
<h3>{% trans 'Node location type' %}</h3>
<p>{% trans 'Your data contains nodes with incorrect location types. `/nodes/location/type` must be `Point`.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains nodes with incorrect location types. `/nodes/location/type` must be `Point`.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">`Geometry.type`</a>.
</p>
<table class="table">
<thead>
<tr>
Expand All @@ -79,8 +80,10 @@ <h3>{% trans 'Node location type' %}</h3>

{% if 'node_location_coordinates_incorrect' in additional_checks %}
<h3>{% trans 'Node location coordinates' %}</h3>
<p>{% trans 'Your data contains nodes with incorrectly formatted location coordinates. `/nodes/location/coordinates` must be a single position, i.e. an array of numbers.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains nodes with incorrectly formatted location coordinates. `/nodes/location/coordinates` must be a single position, i.e. an array of numbers.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">`Geometry.coordinates`</a>.
</p>
<table class="table">
<thead>
<tr>
Expand All @@ -106,8 +109,10 @@ <h3>{% trans 'Node location coordinates' %}</h3>

{% if 'span_route_type_incorrect' in additional_checks %}
<h3>{% trans 'Span route geometry' %}</h3>
<p>{% trans 'Your data contains spans with incorrect route types. `/spans/route/type` must be `LineString`.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains spans with incorrect route types. `/spans/route/type` must be `LineString`.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,type">`Geometry.type`</a>.
</p>
<table class="table">
<thead>
<tr>
Expand All @@ -133,8 +138,10 @@ <h3>{% trans 'Span route geometry' %}</h3>

{% if 'span_route_coordinates_incorrect' in additional_checks %}
<h3>{% trans 'Span route coordinates' %}</h3>
<p>{% trans 'Your data contains spans with incorrectly formatted route coordinates. `/spans/route/coordinates` must be an array of positions, i.e. an array of arrays of numbers.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains spans with incorrectly formatted route coordinates. `/spans/route/coordinates` must be an array of positions, i.e. an array of arrays of numbers.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Geometry,coordinates">`Geometry.coordinates`</a>.
</p>
<table class="table">
<thead>
<tr>
Expand All @@ -160,8 +167,10 @@ <h3>{% trans 'Span route coordinates' %}</h3>

{% if 'node_phase_reference_id_not_found' in additional_checks or 'span_phase_reference_id_not_found' in additional_checks or 'contract_related_phase_reference_id_not_found' in additional_checks %}
<h3>{% trans 'Phase references' %}</h3>
<p>{% trans 'Your data contains phase references that cannot be resolved. The `.id` of each phase reference must match the `.id` of exactly one phase in the `/phases` array.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,id">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains phase references that cannot be resolved. The `.id` of each phase reference must match the `.id` of exactly one phase in the `/phases` array.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,id">`PhaseReference.id`</a>.
</p>
{% if 'node_phase_reference_id_not_found' in additional_checks %}
<table class="table">
<thead>
Expand Down Expand Up @@ -235,8 +244,10 @@ <h3>{% trans 'Phase references' %}</h3>

{% if 'node_phase_reference_name_does_not_match' in additional_checks or 'span_phase_reference_name_does_not_match' in additional_checks or 'contract_related_phase_reference_name_does_not_match' in additional_checks %}
<h3>{% trans 'Phase names' %}</h3>
<p>{% trans 'Your data contains phase references with inconsistent names. The `.name` of each phase reference must match the `.name` of the phase it references.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,name">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains phase references with inconsistent names. The `.name` of each phase reference must match the `.name` of the phase it references.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/PhaseReference,name">`PhaseReference.name`</a>.
</p>
{% if 'node_phase_reference_name_does_not_match' in additional_checks %}
<table class="table">
<thead>
Expand Down Expand Up @@ -308,8 +319,10 @@ <h3>{% trans 'Phase names' %}</h3>

{% if 'node_organisation_reference_id_not_found' in additional_checks or 'node_organisation_reference_id_not_found' in additional_checks or 'phase_organisation_reference_id_not_found' in additional_checks %}
<h3>{% trans 'Organisation references' %}</h3>
<p>{% trans 'Your data contains organisation references that cannot be resolved. The `.id` of each organisation reference must match the `.id` of exactly one organisation in the `/organisations` array.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,id">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains organisation references that cannot be resolved. The `.id` of each organisation reference must match the `.id` of exactly one organisation in the `/organisations` array.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,id">`OrganisationReference.id`</a>.
</p>
{% if 'node_organisation_reference_id_not_found' in additional_checks %}
<table class="table">
<thead>
Expand Down Expand Up @@ -388,10 +401,12 @@ <h3>{% trans 'Organisation references' %}</h3>



{% if 'node_organisation_reference_name_does_not_match' in additional_checks %}
{% if 'node_organisation_reference_name_does_not_match' in additional_checks or 'span_organisation_reference_name_does_not_match' in additional_checks or 'phase_organisation_reference_name_does_not_match' in additional_checks %}
<h3>{% trans 'Organisation names' %}</h3>
<p>{% trans 'Your data contains organisation references with inconsistent names. The `.name` of each organisation reference must match the `.name` of the organisation it references.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,name">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains organisation references with inconsistent names. The `.name` of each organisation reference must match the `.name` of the organisation it references.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/OrganisationReference,name">`OrganisationReference.name`</a>.
</p>
{% if 'node_organisation_reference_name_does_not_match' in additional_checks %}
<table class="table">
<thead>
Expand Down Expand Up @@ -471,8 +486,10 @@ <h3>{% trans 'Organisation names' %}</h3>

{% if 'node_international_connections_country_not_set' in additional_checks %}
<h3>{% trans 'International connection countries' %}</h3>
<p>{% trans 'Your data contains nodes with international connections that do not specify a country. `.country` must be set for each international connection in `/nodes/internationalConnections`.' %}</p>
<p><a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Node,internationalConnections">{% trans 'Schema Documentation' %}</a></p>
<p>
{% trans 'Your data contains nodes with international connections that do not specify a country. `.country` must be set for each international connection in `/nodes/internationalConnections`.' %}
For more information, see <a target="_blank" href="https://open-fibre-data-standard.readthedocs.io/en/0.1-dev/reference/schema.html#network-schema.json,/definitions/Node,internationalConnections">`Node.internationalConnections`</a>.
</p>
<table class="table">
<thead>
<tr>
Expand Down

0 comments on commit 8b41c2e

Please sign in to comment.