turbot-runner 0.1.23 → 0.1.24

data/schema/schemas/includes/company-for-nesting.json

@@ -1,7 +1,7 @@
 {
-  "title": "Company Schema",
-  "type": "object",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "A company in OpenCorporates",
+  "type": "object",
   "properties": {
     "company_number": {
       "type": "string",
@@ -20,13 +20,16 @@
       "maxLength": 5
     },
     "incorporation_date": {
-      "type": "date"
+      "type": "string",
+      "format": "date"
     },
     "dissolution_date": {
-      "type": "date"
+      "type": "string",
+      "format": "date"
     },
     "retrieved_at": {
-      "type": "date-time"
+      "type": "string",
+      "format": "date-time"
     },
     "current_status": {
       "type": "string"
@@ -98,43 +101,71 @@
       }
     },
     "branch": {
-      "type": ["string","null"],
+      "type": [
+        "string",
+        "null"
+      ],
       "description": "A flag to denote whether a company is a branch entity. This should only be set if the company is a type of branch (otherwise should be null). In general the only option here is 'F' for a 'Foreign' branch, i.e. an out-of-jurisdiction entity that has registered as having a presence in the jurisdiction. In the US this is sometimes called a Foreign Corporation",
-      "enum": ["F", "L",null]
+      "enum": [
+        "F",
+        "L",
+        null
+      ]
     },
     "all_attributes": {
       "type": "object",
       "description": "Other arbitrary attributes for a given company",
       "properties": {
         "jurisdiction_of_origin": {
-          "type": ["string","null"],
+          "type": [
+            "string",
+            "null"
+          ],
           "description": "The jurisdiction of the 'home' company if this is a branch",
           "minLength": 1
         },
         "home_company_number": {
-          "type": ["string","null"],
+          "type": [
+            "string",
+            "null"
+          ],
           "description": "If the entity is a 'branch', this is the company_number of the 'home' company in the home company's jurisdiction",
           "minLength": 1
         },
         "home_legal_name": {
-          "type": ["string","null"],
+          "type": [
+            "string",
+            "null"
+          ],
           "description": "The legal name of the 'home' company in its jurisdiction if this is a branch, and the name is different from the legal name of the branch",
           "minLength": 1
         },
         "registered_agent_address": {
-          "type": ["string","null"],
+          "type": [
+            "string",
+            "null"
+          ],
           "description": "The address of the 'Agent', a public address to which legal papers can be served",
           "minLength": 1
         },
         "registered_agent_name": {
-          "type": ["string","null"],
-          "description": "The 'Agent' of the company \u2013 a person or entity that is empowered to accept service for the company",
+          "type": [
+            "string",
+            "null"
+          ],
+          "description": "The 'Agent' of the company – a person or entity that is empowered to accept service for the company",
           "minLength": 1
         },
         "number_of_employees": {
           "anyOf": [
-            {"type":"string","minLength": 1},
-            {"type":"number","minimum": 0}
+            {
+              "type": "string",
+              "minLength": 1
+            },
+            {
+              "type": "number",
+              "minimum": 0
+            }
           ],
           "description": "The number of employees"
         },
@@ -143,7 +174,9 @@
           "description": "Information on the merger of this company into a 'survivor' company",
           "properties": {
             "surviving_company": {
-              "type": ["object"],
+              "type": [
+                "object"
+              ],
               "description": "the surviving_company that this has been merged into",
               "properties": {
                 "name": {
@@ -162,21 +195,35 @@
                   "minLength": 2
                 }
               },
-              "anyOf": [{"required": ["name"]},
-                        {"required": ["company_number"]}]
+              "anyOf": [
+                {
+                  "required": [
+                    "name"
+                  ]
+                },
+                {
+                  "required": [
+                    "company_number"
+                  ]
+                }
+              ]
             },
             "effective_date": {
+              "description": "The date of the merger",
               "type": "string",
-              "format": "date",
-              "description": "The date of the merger"
+              "format": "date"
             }
           },
           "additionalProperties": false,
-          "required": ["surviving_company"]
+          "required": [
+            "surviving_company"
+          ]
         }
       }
     }
   },
   "additionalProperties": false,
-  "required": ["name"]
-}
+  "required": [
+    "name"
+  ]
+}

data/schema/schemas/includes/company.json

@@ -1,16 +1,25 @@
 {
-  "name": "Company",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "A company which is the subject of a statement",
   "type": "object",
   "properties": {
-    "name": { "type": "string" },
-    "jurisdiction": { "type": "string" },
-    "company_number": { "type": "string" },
+    "name": {
+      "type": "string"
+    },
+    "jurisdiction": {
+      "type": "string"
+    },
+    "company_number": {
+      "type": "string"
+    },
     "identifier": {
       "type": "string",
       "description": "An official identifier paired with a code for the issuer of the identifier, e.g sec/12345",
       "pattern": "^[^/]+/[^/]+$"
     }
   },
-  "required": [ "name", "jurisdiction" ]
-}
+  "required": [
+    "name",
+    "jurisdiction"
+  ]
+}

data/schema/schemas/includes/filing.json

@@ -1,20 +1,52 @@
 {
-  "name": "Filing",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "A statutory filing",
   "type": "object",
-  "properties": { "title": { "type": "string" },
-                  "date": {"type":"string","format": "date"},
-                  "description":   { "type": "string" },
-                  "uid":   { "type": "string" },
-                  "url":   { "type": "string" },
-                  "filing_type_code":   { "type": "string" },
-                  "filing_type_name":   { "type": "string" },
-                  "other_attributes": { "type": "object" }
+  "properties": {
+    "title": {
+      "type": "string"
+    },
+    "date": {
+      "type": "string",
+      "format": "date"
+    },
+    "description": {
+      "type": "string"
+    },
+    "uid": {
+      "type": "string"
+    },
+    "url": {
+      "type": "string"
+    },
+    "filing_type_code": {
+      "type": "string"
+    },
+    "filing_type_name": {
+      "type": "string"
+    },
+    "other_attributes": {
+      "type": "object"
+    }
   },
-  "required": [ "date" ],
-  "anyOf": [ { "required": ["title"] },
-             { "required": ["description"] },
-             { "required": ["filing_type_name"] }
-           ]
-}
-
+  "required": [
+    "date"
+  ],
+  "anyOf": [
+    {
+      "required": [
+        "title"
+      ]
+    },
+    {
+      "required": [
+        "description"
+      ]
+    },
+    {
+      "required": [
+        "filing_type_name"
+      ]
+    }
+  ]
+}

data/schema/schemas/includes/financial-payment-data-object.json

@@ -1,60 +1,112 @@
 {
-  "name": "Financial Payment Datum",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "type": "object",
   "properties": {
-    "data_type": { "enum": [ "financial_payment" ] },
+    "data_type": {
+      "enum": [
+        "financial_payment"
+      ]
+    },
     "source_url": {
-      "type": "string"},
+      "type": "string"
+    },
     "confidence": {
-      "type": "string"},
+      "type": "string"
+    },
     "properties": {
       "type": "object",
       "properties": {
         "value": {
           "description": "The amount transacted (e.g. 19.95)",
-          "type": "string"},
+          "type": "string"
+        },
         "payee_name": {
           "description": "The name of the payee (the entity that received the money)",
-          "type": "string"},
+          "type": "string"
+        },
         "currency": {
           "description": "The currency of the payment (three letter symbol, e.g. USD, GBP, EUR)",
-          "type": "string"},
+          "type": "string"
+        },
         "date": {
           "description": "The date on which the payment was made",
-          "type": "date"},
+          "type": "date"
+        },
         "transaction_number": {
           "description": "The unique identifier for the transaction, scoped to this bot",
-          "type": "string"},
+          "type": "string"
+        },
         "jurisdiction": {
           "description": "The jurisdiction of the body that made the payment, eg. UK, France, Delaware, Manchester",
-          "type": "string"},
+          "type": "string"
+        },
         "more_details_url": {
           "description": "A url from which more details can be seen (may be the same as the source_url)",
-          "type": ["string",null]},
+          "type": [
+            "string",
+            null
+          ]
+        },
         "description": {
           "description": "The description of the transaction as given in the raw data",
-          "type": ["string",null]},
+          "type": [
+            "string",
+            null
+          ]
+        },
         "expense_type": {
           "description": "The type of expense -- can be either capital, revenue (i.e. current expenditure) or null",
-          "enum": ["capital","revenue",null]},
+          "enum": [
+            "capital",
+            "revenue",
+            null
+          ]
+        },
         "expense_area": {
           "description": "category (in words) of the expenditure",
-          "type": ["string",null]},
+          "type": [
+            "string",
+            null
+          ]
+        },
         "entity_name": {
           "description": "The name of the government entity that made the payment, e.g. Environment Agency",
-          "type": "string"},
+          "type": "string"
+        },
         "entity_uri": {
           "description": "A unique URL (ideally a dereferencable URI) for the government entity",
-          "type": ["string",null]},
+          "type": [
+            "string",
+            null
+          ]
+        },
         "department_name": {
           "description": "The name of the government department which the entity belongs to (if relevant), e.g. Department of Health",
-          "type": ["string",null]},
+          "type": [
+            "string",
+            null
+          ]
+        },
         "csv_line_number": {
           "description": "If the source for the data is a CSV file, you can optionally include the line number of the CSV from which this data was retrieved",
-          "type": ["string",null]}
+          "type": [
+            "string",
+            null
+          ]
+        }
       },
-      "required": [ "value", "payee_name", "date","currency" ]
+      "required": [
+        "value",
+        "payee_name",
+        "date",
+        "currency"
+      ]
     }
   },
-  "required": [ "data_type", "properties","source_url","confidence" ]
-}
+  "required": [
+    "data_type",
+    "properties",
+    "source_url",
+    "confidence"
+  ]
+}

data/schema/schemas/includes/identifier.json

@@ -1,12 +1,18 @@
 {
-  "name": "Identifier",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "An identifier for an entity (possibly other things, e.g. securities in the future). Examples are tax IDs, non-profit IDs, SEC CIK numbers, Federal Reserve RSSD id. The main requirements for an identifier is that they should be well-defined, and issued by a government or have statutory standing",
   "type": "object",
-  "properties": { "code": { "type": "string" },
-                  "code_scheme_id": {
-                    "type": "string",
-                    "description": "An identifier representing the identifier scheme. Some examples of this are us_fein (US Federal tax number), us_sec_cik (US Securities and Exchange Commission CIK), gb_ccew (Charity Commission of England & Wales), lei (Global Legal Entity Identifier Schems)"
-                   }
+  "properties": {
+    "uid": {
+      "type": "string"
+    },
+    "identifier_system_code": {
+      "type": "string",
+      "description": "An identifier representing the identifier scheme. Some examples of this are us_fein (US Federal tax number), us_sec_cik (US Securities and Exchange Commission CIK), gb_ccew (Charity Commission of England & Wales), lei (Global Legal Entity Identifier Schems)"
+    }
   },
-  "required": [ "code", "code_scheme_id" ]
-}
+  "required": [
+    "code",
+    "code_scheme_id"
+  ]
+}

data/schema/schemas/includes/industry_code.json

@@ -1,16 +1,29 @@
 {
-  "name": "IndustryCode",
+  "$schema": "http://json-schema.org/draft-04/schema#",
   "description": "An industry code from a standard code list (e.g. NAICS 2007 or NACE 2)",
   "type": "object",
-  "properties": { "name": { "type": "string" },
-                  "code": { "type": "string" },
-                  "code_scheme_id": {
-                    "type": "string",
-                    "description": "An identifier representing industry code scheme. At the moment these are eu_nace_2, uk_sic_2003, uk_sic_2007, us_naics_2002, us_naics_2007, be_nace_2008, dk_db_2007, nz_bic_2006, no_sic_2007, anz_sic_2006, nz_bic_2006, in_nic_2004_mca, ca_qc_cae, lu_nace_2. For other code schemes, or details of these, contact info@opencorporates.com"
-                   },
-                  "start_date":  {"type":"string","format": "date"},
-                  "end_date":  {"type":"string","format": "date"}
+  "properties": {
+    "name": {
+      "type": "string"
+    },
+    "code": {
+      "type": "string"
+    },
+    "code_scheme_id": {
+      "type": "string",
+      "description": "An identifier representing industry code scheme. At the moment these are eu_nace_2, uk_sic_2003, uk_sic_2007, us_naics_2002, us_naics_2007, be_nace_2008, dk_db_2007, nz_bic_2006, no_sic_2007, anz_sic_2006, nz_bic_2006, in_nic_2004_mca, ca_qc_cae, lu_nace_2. For other code schemes, or details of these, contact info@opencorporates.com"
+    },
+    "start_date": {
+      "type": "string",
+      "format": "date"
+    },
+    "end_date": {
+      "type": "string",
+      "format": "date"
+    }
   },
-  "required": [ "code", "code_scheme_id" ]
-}
-
+  "required": [
+    "code",
+    "code_scheme_id"
+  ]
+}