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.

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

Proposal for the Podcast ActivityStream #1

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md"
],
"id": "https://podcast.demo/podcasts/activitypub/episodes/example-episode.mp3",
"partOfPodcastEpisode": "https://podcast.demo/media/example-episode",
"type": "Audio",
"name": "An Example PodcastEpisode Object",
"size": 1962804,
"bitrate": 320000,
"duration": 42,
"url": {
"href": "https://podcast.demo/media/example-episode.mp3",
"type": "Link",
"mediaType": "audio/mpeg"
},
"caption": "https://podcast.demo/media/example-episode/caption",
"transcript": "https://podcast.demo/media/example-episode/transcript",
"chapters": "https://podcast.demo/media/example-episode/chapters"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md"
],
"type": "PodcastEpisode",
"id": "https://podcast.demo/podcasts/DemoPodcast/episodes/example-episode",
"attributedTo": "https://podcast.demo/podcasts/DemoPodcast",
"to": ["https://www.w3.org/ns/activitystreams#Public"],
"cc": ["https://podcast.demo/podcasts/DemoPodcast/followers"],
"name": "An Example PodcastEpisode Object",
"description": {
"type": "Note",
"mediaType": "text/markdown",
"content": "Here is the description for the **demo episode**!",
"contentMap": {
"en": "<p>Here is the description for the <strong>demo episode</strong>!</p>",
"fr": "<p>Voici la description pour la <strong>démo de l’épisode</strong> !</p>"
}
},
"image": {
"type": "Image",
"mediaType": "image/jpeg",
"url": "https://podcast.demo/media/example-episode_cover.jpg"
},
"audio": {
"id": "https://podcast.demo/podcasts/activitypub/episodes/example-episode.mp3",
"type": "Audio",
"name": "An Example PodcastEpisode Object",
"size": 1962804,
"bitrate": 320000,
"duration": 42,
"url": {
"href": "https://podcast.demo/media/example-episode.mp3",
"type": "Link",
"mediaType": "audio/mpeg"
},
"caption": "https://podcast.demo/media/example-episode/caption",
"transcript": "https://podcast.demo/media/example-episode/transcript",
"chapters": "https://podcast.demo/media/example-episode/chapters"
},
"partOfSeason": "https://podcast.demo/podcasts/DemoPodcast/seasons/1",
"episodeNumber": 1,
"explicit": false,
"location": {
"@type": "Place",
"geo": {
"@type": "GeoCoordinates",
"latitude": "48.8566969",
"longitude": "2.3514616"
},
"name": "Paris, France"
},
"discoverable": true,
"replies": "https://podcast.demo/podcasts/DemoPodcast/episodes/example-episode/replies",
"published": "2021-04-15T18:00:00Z"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md"
],
"id": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=2",
"type": "OrderedCollectionPage",
"partOf": "https://podcast.demo/podcasts/DemoPodcast/episodes",
"totalItems": 42,
"first": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=1",
"current": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=2",
"next": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=3",
"last": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=5",
"orderedItems": [
"# List of ordered PodcastEpisode objects (example in `examples/podcast-episode-object.json`)",
"# This example would show 10 episodes per page"
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"@context": "https://www.w3.org/ns/activitystreams",
"id": "https://podcast.demo/podcasts/DemoPodcast/episodes",
"type": "OrderedCollection",
"totalItems": 42,
"first": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=1"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md"
],
"id": "https://podcast.demo/podcasts/DemoPodcast/persons?page=1",
"type": "OrderedCollectionPage",
"partOf": "https://podcast.demo/podcasts/DemoPodcast/persons",
"totalItems": 2,
"first": "https://podcast.demo/podcasts/DemoPodcast/persons?page=1",
"current": "https://podcast.demo/podcasts/DemoPodcast/persons?page=1",
"last": "https://podcast.demo/podcasts/DemoPodcast/persons?page=1",
"orderedItems": [
{
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/jane_doe"
},
{
"@type": "Person",
"name": "John Doe",
"sameAs": "https://en.wikipedia.org/wiki/john_doe"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"@context": "https://www.w3.org/ns/activitystreams",
"id": "https://podcast.demo/podcasts/DemoPodcast/episodes",
"type": "OrderedCollection",
"totalItems": 2,
"first": "https://podcast.demo/podcasts/DemoPodcast/episodes?page=1"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"id": "https://podcast.demo/podcasts/activitypub/seasons/1",
"seasonNumber": 1,
"numberOfEpisodes": 12,
"episodes": "https://podcast.demo/podcasts/activitypub/seasons/1/episodes",
"trailer": "https://podcast.demo/podcasts/activitypub/seasons/1/trailer"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md"
],
"id": "https://podcast.demo/podcasts/DemoPodcast/value-recipients?page=1",
"type": "CollectionPage",
"partOf": "https://podcast.demo/podcasts/DemoPodcast",
"totalItems": 2,
"first": "https://podcast.demo/podcasts/DemoPodcast/value-recipients?page=1",
"current": "https://podcast.demo/podcasts/DemoPodcast/value-recipients?page=1",
"last": "https://podcast.demo/podcasts/DemoPodcast/value-recipients?page=1",
"items": [
{
"name": "Jane Doe",
"type": "node",
"address": "02d5c1bf8b940dc9cadca86d1b0a3c37fbe39cee4c7e839e33bef9174531d27f52",
"split": "50",
"fee": "true"
},
{
"name": "John Doe",
"type": "node",
"address": "032f4ffbbafffbe51726ad3c164a3d0d37ec27bc67b29a159b0f49ae8ac21b8508",
"split": "50",
"fee": "true"
}
]
}
82 changes: 82 additions & 0 deletions proposal-docs/podcast-activitystream/examples/podcast.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
{
"@context": [
"https://www.w3.org/ns/activitystreams",
"https://w3id.org/security/v1",
"https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md"
],
"to": ["https://www.w3.org/ns/activitystreams#Public"],
"id": "https://podcast.demo/podcasts/DemoPodcast",
"type": "Podcast",
"rss": "https://podcast.demo/podcasts/DemoPodcast/feed.xml",
"name": "The Demo Podcast",
"preferredUsername": "DemoPodcast",
"summary": "<p>This is a demonstration of the activitypub protocol applied to Podcasts!</p>",
"inbox": "https://podcast.demo/podcasts/DemoPodcast/inbox",
"outbox": "https://podcast.demo/podcasts/DemoPodcast/outbox",
"followers": "https://podcast.demo/podcasts/DemoPodcast/followers",
"following": "https://podcast.demo/podcasts/DemoPodcast/following",
"episodes": "https://podcast.demo/podcasts/DemoPodcast/episodes",
"url": "https://podcast.demo/podcasts/DemoPodcast",
"image": {
"type": "Image",
"mediaType": "image/jpeg",
"url": "https://podcast.demo/media/podcasts/DemoPodcast/cover.jpg"
},
"icon": {
"type": "Image",
"mediaType": "image/jpeg",
"url": "https://podcast.demo/media/podcasts/DemoPodcast/avatar.jpg"
},
"language": "en",
"category": "Fiction > Science Fiction",
"explicit": false,
"publisher": {
"@type": "Organization",
"name": "John Doe Corp.",
"email": "contact@johndoe.demo"
},
"author": {
"@type": "Person",
"name": "Jane Doe",
"email": "jane.doe@podcast.demo"
},
"owner": {
"@type": "Person",
"name": "John Doe",
"email": "john.doe@podcast.demo"
},
"persons": "https://podcast.demo/podcasts/DemoPodcast/persons",
"location": {
"@type": "Place",
"geo": {
"@type": "GeoCoordinates",
"latitude": "48.8566969",
"longitude": "2.3514616"
},
"name": "Paris, France"
},
"trailer": "https://podcast.demo/podcasts/DemoPodcast/trailer",
"copyrightHolder": {
"@type": "Person",
"name": "Jane Doe",
"sameAs": "https://en.wikipedia.org/wiki/jane_doe"
},
"copyrightNotice": "(CC BY-ND 4.0)",
"copyrightYear": 2021,
"discoverable": false,
"complete": false,
"locked": true,
"license": "https://creativecommons.org/licenses/by-nd/4.0/",
"value": {
"id": "https://podcast.demo/podcasts/DemoPodcast/value",
"type": "lightning",
"method": "keysend",
"suggested": "0.00000005000",
"valueRecipients": "https://podcast.demo/podcasts/DemoPodcast/value/recipients"
},
"publicKey": {
"id": "https://podcast.demo/podcasts/DemoPodcast#main-key",
"owner": "https://podcast.demo/podcasts/DemoPodcast",
"publicKeyPem": "-----BEGIN PUBLIC KEY----- ... -----END PUBLIC KEY-----"
}
}
57 changes: 57 additions & 0 deletions proposal-docs/podcast-activitystream/jsonld-namespace.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
{
"@context": {
"id": "@id",
"type": "@type",
"as": "https://www.w3.org/ns/activitystreams#",
"schema": "http://schema.org#",
"podcast": "https://github.com/Podcastindex-org/activitypub-spec-work/blob/main/docs/1.0.md#",
"xsd": "http://www.w3.org/2001/XMLSchema#",
"Podcast": "podcast:Podcast",
"PodcastEpisode": "podcast:PodcastEpisode",
"publisher": "schema:publisher",
"author": "schema:author",
"owner": "schema:Person",
"category": "schema:category",
"language": "schema:inLanguage",
"location": "schema:location",
"license": "schema:license",
"explicit": "podcast:explicit",
"discoverable": "podcast:discoverable",
"complete": "podcast:complete",
"locked": "podcast:locked",
"copyrightHolder": "schema:copyrightHolder",
"copyrightNotice": "schema:copyrightNotice",
"copyrightYear": "schema:copyrightYear",
"value": "podcast:value",
"description": "as:Note",
"partOfPodcastEpisode": "podcast:partOfPodcastEpisode",
"episodes": {
"@id": "podcast:episodes",
"@type": "@id"
},
"persons": {
"@id": "podcast:persons",
"@type": "@id"
},
"movedTo": {
"@id": "as:movedTo",
"@type": "@id"
},
"audio": {
"@id": "as:Audio",
"@type": "@id"
},
"partOfSeason": {
"@id": "schema:PodcastSeason",
"@type": "@id"
},
"trailer": {
"@id": "podcast:PodcastEpisode",
"@type": "@id"
},
"valueRecipients": {
"@id": "podcast:valueRecipients",
"@type": "@id"
}
}
}
Loading