Skip to content

docs: Schemas used in generic extension endpoints are combined using JSON Subschemas #1482

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

Merged
lisad merged 2 commits into from
Feb 3, 2026
Merged

docs: Schemas used in generic extension endpoints are combined using JSON Subschemas #1482

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6b260b4
Removes schemas from readme now that they are separately addressable
lisad Jan 30, 2026
a8a2237
Adds subschemas to payload schema by . This allows validation of the …
lisad Jan 30, 2026
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
493 changes: 20 additions & 473 deletions extensions/data-transfer/portability-data-transfer-generic/README.md
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion ...y-data-transfer-generic/media-schema.json → ...y-data-transfer-generic/album-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema" : "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/org/dtinit.org/dtp/media-0.1.0",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/album-schema",
"title": "Schema for Album metadata in data-transfer-project generic endpoints",
"type": "object",
"properties": {
"description": {
Expand Down
2 changes: 2 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/calendar-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/calendar-schema",
"title": "Schema for Calendar object info in data-transfer-project generic endpoints",
"$defs": {
"CalendarEventTime": {
"type": "object",
Expand Down
3 changes: 3 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/error-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/error-schema",
"title": "Schema for Album metadata in data-transfer-project generic endpoints",
"type": "object",
"properties": {
"error": {
Expand Down
2 changes: 2 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/file-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/file-schema",
"title": "Schema for file (blob) metadata in data-transfer-project generic endpoints",
"type": "object",
"properties": {
"dateModified": {
Expand Down
2 changes: 2 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/folder-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/folder-schema",
"title": "Schema for folder metadata in data-transfer-project generic endpoints",
"type": "object",
"properties": {
"path": {
Expand Down
13 changes: 10 additions & 3 deletions extensions/data-transfer/portability-data-transfer-generic/payload-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/payload-schema",
"title": "Schema for payload wrapper in data-transfer-project generic endpoints",
"type": "object",
"properties": {
"apiVersion": {
Expand All @@ -9,9 +11,14 @@
"type": "object",
"description": "The inner payload, which contains data from one of the described data verticals",
"minProperties": 1,
"anyOf": [{
"$ref": "media-schema.json"
}]
"anyOf": [
{ "$ref": "album-schema" },
{ "$ref": "calendar-schema" },
{ "$ref": "file-schema" },
{ "$ref": "folder-schema" },
{ "$ref": "photo-and-video-schema" },
{ "$ref": "social-posts-schema" }
]
},
"schemaSource": {
"type": "string",
Expand Down
2 changes: 2 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/photo-and-video-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"$schema" : "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/photo-and-video-schema",
"title": "Schema for photo and video metadata in data-transfer-project generic endpoints",
"$defs": {
"FavoriteInfo": {
"type": "object",
Expand Down
10 changes: 5 additions & 5 deletions ...ansfer-generic/media-payload-example.json → ...-generic/social-post-payload-example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,28 @@
"schemaSource": ".../SocialPostsSerializer.java",
"apiVersion": "0.1.0",
"payload": {
"@type": "SocialActivityData",
"@type": "SocialActivity",
"metadata": {
"@type": "SocialActivityMetadata",
"actor": {
"@type": "SocialActivityActor",
"id": "321",
"name": "Steve",
"url": null
"url": "http://example.org/actor/321"
}
},
"activity": {
"@type": "SocialActivityModel",
"id": "456",
"published": 1731604863.845677,
"published": "1731604863.845677",
"type": "NOTE",
"attachments": [
{
"@type": "SocialActivityAttachment",
"type": "IMAGE",
"url": "foo.com",
"name": "Foo",
"content": null
"content": "Example content"
}
],
"location": {
Expand All @@ -35,7 +35,7 @@
},
"title": "Hello world!",
"content": "Hi there",
"url": null
"url": "http://example.org/post/foo"
}
}
}
2 changes: 2 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/social-posts-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/o/dtinit.org/dtp/social-posts-schema",
"title": "Schema for social post object data in data-transfer-project generic endpoints",
"type": "object",
"properties": {
"activity": {
Expand Down
Loading