Skip to content

Commit 2b9281a

Browse files
dccakesdccakes
authored
Merge pull request #158 from bitol-io/rfc-24
2 parents e793daa + c7f920c commit 2b9281a

File tree

3 files changed

+24
-12
lines changed

3 files changed

+24
-12
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,8 @@ This document tracks the history and evolution of the **Open Data Contract Stand
5757
* Added HiveServer with type `hive`
5858
* **Deprecations**:
5959
* `slaDefaultElement` is deprecated, and will be removed in ODCS 4.0 (see RFC 21)
60-
60+
* **Changes** to custom properties and authoritative definitions:
61+
* Add `description` field to both `customProperties` and `authoritativeDefinitions`.
6162

6263
# v3.0.2 - 2024-03-31 - APPROVED
6364

‎docs/README.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -352,11 +352,12 @@ schema:
352352
### Authoritative definitions
353353
Reference to an external definition on element logic or values.
354354

355-
| Key | UX label | Required | Description |
356-
|-------------------------------|-------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
357-
| authoritativeDefinitions | Link | No | A list of type/link pairs for authoritative definitions. |
358-
| authoritativeDefinitions.type | Definition type | Yes | Type of definition for authority. Valid values are: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`. |
359-
| authoritativeDefinitions.url | URL to definition | Yes | URL to the authority. |
355+
| Key | UX label | Required | Description |
356+
|--------------------------------------|-------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
357+
| authoritativeDefinitions | Link | No | A list of type/link pairs for authoritative definitions. |
358+
| authoritativeDefinitions.type | Definition type | Yes | Type of definition for authority. Valid values are: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`. |
359+
| authoritativeDefinitions.url | URL to definition | Yes | URL to the authority. |
360+
| authoritativeDefinitions.description | Description | No | Description for humans |
360361

361362
## References
362363
This section describes how to reference elements within a data contract schema. References enable you to create relationships between different parts of your data contract.
@@ -1531,17 +1532,19 @@ customProperties:
15311532
value: gcsc.ruleset.name
15321533
- property: somePropertyName
15331534
value: property.value
1534-
- property: dataprocClusterName # Used for specific applications like Elevate
1535+
- property: dataprocClusterName # Used for specific applications
15351536
value: [cluster name]
1537+
description: Cluster name for specific applications
15361538
```
15371539

15381540
### Definitions
15391541

1540-
| Key | UX label | Required | Description |
1541-
|---------------------------|----------------------|----------|-------------------------------------------------------------------------------------------------------------------|
1542-
| customProperties | Custom Properties | No | A list of key/value pairs for custom properties. Initially created to support the REF ruleset property. |
1543-
| customProperties.property | Property | No | The name of the key. Names should be in camel case–the same as if they were permanent properties in the contract. |
1544-
| customProperties.value | Value | No | The value of the key. |
1542+
| Key | UX label | Required | Description |
1543+
|------------------------------|-------------------|----------|-------------------------------------------------------------------------------------------------------------------|
1544+
| customProperties | Custom Properties | No | A list of key/value pairs for custom properties. Initially created to support the REF ruleset property. |
1545+
| customProperties.property | Property | No | The name of the key. Names should be in camel case–the same as if they were permanent properties in the contract. |
1546+
| customProperties.value | Value | No | The value of the key. |
1547+
| customProperties.description | Description | No | Description for humans. |
15451548

15461549

15471550
## Other Properties

‎schema/odcs-json-schema-v3.1.0.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2322,6 +2322,10 @@
23222322
"type": "string",
23232323
"description": "Type of definition for authority: v2.3 adds standard values: `businessDefinition`, `transformationImplementation`, `videoTutorial`, `tutorial`, and `implementation`.",
23242324
"examples": ["businessDefinition", "transformationImplementation", "videoTutorial", "tutorial", "implementation"]
2325+
},
2326+
"description": {
2327+
"type": "string",
2328+
"description": "Description of the authoritative definition for humans."
23252329
}
23262330
},
23272331
"required": ["url", "type"],
@@ -2532,6 +2536,10 @@
25322536
"value": {
25332537
"$ref": "#/$defs/AnyType",
25342538
"description": "The value of the key."
2539+
},
2540+
"description" : {
2541+
"type": "string",
2542+
"description": "Description of the custom property."
25352543
}
25362544
},
25372545
"required": ["property", "value"],

0 commit comments

Comments
 (0)