Merge pull request #258 from Open-Telecoms-Data/254-fibreLength-unit

network-schema: Add unit to Span.fibreLength description
Open-Telecoms-Data · May 8, 2023 · 2849651 · 2849651
2 parents 0ad508d + dc932f9
commit 2849651
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/docs/history/changelog.md b/docs/history/changelog.md
@@ -22,7 +22,11 @@ Iterative improvements are made outside of the release cycle. They do not involv
 - [#213](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/213) - For GeoJSON/JSON conversion, use libcoveofds now.
 - [#232](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/232) - Remove unmaintained GitHub issue admonitions
 
-## 0.3.0 - YYY-MM-DD
+## 0.3.0 - YYYY-MM-DD
+
+### Schema
+
+- [#258](https://github.com/Open-Telecoms-Data/open-fibre-data-standard/pull/258) - Add unit to `Span.fibreLength` description
 
 ### Non-normative documentation
 

diff --git a/schema/network-schema.csv b/schema/network-schema.csv
@@ -99,7 +99,7 @@ spans,spans/fibreTypeDetails,Fibre type details,Further details about a span's f
 spans,spans/fibreTypeDetails/fibreSubtype,Fibre subtype,"The sub-category of the fibre type. For example, G.652.B.",string,0..1,,,,,
 spans,spans/fibreTypeDetails/description,Description,A description of this span's fibre type.,string,0..1,,,,,
 spans,spans/fibreCount,Fibre count,The number of individual optical fibres in this span.,integer,0..1,,,,,
-spans,spans/fibreLength,Fibre length,The physical length of fibre optic cable used in this span.,number,0..1,,,,,
+spans,spans/fibreLength,Fibre length,"The physical length in kilometres, of fibre optic cable used in this span.",number,0..1,,,,,
 spans,spans/technologies,Technologies,"The active technologies used on this span, from the open spanTechnologies codelist. For spans with multiple network providers, the union of the active technologies used by each provider.",array,0..n,,https://open-fibre-data-standard.readthedocs.io/en/latest/reference/codelists.html#spantechnologies,,,spanTechnologies.csv
 spans,spans/capacity,Capacity,"The transmission rate, or throughput, of this span, expressed in Gbit/sec (Gbps). The equipped capacity is the total capacity of the circuits (e.g. E1, DS3, STM-1 etc.) which have been activated in the network transmission equipment of the span. For spans with multiple network providers, the sum of the capacity of each provider's network on this span. Further details of this span's capacity can be provided in `.capacityDetails`.",number,0..1,,,,,
 spans,spans/capacityDetails,Capacity details,Further details about this span's capacity,object,0..1,,,,,

diff --git a/schema/network-schema.json b/schema/network-schema.json
@@ -436,7 +436,7 @@
         },
         "fibreLength": {
           "title": "Fibre length",
-          "description": "The physical length of fibre optic cable used in this span.",
+          "description": "The physical length in kilometres, of fibre optic cable used in this span.",
           "type": "number",
           "$comment": ""
         },