Relative link

OpenDataServices · Jun 26, 2018 · 7c0596a · 7c0596a
1 parent 0384cfe
commit 7c0596a
Show file tree

Hide file tree

Showing 2 changed files with 82 additions and 32 deletions.
diff --git a/docs/example/index.rst b/docs/example/index.rst
@@ -68,4 +68,11 @@ Attributes
 .. jsonschema:: ../../schema/measures/pcWomenCompletingTraining2.json
     :include: attributes
 
+JSON Representation
+-------------------
 
+.. jsoninclude:: ../../schema/measures/pcWomenCompletingTraining2.json
+   :jsonpointer: /example
+
+Tabular representation
+-----------------------
diff --git a/schema/measures/pcWomenCompletingTraining2.json b/schema/measures/pcWomenCompletingTraining2.json
@@ -19,41 +19,45 @@
       "max": 1,
       "min": 0
     },
-    "numerator":{
-      "title":"Numerator",
-      "description":"Numerator",
-      "type":"object",
-      "properties":{
-        "code":{
-          "title":"nPWT",
-          "description":"The code for this indicator is nPWT",
-          "type":"string",
-          "enum":["nPWT"]
+    "numerator": {
+      "title": "Numerator",
+      "description": "Numerator",
+      "type": "object",
+      "properties": {
+        "code": {
+          "title": "nPWT",
+          "description": "The code for this indicator is nPWT",
+          "type": "string",
+          "enum": [
+            "nPWT"
+          ]
         },
-        "value":{
-          "title":"Training: Female participants",
-          "description":"Number of training participants whose sex is female.",
-          "type":"number",
-          "min":0
+        "value": {
+          "title": "Training: Female participants",
+          "description": "Number of training participants whose sex is female.",
+          "type": "number",
+          "min": 0
         }
       }
     },
-    "denominator":{
-      "title":"Denominator",
-      "description":"Denominator",
-      "type":"object",
-      "properties":{
-        "code":{
-          "title":"nTPART",
-          "description":"The code for this indicator is nTPART",
-          "type":"string",
-          "enum":["nTPART"]
+    "denominator": {
+      "title": "Denominator",
+      "description": "Denominator",
+      "type": "object",
+      "properties": {
+        "code": {
+          "title": "nTPART",
+          "description": "The code for this indicator is nTPART",
+          "type": "string",
+          "enum": [
+            "nTPART"
+          ]
         },
-        "value":{
-          "title":"Training: total participants",
-          "description":"Total number of people participating in training.",
-          "type":"number",
-          "min":0
+        "value": {
+          "title": "Training: total participants",
+          "description": "Total number of people participating in training.",
+          "type": "number",
+          "min": 0
         }
       }
     },
@@ -172,7 +176,10 @@
           }
         }
       },
-      "required":["periodStart","periodEnd"]
+      "required": [
+        "periodStart",
+        "periodEnd"
+      ]
     },
     "attributes": {
       "type": "object",
@@ -197,5 +204,41 @@
       }
     }
   },
-  "required":["code","value"]
+  "required": [
+    "code",
+    "value"
+  ],
+  "example": {
+    "metrics": [
+      {
+        "code": "pcWCT",
+        "value": 0.3,
+        "numerator": {
+          "code": "nPWT",
+          "value": 3
+        },
+        "denominator": {
+          "code": "nTPART",
+          "value": 10
+        },
+        "dimensions": {
+          "periodStartDate": "2017-01-01",
+          "periodEndDate": "2018-01-01",
+          "geographicCoverage": {
+            "description": "United Kingdom",
+            "gazeteer": {
+              "scheme": "geonames",
+              "identifiers": [
+                "2635167"
+              ]
+            }
+          }
+        },
+        "attributes": {
+          "source": "Survey",
+          "sourceType": "estimate"
+        }
+      }
+    ]
+  }
 }