turbot-runner 0.1.23 → 0.1.24

data/schema/schemas/includes/share-parcel.json

@@ -1,63 +1,78 @@
 {
-  "name": "Share Parcel",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "description": "A parcel of shares in a company",
-    "required": ["shareholders"],
-    "properties": {
-      "number_of_shares": {
-        "description": "Number of shares, if known",
-        "type": "integer"},
-      "percentage_of_shares": {
-        "description": "Percentage of shares, if known",
-        "type": "number",
-        "maximum": 100,
-        "minimum": 0
-      },
-      "start_date": {"type":"string","format": "date"},
-      "end_date": {"type":"string","format": "date"},
-      "sample_date": {"type":"string","format": "date"},
-      "shareholders": {
-        "description": "Legal persons who own this share parcel",
-        "type": "array",
-        "minItems": 1,
-        "items": {
-          "type": "object",
-          "name": "shareholder",
-          "required": ["name"],
-          "properties": {
-            "name": {
-              "description": "Name of natural person or company",
-              "type": "string",
-              "minLength": 1
-            },
-            "jurisdiction": {
-              "description": "Jurisdiction of registration, if company",
-              "type": "string"
-            },
-            "company_number": {
-              "description": "Company number, if company and known",
-              "type": "string"
-            },
-            "identifier": {
-              "description": "Unique identifier of person",
-              "type": "string"
-            },
-            "type": {
-              "description": "Type of person if known (company or natural person)",
-              "enum" : ["Company", "Person"]
-            },
-            "address": {
-              "description": "Address given for owner of parcel",
-              "type": "string"
-            },
-            "address_country": {
-              "description": "Country part of owner's address",
-              "type": "string"
-            }
+  "required": [
 
+  ],
+  "properties": {
+    "number_of_shares": {
+      "description": "Number of shares, if known",
+      "type": "integer"
+    },
+    "percentage_of_shares": {
+      "description": "Percentage of shares, if known",
+      "type": "number",
+      "maximum": 100,
+      "minimum": 0
+    },
+    "start_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "sample_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "shareholders": {
+      "description": "Legal persons who own this share parcel",
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "type": "object",
+        "name": "shareholder",
+        "required": [
+          "name"
+        ],
+        "properties": {
+          "name": {
+            "description": "Name of natural person or company",
+            "type": "string",
+            "minLength": 1
+          },
+          "jurisdiction": {
+            "description": "Jurisdiction of registration, if company",
+            "type": "string"
+          },
+          "company_number": {
+            "description": "Company number, if company and known",
+            "type": "string"
+          },
+          "identifier": {
+            "description": "Unique identifier of person",
+            "type": "string"
+          },
+          "type": {
+            "description": "Type of person if known (company or natural person)",
+            "enum": [
+              "Company",
+              "Person"
+            ]
+          },
+          "address": {
+            "description": "Address given for owner of parcel",
+            "type": "string"
+          },
+          "address_country": {
+            "description": "Country part of owner's address",
+            "type": "string"
           }
         }
+      }
     }
-  },
-  "required": [ ]
-}
+  }
+}

data/schema/schemas/includes/subsidiary-relationship-data.json

@@ -1,26 +1,37 @@
 {
-  "name": "Share Parcel Data",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
-    "data_type": { "enum": [ "subsidiary_relationship" ] },
+    "data_type": {
+      "enum": [
+        "subsidiary_relationship"
+      ]
+    },
     "properties": {
       "type": "object",
-      "required": ["subsidiary"],
+      "required": [
+        "subsidiary"
+      ],
       "additionalProperties": false,
       "properties": {
         "direct": {
           "description": "If the control is direct (if via an intermediary, this value should be false; if unknown, left blank)",
-          "type": "boolean"},
+          "type": "boolean"
+        },
         "percentage_controlled": {
           "description": "Percentage controlled, either directly or indirectly",
-          "type": "string"},
+          "type": "string"
+        },
         "significant": {
           "description": "Does the source define the control as somehow significant?",
-          "type": "boolean"},
+          "type": "boolean"
+        },
         "subsidiary": {
           "description": "Company that is controlled",
           "type": "object",
-          "required": ["name"],
+          "required": [
+            "name"
+          ],
           "additionalProperties": false,
           "properties": {
             "name": {
@@ -44,4 +55,4 @@
       }
     }
   }
-}
+}

data/schema/schemas/includes/total-shares.json

@@ -1,10 +1,17 @@
 {
-  "name": "TotalShares",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "The total number of shares a company has issued",
   "type": "object",
-  "properties": { "number": { "type": "integer" },
-                  "share_class": { "type": "string", "minLength": 1 }
+  "properties": {
+    "number": {
+      "type": "integer"
+    },
+    "share_class": {
+      "type": "string",
+      "minLength": 1
+    }
   },
-  "required": [ "number" ]
-}
-
+  "required": [
+    "number"
+  ]
+}

data/schema/schemas/includes/unknown_entity_type.json

@@ -1,7 +1,7 @@
 {
-  "title": "UnknownEntityType",
-  "type": "object",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "An entity of unknown type - potentially a company, a person, government entity, or some unincorporated organisation",
+  "type": "object",
   "properties": {
     "name": {
       "type": "string",
@@ -52,6 +52,7 @@
       }
     }
   },
-  "required": ["name"]
-}
-
+  "required": [
+    "name"
+  ]
+}

data/schema/schemas/licence-schema.json

@@ -1,27 +1,167 @@
 {
-  "title": "Licence Schema",
-  "description": "A Licence is a permission for an entity to do something that would otherwise not be permitted. An example is a 'Financial' licence to operate as a bank, or an financial advisor, for example, or a 'Business' Licence to sell alcohol, or operate an amusement arcade. Future licence types (extractives, pollution) will be added later",
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
+  "description": "A Licence is a permission for an entity to do something that would otherwise not be permitted. Note that such permissions are recorded in multiple different ways and to different granularity. In addition categories cross over, for example a pawnborker may be regulated as a retail establishment by a city, but also as a financial institution by a national or regional financial regulator. Sometimes the licence is a simple statement – the government of Rwanda has given a banking licence to a certain bank -- other times it is fine-grained and highly complex (e.g. an extractives licence or the UK FCA licencing scheme). This schema tries to make it easy to submit the former, while not losing granularity of the latter. The object has the name of Rich Licence to distinguish it from Simple Licence, which it is expected to ultimately replace.",
   "properties": {
-    "sample_date": {"type": "string", "format": "date"},
-    "start_date": {"type": "string", "format": "date"},
-    "end_date": {"type": "string", "format": "date"},
-    "source_jurisdiction": {
-      "description": "Jurisdiction of the source of the data",
+    "licence_holder": {
+      "properties": {
+        "entity": {
+          "oneOf": [
+            {
+              "properties": {
+                "entity_type": {
+                  "enum": [
+                    "company"
+                  ]
+                },
+                "entity_properties": {
+                  "$ref": "includes/company-for-nesting.json"
+                }
+              }
+            },
+            {
+              "properties": {
+                "entity_type": {
+                  "enum": [
+                    "person"
+                  ]
+                },
+                "entity_properties": {
+                  "$ref": "includes/person.json"
+                }
+              }
+            },
+            {
+              "properties": {
+                "entity_type": {
+                  "enum": [
+                    "organisation"
+                  ]
+                },
+                "entity_properties": {
+                  "$ref": "includes/organisation.json"
+                }
+              }
+            },
+            {
+              "properties": {
+                "entity_type": {
+                  "enum": [
+                    "unknown"
+                  ]
+                },
+                "entity_properties": {
+                  "$ref": "includes/unknown_entity_type.json"
+                }
+              }
+            }
+          ]
+        },
+        "entity_type": {
+          "enum": [
+            "company",
+            "person",
+            "organisation",
+            "unknown_entity_type",
+            null
+          ]
+        }
+      }
+    },
+    "licence_issuer": {
+      "oneOf": [
+        {
+          "type": [
+            "string",
+            "null"
+          ],
+          "minLength": 2
+        },
+        {
+          "$ref": "includes/organisation.json"
+        }
+      ]
+    },
+    "licenced_location": {
+      "$ref": "includes/address.json"
+    },
+    "licence_number": {
       "type": "string"
     },
-    "company": {
-      "$ref": "includes/company.json"
+    "start_date": {
+      "description": "The issue date of the licence",
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "description": "The expiry date of the licence",
+      "type": "string",
+      "format": "date"
+    },
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string",
+      "minLength": 1
+    },
+    "confidence": {
+      "description": "Confidence in accuracy of data",
+      "type": "string",
+      "enum": [
+        "HIGH",
+        "MEDIUM",
+        "LOW"
+      ]
+    },
+    "renewal_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "sample_date": {
+      "description": "Date on which we know this to be true (usually date this information was retrieved from the source)",
+      "type": "string",
+      "format": "date"
     },
-    "data": {
+    "licence_url": {
+      "type": "string",
+      "description": "A public URL for the licence"
+    },
+    "jurisdiction_of_licence": {
+      "type": "string",
+      "description": "The area in which this licence is valid"
+    },
+    "status": {
+      "type": "string",
+      "description": "The status of the licence. If the licence is made up of a number of permissions, each of which has a status, store the status in the permissions field instead/as well"
+    },
+    "category": {
+      "description": "Category of licence",
       "type": "array",
-      "description": "This is an array of data objects, that is the objects which actually contain the data about the datum. Generally there will only be one element in this, although in for some types of data_types there may naturally be several releated to the same company, e.g. shareholders",
       "items": {
-        "$ref": "includes/licence-data-object.json"
-      },
-      "additionalItems": false
+        "type": "string",
+        "enum": [
+          "Financial",
+          "Business",
+          "Extractive"
+        ]
+      }
+    },
+    "permissions": {
+      "type": "array",
+      "items": {
+        "$ref": "includes/permission.json"
+      }
+    },
+    "other_attributes": {
+      "description": "Use for other licence attributes for which we don't yet have curated schema attributes",
+      "type": "object"
     }
   },
-  "required": ["company", "data", "sample_date"]
-}
+  "additionalProperties": false,
+  "required": [
+    "source_url",
+    "sample_date",
+    "licence_holder",
+    "permissions",
+    "licence_issuer",
+    "jurisdiction_of_licence"
+  ]
+}

data/schema/schemas/primary-data-schema.json

@@ -1,18 +1,20 @@
 {
-    "$schema": "http://json-schema.org/draft-04/schema#",
-    "title": "Primary Data Schema",
-    "type": "object",
-    "properties": {
-        "source_url": {
-            "description": "Place where this fact can be verified",
-            "type": "string"
-        },
-        "sample_date": {
-            "description": "Date on which this fact was known to be true",
-            "type": "string",
-            "format": "date"
-        }
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type": "object",
+  "properties": {
+    "source_url": {
+      "description": "Place where this fact can be verified",
+      "type": "string"
     },
-    "required": ["source_url", "sample_date"],
-    "additionalProperties": true
-}
+    "sample_date": {
+      "description": "Date on which this fact was known to be true",
+      "type": "string",
+      "format": "date"
+    }
+  },
+  "required": [
+    "source_url",
+    "sample_date"
+  ],
+  "additionalProperties": true
+}