Skip to content

Commit e793daa

Browse files
dccakesdccakes
authored
Merge pull request #157 from bitol-io/rfc-23
2 parents cff487f + 55afd6f commit e793daa

File tree

4 files changed

+31
-17
lines changed

4 files changed

+31
-17
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ This document tracks the history and evolution of the **Open Data Contract Stand
4242
* Add a maintained library of commonly used quality metrics `rowCount`, `nullValues`, `invalidValues`, `duplicateValues`, and `missingValues`.
4343
* **Changes** to SLA:
4444
* Add optional `description` field to SLA entries for human-readable context.
45+
* **Changes** to Support Channels:
46+
* Change `url` field to be optional.
47+
* Add `customProperties` field for additional metadata.
48+
* Add `notifications` as an example for `scope`
49+
* Add `googlechat` as an example for `tool`
4550
* **Changes** to Servers:
4651
* AzureServer `format` not longer an enum of `parquet`, `delta`, `json`, `csv`, but rather a string with the same examples.
4752
* AzureServer `delimiter` not longer an enum of `new_line`, `array`, but rather a string with the same examples.

‎docs/README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -957,8 +957,7 @@ Support and communication channels help consumers find help regarding their use
957957

958958
```yaml
959959
support:
960-
- channel: channel-name-or-identifier # Simple Slack communication channel
961-
url: https://aidaug.slack.com/archives/C05UZRSBKLY
960+
- channel: "#my-channel" # Simple Slack communication channel
962961
- channel: channel-name-or-identifier # Simple distribution list
963962
url: mailto:datacontract-ann@bitol.io
964963
```
@@ -992,15 +991,16 @@ support:
992991

993992
### Definitions
994993

995-
| Key | UX label | Required | Description |
996-
|-----------------------|----------------|----------|-------------------------------------------------------------------------------------------------------------------------------------|
997-
| support | Support | No | Top level for support channels. |
998-
| support.channel | Channel | Yes | Channel name or identifier. |
999-
| support.url | Channel URL | Yes | Access URL using normal [URL scheme](https://en.wikipedia.org/wiki/URL#Syntax) (https, mailto, etc.). |
1000-
| support.description | Description | No | Description of the channel, free text. |
1001-
| support.tool | Tool | No | Name of the tool, value can be `email`, `slack`, `teams`, `discord`, `ticket`, or `other`. |
1002-
| support.scope | Scope | No | Scope can be: `interactive`, `announcements`, `issues`. |
1003-
| support.invitationUrl | Invitation URL | No | Some tools uses invitation URL for requesting or subscribing. Follows the [URL scheme](https://en.wikipedia.org/wiki/URL#Syntax). |
994+
| Key | UX label | Required | Description |
995+
|-----------------------|----------------|----------|-----------------------------------------------------------------------------------------------------------------------------------|
996+
| support | Support | No | Top level for support channels. |
997+
| support.channel | Channel | Yes | Channel name or identifier. |
998+
| support.url | Channel URL | No | Access URL using normal [URL scheme](https://en.wikipedia.org/wiki/URL#Syntax) (https, mailto, etc.). |
999+
| support.description | Description | No | Description of the channel, free text. |
1000+
| support.tool | Tool | No | Name of the tool, value can be `email`, `slack`, `teams`, `discord`, `ticket`, `googlechat`, or `other`. |
1001+
| support.scope | Scope | No | Scope can be: `interactive`, `announcements`, `issues`, `notifications`. |
1002+
| support.invitationUrl | Invitation URL | No | Some tools uses invitation URL for requesting or subscribing. Follows the [URL scheme](https://en.wikipedia.org/wiki/URL#Syntax). |
1003+
| support.customProperties | Custom Properties | No | Any custom properties. |
10041004

10051005

10061006
## Pricing

‎docs/examples/all/full-example.odcs.yaml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,13 +283,19 @@ slaProperties:
283283
support:
284284
- channel: '#product-help' # Simple Slack communication channel
285285
tool: slack
286-
url: https://aidaug.slack.com/archives/C05UZRSBKLY
287286
- channel: datacontract-ann # Simple distribution list
288287
tool: email
289288
url: mailto:datacontract-ann@bitol.io
290289
- channel: Feedback # Product Feedback
291290
description: General Product Feedback (Public)
292291
url: https://product-feedback.com
292+
- channel: 'product-issues'
293+
tool: teams
294+
scope: issues
295+
customProperties:
296+
- property: servicehours
297+
value: 9-5 CET
298+
293299

294300
# Tags
295301
tags:

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2352,20 +2352,23 @@
23522352
},
23532353
"tool": {
23542354
"type": "string",
2355-
"description": "Name of the tool, value can be `email`, `slack`, `teams`, `discord`, `ticket`, or `other`.",
2356-
"examples": ["email", "slack", "teams", "discord", "ticket", "other"]
2355+
"description": "Name of the tool, value can be `email`, `slack`, `teams`, `discord`, `ticket`, `googlechat`, or `other`.",
2356+
"examples": ["email", "slack", "teams", "discord", "ticket", "googlechat","other"]
23572357
},
23582358
"scope": {
23592359
"type": "string",
2360-
"description": "Scope can be: `interactive`, `announcements`, `issues`.",
2361-
"examples": ["interactive", "announcements", "issues"]
2360+
"description": "Scope can be: `interactive`, `announcements`, `issues`, `notifications`.",
2361+
"examples": ["interactive", "announcements", "issues", "notifications"]
23622362
},
23632363
"invitationUrl": {
23642364
"type": "string",
23652365
"description": "Some tools uses invitation URL for requesting or subscribing. Follows the [URL scheme](https://en.wikipedia.org/wiki/URL#Syntax)."
2366+
},
2367+
"customProperties": {
2368+
"$ref": "#/$defs/CustomProperties"
23662369
}
23672370
},
2368-
"required": ["channel", "url"],
2371+
"required": ["channel"],
23692372
"additionalProperties": false
23702373
},
23712374
"Pricing": {

0 commit comments

Comments
 (0)