68 |
69 |
70 |
--------------------------------------------------------------------------------
/datacontract.init.yaml:
--------------------------------------------------------------------------------
1 | dataContractSpecification: 1.1.0
2 | id: my-data-contract-id
3 | info:
4 | title: My Data Contract
5 | version: 0.0.1
6 | # description:
7 | # owner:
8 | # contact:
9 | # name:
10 | # url:
11 | # email:
12 |
13 |
14 | ### servers
15 |
16 | #servers:
17 | # production:
18 | # type: s3
19 | # location: s3://
20 | # format: parquet
21 | # delimiter: new_line
22 |
23 | ### terms
24 |
25 | #terms:
26 | # usage:
27 | # limitations:
28 | # billing:
29 | # noticePeriod:
30 |
31 |
32 | ### models
33 |
34 | # models:
35 | # my_model:
36 | # description:
37 | # type:
38 | # fields:
39 | # my_field:
40 | # type:
41 | # description:
42 |
43 |
44 | ### definitions
45 |
46 | # definitions:
47 | # my_field:
48 | # domain:
49 | # name:
50 | # title:
51 | # type:
52 | # description:
53 | # example:
54 | # pii:
55 | # classification:
56 |
57 |
58 | ### servicelevels
59 |
60 | #servicelevels:
61 | # availability:
62 | # description: The server is available during support hours
63 | # percentage: 99.9%
64 | # retention:
65 | # description: Data is retained for one year because!
66 | # period: P1Y
67 | # unlimited: false
68 | # latency:
69 | # description: Data is available within 25 hours after the order was placed
70 | # threshold: 25h
71 | # sourceTimestampField: orders.order_timestamp
72 | # processedTimestampField: orders.processed_timestamp
73 | # freshness:
74 | # description: The age of the youngest row in a table.
75 | # threshold: 25h
76 | # timestampField: orders.order_timestamp
77 | # frequency:
78 | # description: Data is delivered once a day
79 | # type: batch # or streaming
80 | # interval: daily # for batch, either or cron
81 | # cron: 0 0 * * * # for batch, either or interval
82 | # support:
83 | # description: The data is available during typical business hours at headquarters
84 | # time: 9am to 5pm in EST on business days
85 | # responseTime: 1h
86 | # backup:
87 | # description: Data is backed up once a week, every Sunday at 0:00 UTC.
88 | # interval: weekly
89 | # cron: 0 0 * * 0
90 | # recoveryTime: 24 hours
91 | # recoveryPoint: 1 week
92 |
--------------------------------------------------------------------------------
/definition.schema.json:
--------------------------------------------------------------------------------
1 | {
2 | "$schema": "http://json-schema.org/draft-07/schema#",
3 | "type": "object",
4 | "description": "Clear and concise explanations of syntax, semantic, and classification of business objects in a given domain.",
5 | "properties": {
6 | "id": {
7 | "type": "string",
8 | "description": "A unique identifier for this definition. Encode the domain into the ID, separated by slashes.",
9 | "examples": [
10 | "checkout/order_id"
11 | ]
12 | },
13 | "title": {
14 | "type": "string",
15 | "description": "The business name of this definition."
16 | },
17 | "description": {
18 | "type": "string",
19 | "description": "Clear and concise explanations related to the domain."
20 | },
21 | "type": {
22 | "type": "string",
23 | "description": "The logical data type."
24 | },
25 | "minLength": {
26 | "type": "integer",
27 | "description": "A value must be greater than or equal to this value. Applies only to string types."
28 | },
29 | "maxLength": {
30 | "type": "integer",
31 | "description": "A value must be less than or equal to this value. Applies only to string types."
32 | },
33 | "format": {
34 | "type": "string",
35 | "description": "Specific format requirements for the value (e.g., 'email', 'uri', 'uuid')."
36 | },
37 | "precision": {
38 | "type": "integer",
39 | "examples": [
40 | 38
41 | ],
42 | "description": "The maximum number of digits in a number. Only applies to numeric values. Defaults to 38."
43 | },
44 | "scale": {
45 | "type": "integer",
46 | "examples": [
47 | 0
48 | ],
49 | "description": "The maximum number of decimal places in a number. Only applies to numeric values. Defaults to 0."
50 | },
51 | "pattern": {
52 | "type": "string",
53 | "description": "A regular expression pattern the value must match. Applies only to string types."
54 | },
55 | "example": {
56 | "type": "string",
57 | "description": "An example value for this field.",
58 | "deprecationMessage": "Use the examples field instead."
59 | },
60 | "examples": {
61 | "type": "array",
62 | "description": "A examples value for this field."
63 | },
64 | "pii": {
65 | "type": "boolean",
66 | "description": "Indicates if the field contains Personal Identifiable Information (PII)."
67 | },
68 | "classification": {
69 | "type": "string",
70 | "description": "The data class defining the sensitivity level for this field."
71 | },
72 | "tags": {
73 | "type": "array",
74 | "items": {
75 | "type": "string"
76 | },
77 | "description": "Custom metadata to provide additional context."
78 | },
79 | "links": {
80 | "type": "object",
81 | "description": "Links to external resources.",
82 | "minProperties": 1,
83 | "propertyNames": {
84 | "pattern": "^[a-zA-Z0-9_-]+$"
85 | },
86 | "additionalProperties": {
87 | "type": "string",
88 | "title": "Link",
89 | "description": "A URL to an external resource.",
90 | "format": "uri",
91 | "examples": [
92 | "https://example.com"
93 | ]
94 | }
95 | }
96 | },
97 | "required": [
98 | "type"
99 | ]
100 | }
101 |
--------------------------------------------------------------------------------
/diagrams/favicon.drawio:
--------------------------------------------------------------------------------
1 |