Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add reference to broadcast series / shows for news items #277

Closed
wants to merge 4 commits into from
Closed

Add reference to broadcast series / shows for news items #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2591491
Draft for referencing corresponding broadcast series / shows for news…
saerdnaer Mar 10, 2022
30538e2
Add stub for alternateIds field
saerdnaer Mar 28, 2022
d7046ed
Updates after discussion from last week
saerdnaer Mar 6, 2023
a3ab3b6
chore: prettify table
saerdnaer Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ These ARD broadcasters are currently sending live metadata via ARD Eventhub:
| Broadcaster | TEST | PROD |
| ---------------- | ---- | ---- |
| BR | - | - |
| HR | ✅ | ✅ |
| MDR | ✅ | ✅ |
| NDR | ✅ | ✅ |
| Radio Bremen | ✅ | ✅ |
| RBB | ⌛️ | - |
| HR | ✅ | ✅ |
| MDR | ✅ | ✅ |
| NDR | ✅ | ✅ |
| Radio Bremen | ✅ | ✅ |
| RBB | ⌛️ | - |
| SR | - | - |
| SWR | ✅ | ✅ |
| WDR | ✅ | ⌛️ |
| SWR | ✅ | ✅ |
| WDR | ✅ | ⌛️ |
| Deutschlandradio | - | - |

## Get Started and Documentation
Expand Down
16 changes: 14 additions & 2 deletions docs/TYPES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ If a live element is starting. This can be an moderation by an anchor, interview

## `news`

This indicates the beginning of the news in general or a new news item. Get as detailed as possible. The `contributors` field can be used to include details of the `author`. `media` may be used to supply additional elements.
This indicates the beginning of the news in general or a new news item. Get as detailed as possible. The `contributors` field should be used to include details of the `author`. `media` may be used to supply additional elements. `show` references the correspoding broadcast series / grouping.

```json
{
Expand All @@ -87,7 +87,19 @@ This indicates the beginning of the news in general or a new news item. Get as d
}
],
"playlistItemId": "BCS1:cd052498-da90-4308-85d3-046cb15c6840",
"externalId": "TBD",
"externalId": "crid://swr.de/av/406d20f0-d9b8-431f-9e36-e2fa2cf263a5",
"references": [
{
"type": "Show",
"externalId": "crid://swr.de/1234567",
"alternateIds": ["https://normdb.ivz.cn.ard.de/sendereihe/427", "urn:ard:show:027708befb6bfe14", "brid://br.de/broadcastSeries/1235"]
},
{
"type": "Article",
"title": "Kommerzielle US-Raumfahrt – Die neue Weltraumökonomie",
"url": "https://www.deutschlandfunkkultur.de/kommerzielle-us-raumfahrt-die-neue-weltraumoekonomie-100.html"
},
]
…
}
```
Expand Down
76 changes: 76 additions & 0 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -899,6 +899,51 @@
}
}
},
"reference": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"enum": [
"Episode",
"Section",
"Publication",
"Broadcast",
"Show",
"Season",
"Article"
]
},
"id": {
"type": "string",
"pattern": "^urn:ard:[a-z0-9-]+:[a-z0-9-]+$",
"example": "urn:ard:show:49267f7d67be180d"
},
"externalId": {
"type": "string",
"example": "crid://swr.de/123450",
"pattern": "^(c|b)rid://.+$"
},
"title": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"alternateIds": {
"type": "array",
"items": {
"type": "string",
"example": "https://normdb.ivz.cn.ard.de/sendereihe/427"
}
}
},
"required": [
"type"
]
},
"eventV1PostBody": {
"additionalProperties": false,
"required": [
Expand Down Expand Up @@ -1028,6 +1073,37 @@
]
}
},
"references": {
"type": "string",
"description": "related external entities",
"nullable": true,
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/reference",
"required": [
"type",
"externalId"
]
},
{
"$ref": "#/components/schemas/reference",
"required": [
"type",
"id"
]
},
{
"$ref": "#/components/schemas/reference",
"required": [
"type",
"title",
"url"
]
}
]
}
},
"playlistItemId": {
"type": "string",
"description": "Unique identifier (within a publisher) to connect next and playing items if needed",
Expand Down
54 changes: 54 additions & 0 deletions openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,6 +621,41 @@ components:
description: Globally unique identifier, created by Eventhub
example: 'urn:ard:permanent-livestream:49267f7d67be180d'

reference:
type: object
additionalProperties: false
properties:
type:
type: string
enum:
- Episode
- Section
- Publication
- Broadcast
- Show
- Season
- Article
id:
type: string
pattern: ^urn:ard:[a-z0-9-]+:[a-z0-9-]+$
example: urn:ard:show:49267f7d67be180d
externalId:
type: string
example: crid://swr.de/123450
pattern: ^(c|b)rid://.+$
title:
type: string
url:
type: string
format: uri
alternateIds:
type: array
items:
type: string
example: https://normdb.ivz.cn.ard.de/sendereihe/427
required:
- type

eventV1PostBody:
additionalProperties: false
required:
Expand Down Expand Up @@ -729,6 +764,25 @@ components:
minItems: 1
allOf:
- $ref: '#/components/schemas/services'
references:
type: string
description: related external entities
nullable: true
items:
oneOf:
- $ref: '#/components/schemas/reference'
required:
- type
- externalId
- $ref: '#/components/schemas/reference'
required:
- type
- id
- $ref: '#/components/schemas/reference'
required:
- type
- title
- url
playlistItemId:
type: string
description: >-
Expand Down