gobl 0.24.1 → 0.24.3

data/data/schemas/cbc/definition.json

@@ -0,0 +1,67 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cbc/definition",
+  "$ref": "#/$defs/Definition",
+  "$defs": {
+    "Definition": {
+      "properties": {
+        "key": {
+          "$ref": "https://gobl.org/draft-0/cbc/key",
+          "title": "Key",
+          "description": "Key being defined."
+        },
+        "code": {
+          "$ref": "https://gobl.org/draft-0/cbc/code",
+          "title": "Code",
+          "description": "Code this definition represents."
+        },
+        "name": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Name",
+          "description": "Short name for the key."
+        },
+        "desc": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Description",
+          "description": "Description offering more details about when the key should be used."
+        },
+        "meta": {
+          "$ref": "https://gobl.org/draft-0/cbc/meta",
+          "title": "Meta",
+          "description": "Meta defines any additional details that may be useful or associated\nwith the key."
+        },
+        "sources": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/source"
+          },
+          "type": "array",
+          "title": "Sources",
+          "description": "Where the information was sourced from."
+        },
+        "values": {
+          "items": {
+            "$ref": "https://gobl.org/draft-0/cbc/definition"
+          },
+          "type": "array",
+          "title": "Values",
+          "description": "Values defines the possible values associated with the key, which themselves will\neither be keys or codes depending on the context."
+        },
+        "pattern": {
+          "type": "string",
+          "title": "Pattern",
+          "description": "Pattern is used to validate the key value instead of using a fixed value\nfrom the code or key definitions."
+        },
+        "map": {
+          "$ref": "https://gobl.org/draft-0/cbc/code-map",
+          "title": "Code Map",
+          "description": "Map helps map local keys to specific codes, useful for converting the\ndescribed key into a local code."
+        }
+      },
+      "type": "object",
+      "required": [
+        "name"
+      ],
+      "description": "Definition defines properties of a key, code, or other value that has a specific meaning or utility."
+    }
+  }
+}

data/data/schemas/cbc/key.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cbc/key",
+  "$ref": "#/$defs/Key",
+  "$defs": {
+    "Key": {
+      "type": "string",
+      "maxLength": 64,
+      "minLength": 1,
+      "pattern": "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$",
+      "title": "Key",
+      "description": "Text identifier to be used instead of a code for a more verbose but readable identifier."
+    }
+  }
+}

data/data/schemas/cbc/meta.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cbc/meta",
+  "$ref": "#/$defs/Meta",
+  "$defs": {
+    "Meta": {
+      "patternProperties": {
+        "^(?:[a-z]|[a-z0-9][a-z0-9-+]*[a-z0-9])$": {
+          "type": "string"
+        }
+      },
+      "type": "object",
+      "description": "Meta defines a structure for data about the data being defined."
+    }
+  }
+}

data/data/schemas/cbc/source.json

@@ -0,0 +1,37 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/cbc/source",
+  "$ref": "#/$defs/Source",
+  "$defs": {
+    "Source": {
+      "properties": {
+        "title": {
+          "$ref": "https://gobl.org/draft-0/i18n/string",
+          "title": "Title",
+          "description": "Title stores the name of the source of information."
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "title": "URL",
+          "description": "URL is the location of the source of information."
+        },
+        "content_type": {
+          "type": "string",
+          "title": "Content Type",
+          "description": "ContentType of the information expected at the URL."
+        },
+        "at": {
+          "$ref": "https://gobl.org/draft-0/cal/date-time",
+          "title": "At",
+          "description": "At is the date and time the information was retrieved."
+        }
+      },
+      "type": "object",
+      "required": [
+        "url"
+      ],
+      "description": "Source is used to identify a specific source of data."
+    }
+  }
+}

data/data/schemas/currency/amount.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://gobl.org/draft-0/currency/amount",
+  "$ref": "#/$defs/Amount",
+  "$defs": {
+    "Amount": {
+      "properties": {
+        "label": {
+          "type": "string",
+          "title": "Label",
+          "description": "Label allows for additional information to be added to the\ncurrency Amount that may be useful."
+        },
+        "currency": {
+          "$ref": "https://gobl.org/draft-0/currency/code",
+          "title": "Currency",
+          "description": "Code defines the currency for this amount."
+        },
+        "value": {
+          "$ref": "https://gobl.org/draft-0/num/amount",
+          "title": "Value",
+          "description": "Value is the amount in the currency."
+        }
+      },
+      "type": "object",
+      "required": [
+        "currency",
+        "value"
+      ],
+      "description": "An Amount represents a monetary value in a specific currency."
+    }
+  }
+}