Add a field for the version of the standard the data is published to

codelists/open/linkRelationType.csv

@@ -1,5 +1,6 @@
 code,title,description
+describedby,Described by,Refers to the canonical JSON schema that describes the structure of the data.
 "tag:opentelecomdata.net,2022:nodesAPI",Nodes API,An API endpoint that returns a paginated list of `Node` objects.
 "tag:opentelecomdata.net,2022:nodesFile",Nodes file,A JSON Lines file containing one `Node` object per line. The file may be compressed using ZIP or GZIP.
 "tag:opentelecomdata.net,2022:spansAPI",Spans API,An API endpoint that returns a paginated list of `Span` objects.
-"tag:opentelecomdata.net,2022:spansFile",Spans file,A JSON Lines file containing one `Span` object per line. The file may be compressed using ZIP or GZIP.
+"tag:opentelecomdata.net,2022:spansFile",Spans file,A JSON Lines file containing one `Span` object per line. The file may be compressed using ZIP or GZIP.

examples/csv/links.csv

@@ -0,0 +1,2 @@
+id,links/0/href,links/0/rel
+a096d627-72e1-4f9b-b129-951b1737bff4,https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json,describedby

examples/csv/nodes.csv

@@ -1,3 +1,3 @@
 id,nodes/0/id,nodes/0/name,nodes/0/phase/id,nodes/0/phase/name,nodes/0/status,nodes/0/location/type,nodes/0/location/coordinates,nodes/0/address/streetAddress,nodes/0/address/locality,nodes/0/address/region,nodes/0/address/postalCode,nodes/0/address/country,nodes/0/type,nodes/0/accessPoint,nodes/0/power,nodes/0/technologies,nodes/0/physicalInfrastructureProvider/id,nodes/0/physicalInfrastructureProvider/name,nodes/0/networkProvider/id,nodes/0/networkProvider/name
 a096d627-72e1-4f9b-b129-951b1737bff4,1,Accra,1,NextGen Phase 1,operational,Point,-0.174;5.625,Boundary Rd,Shiashie,Accra,12345,GH,pop,True,True,ip,GH-RGD-CS111111111,FibreCo,GH-RGD-CS222222222,FastWeb
-a096d627-72e1-4f9b-b129-951b1737bff4,2,Kumasi,1,NextGen Phase 1,operational,Point,-1.628;6.711,Kejetia Road,Bantama,Kumasi,00000,GH,pop,True,True,ip,GH-RGD-CS111111111,FibreCo,GH-RGD-CS222222222,FastWeb
+a096d627-72e1-4f9b-b129-951b1737bff4,2,Kumasi,1,NextGen Phase 1,operational,Point,-1.628;6.711,Kejetia Road,Bantama,Kumasi,00000,GH,pop,False,True,ip,GH-RGD-CS111111111,FibreCo,GH-RGD-CS222222222,FastWeb

examples/csv/template/links.csv

@@ -0,0 +1 @@
+id,links/0/href,links/0/rel

examples/json/api-response.json

@@ -2,11 +2,23 @@
   "networks": [
     {
       "id": "fd7b30d6-f514-4cd0-a5ac-29a774f53a43",
-      "name": "Ghana Fibre Network"
+      "name": "Ghana Fibre Network",
+      "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        }
+      ]
     },
     {
       "id": "acafe566-7ffa-416a-b3b4-84a52386a586",
-      "name": "Togo Fibre Network"
+      "name": "Togo Fibre Network",
+      "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        }
+      ]
     }
   ],
   "links": {

examples/json/multiple-networks.json

@@ -2,11 +2,23 @@
   "networks": [
     {
       "id": "fd7b30d6-f514-4cd0-a5ac-29a774f53a43",
-      "name": "Ghana Fibre Network"
+      "name": "Ghana Fibre Network",
+      "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        }
+      ]
     },
     {
       "id": "acafe566-7ffa-416a-b3b4-84a52386a586",
-      "name": "Togo Fibre Network"
+      "name": "Togo Fibre Network",
+      "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        }
+      ]
     }
   ]
 }

examples/json/network-embedded.json

@@ -7,5 +7,11 @@
   "spans": [
     {},
     {}
+  ],
+  "links": [
+    {
+      "rel": "describedby",
+      "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+    }
   ]
 }

examples/json/network-package.json

@@ -325,7 +325,13 @@
       },
       "accuracy": 250,
       "accuracyDetails": "Measured according to the US National Standard for Spatial Data Accuracy.",
-      "language": "en"
+      "language": "en",
+      "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        }
+      ]
     }
   ]
 }

examples/json/network-separate-endpoints.json

@@ -4,6 +4,10 @@
       "id": "a096d627-72e1-4f9b-b129-951b1737bff4",
       "name": "Ghana Fibre Network",
       "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        },
         {
           "href": "http://example.com/networks/a096d627-72e1-4f9b-b129-951b1737bff4/nodes",
           "rel": "tag:opentelecomdata.net,2022:nodesAPI"

examples/json/network-separate-files.json

@@ -4,6 +4,10 @@
       "id": "a096d627-72e1-4f9b-b129-951b1737bff4",
       "name": "Ghana Fibre Network",
       "links": [
+        {
+          "rel": "describedby",
+          "href": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+        },
         {
           "href": "http://example.com/networks/a096d627-72e1-4f9b-b129-951b1737bff4/nodes.jsonl",
           "rel": "tag:opentelecomdata.net,2022:nodesFile"

schema/network-schema.csv

@@ -24,7 +24,7 @@ For more information, see how to format data for publication.",array,0..n,,https
 ,accuracy,Accuracy,"The horizontal uncertainty, in metres, of the coordinates in this dataset relative to the datum of the coordinate reference system specified in `crs`. Further details about the accuracy of coordinates in this dataset can be provided in `.accuracyDetails`.",number,0..1,,,,,
 ,accuracyDetails,Accuracy details,"Further details about the accuracy specified in `accuracy`. For example, the confidence level of the accuracy measurement, the methodology used to calculate the accuracy, or a local classification of accuracy.",string,0..1,,,,,
 ,language,Language,"The default language of this network,from the open language codelist. A BCP47 language tag is allowed, if there is a user need for the additional information.",string,0..1,,"https://open-fibre-data-standard.readthedocs.io/en/latest/reference/codelists.html#language, https://www.w3.org/International/articles/language-tags/",,,language.csv
-,links,Links,Links to related resources such as API endpoints or bulk files for nodes and spans. Links to API endpoints should be provided when a network is too large to return in a single API response. Links to bulk files should be provided when a network is too large to load into memory.,array,0..n,,,,,
+,links,Links,"Links to related resources. The links array must include a link to the canonical JSON schema that describes the structure of the data. Links to API endpoints for nodes and spans should be provided when a network is too large to return in a single API response and links to bulk files should be provided when a network is too large to load into memory, for more information, see how to publish large networks.",array,1..n,,https://open-fibre-data-standard.readthedocs.io/en/latest/guidance/publication.html#how-to-publish-large-networks,,,
 Node,id,Identifier,An identifier for this node. The identifier must be unique within the scope of the `nodes` array.,string,1..1,,,,,
 Node,name,Node name,A name for this node.,string,0..1,,,,,
 Node,phase,Phase,The phase to which this node belongs.,unknown,0..1,,,,,

schema/network-schema.json

@@ -5,7 +5,8 @@
   "description": "A telecommunication network. A network consists of a set of nodes interconnected by spans.",
   "type": "object",
   "required": [
-    "id"
+    "id",
+    "links"
   ],
   "properties": {
     "id": {
@@ -134,12 +135,23 @@
     },
     "links": {
       "title": "Links",
-      "description": "Links to related resources such as API endpoints or bulk files for nodes and spans. Links to API endpoints should be provided when a network is too large to return in a single API response. Links to bulk files should be provided when a network is too large to load into memory.",
+      "description": "Links to related resources. The links array must include a link to the canonical JSON schema that describes the structure of the data. Links to API endpoints for nodes and spans should be provided when a network is too large to return in a single API response and links to bulk files should be provided when a network is too large to load into memory, for more information, see [how to publish large networks](https://open-fibre-data-standard.readthedocs.io/en/latest/guidance/publication.html#how-to-publish-large-networks).",
       "$comment": "https://github.com/Open-Telecoms-Data/open-fibre-data-standard/issues/75,https://github.com/Open-Telecoms-Data/open-fibre-data-standard/issues/83",
       "type": "array",
       "items": {
         "$ref": "#/definitions/Link"
       },
+      "contains": {
+        "type": "object",
+        "properties": {
+          "href": {
+            "const": "https://raw.githubusercontent.com/Open-Telecoms-Data/open-fibre-data-standard/0__1__0__beta/schema/network-schema.json"
+          },
+          "rel": {
+            "const": "describedby"
+          }
+        }
+      },
       "minItems": 1,
       "uniqueItems": true
     }