Skip to content

docs: Adds schemas that are separate from API documentation #1478

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
calumcalder merged 1 commit into from
Jan 8, 2026
Merged

docs: Adds schemas that are separate from API documentation #1478

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion extensions/data-transfer/portability-data-transfer-generic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,8 @@ All POST requests containing data to be imported are wrapped in a top-level `Gen
},
"schemaSource": {
"type": "string",
"description": "The source file containing the schema definition"
"description": "The source file containing the schema definition. The whole path relative to this package is not needed,
so the value may be '.../SocialPostsSerializer.java' rather than './src/main/java/org/datatransferproject/datatransfer/generic/SocialPostsSerializer'."
},
"@type": {
"const": "GenericPayload"
Expand Down
110 changes: 110 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
@@ -0,0 +1,110 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"CalendarEventTime": {
"type": "object",
"properties": {
"dateOnly": {
"type": "boolean"
},
"dateTime": {
"type": "string",
"format": "date-time"
},
"@type": {
"const": "CalendarEventModel$CalendarEventTime"
}
},
"required": [
"@type",
"dateTime"
]
}
},
"anyOf": [
{
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"@type": {
"const": "Calendar"
}
},
"required": [
"@type",
"name",
"id"
]
},
{
"type": "object",
"properties": {
"attendees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"displayName": {
"type": "string"
},
"email": {
"type": "string"
},
"optional": {
"type": "boolean"
},
"@type": {
"const": "CalendarAttendeeModel"
}
},
"required": [
"@type"
]
}
},
"calendarId": {
"type": "string"
},
"endTime": {
"$ref": "#/$defs/CalendarEventTime"
},
"location": {
"type": "string"
},
"notes": {
"type": "string"
},
"recurrenceRule": {
"type": "object",
"properties": {
"exDate": {
"type": "object"
}
}
},
"startTime": {
"$ref": "#/$defs/CalendarEventTime"
},
"title": {
"type": "string"
},
"@type": {
"const": "CalendarEvent"
}
},
"required": [
"@type",
"calendarId",
"title"
]
}
]
}
14 changes: 14 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
@@ -0,0 +1,14 @@
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"error_description": {
"type": "string"
}
},
"required": [
"error"
]
}
27 changes: 27 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
@@ -0,0 +1,27 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"dateModified": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"folder": {
"type": "string"
},
"name": {
"type": "string"
},
"@type": {
"const": "File"
}
},
"required": [
"@type",
"name",
"folder"
]
}
17 changes: 17 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
@@ -0,0 +1,17 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "Full path of the folder to be created"
},
"@type": {
"const": "Folder"
}
},
"required": [
"@type",
"path"
]
}
41 changes: 41 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/media-payload-example.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
{
"@type": "GenericPayload",
"schemaSource": ".../SocialPostsSerializer.java",
"apiVersion": "0.1.0",
"payload": {
"@type": "SocialActivityData",
"metadata": {
"@type": "SocialActivityMetadata",
"actor": {
"@type": "SocialActivityActor",
"id": "321",
"name": "Steve",
"url": null
}
},
"activity": {
"@type": "SocialActivityModel",
"id": "456",
"published": 1731604863.845677,
"type": "NOTE",
"attachments": [
{
"@type": "SocialActivityAttachment",
"type": "IMAGE",
"url": "foo.com",
"name": "Foo",
"content": null
}
],
"location": {
"@type": "SocialActivityLocation",
"name": "foo",
"longitude": 10.0,
"latitude": 10.0
},
"title": "Hello world!",
"content": "Hi there",
"url": null
}
}
}
24 changes: 24 additions & 0 deletions extensions/data-transfer/portability-data-transfer-generic/media-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"$schema" : "https://json-schema.org/draft/2020-12/schema",
"$id": "https://id.schemas.pub/org/dtinit.org/dtp/media-0.1.0",
"type": "object",
"properties": {
"description": {
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"@type": {
"const": "Album"
}
},
"required": [
"@type",
"id",
"name"
]
}
30 changes: 30 additions & 0 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
@@ -0,0 +1,30 @@
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"apiVersion": {
"type": "string"
},
"payload": {
"type": "object",
"description": "The inner payload, which contains data from one of the described data verticals",
"minProperties": 1,
"anyOf": [{
"$ref": "media-schema.json"
}]
},
"schemaSource": {
"type": "string",
"description": "The source file containing the schema definition"
},
"@type": {
"const": "GenericPayload"
}
},
"required": [
"@type",
"schemaSource",
"apiVersion",
"payload"
]
}
85 changes: 85 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
@@ -0,0 +1,85 @@
{
"$schema" : "https://json-schema.org/draft/2020-12/schema",
"$defs": {
"FavoriteInfo": {
"type": "object",
"properties": {
"favorite": {
"type": "boolean"
},
"lastUpdateTime": {
"type": "string",
"format": "date-time"
},
"@type": {
"const": "FavoriteInfo"
}
},
"required": [
"@type",
"favorite",
"lastUpdateTime"
]
}
},
"anyOf": [
{
"type": "object",
"properties": {
"albumId": {
"type": "string"
},
"description": {
"type": "string"
},
"favoriteInfo": {
"$ref": "#/$defs/FavoriteInfo"
},
"name": {
"type": "string"
},
"uploadedTime": {
"type": "string",
"format": "date-time"
},
"@type": {
"const": "Video"
}
},
"required": [
"@type",
"albumId",
"name"
]
},
{
"type": "object",
"properties": {
"albumId": {
"type": "string"
},
"description": {
"type": "string"
},
"favoriteInfo": {
"$ref": "#/$defs/FavoriteInfo"
},
"name": {
"type": "string"
},
"uploadedTime": {
"type": "string",
"format": "date-time"
},
"@type": {
"const": "Photo"
}
},
"required": [
"@type",
"albumId",
"name"
]
}
]
}
Loading
Loading