Skip to content

Consolidate common embed schema into individual schemas #172

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
bjester merged 1 commit into from
Jun 26, 2025
Merged

Consolidate common embed schema into individual schemas #172

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
11 changes: 8 additions & 3 deletions js/EmbedContentRequest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ export const SCHEMA = {
"description": "Schema for embed content requests received by RayServe",
"additionalProperties": false,
"definitions": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"description": "A unique identifier in the form of a UUID"
},
"language": {
"type": "string",
"description": "Language code from https://github.com/learningequality/le-utils/blob/main/le_utils/resources/languagelookup.json",
Expand Down Expand Up @@ -81,11 +86,11 @@ export const SCHEMA = {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the content resource"
},
"channel_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the channel that the content resource belongs to"
},
"title": {
Expand All @@ -111,7 +116,7 @@ export const SCHEMA = {
}
},
"content_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the content resource(s)"
}
},
Expand Down
11 changes: 8 additions & 3 deletions js/EmbedTopicsRequest.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ export const SCHEMA = {
"description": "Schema for embed topics requests received by RayServe",
"additionalProperties": false,
"definitions": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"description": "A unique identifier in the form of a UUID"
},
"title": {
"type": "string",
"description": "The title of the topic"
Expand All @@ -33,7 +38,7 @@ export const SCHEMA = {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The ID of the topic content node on Studio"
},
"title": {
Expand Down Expand Up @@ -69,11 +74,11 @@ export const SCHEMA = {
"additionalProperties": false,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The ID of the topic content node on Studio"
},
"channel_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the channel that the topic belongs to"
},
"title": {
Expand Down
2 changes: 1 addition & 1 deletion js/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"version": "0.2.11"
"version": "0.2.12"
}
11 changes: 8 additions & 3 deletions le_utils/constants/embed_content_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
"description": "Schema for embed content requests received by RayServe",
"additionalProperties": False,
"definitions": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"description": "A unique identifier in the form of a UUID",
},
"language": {
"type": "string",
"description": "Language code from https://github.com/learningequality/le-utils/blob/main/le_utils/resources/languagelookup.json",
Expand Down Expand Up @@ -78,11 +83,11 @@
"additionalProperties": False,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the content resource",
},
"channel_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the channel that the content resource belongs to",
},
"title": {
Expand All @@ -104,7 +109,7 @@
"items": {"$ref": "#/definitions/file"},
},
"content_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the content resource(s)",
},
},
Expand Down
11 changes: 8 additions & 3 deletions le_utils/constants/embed_topics_request.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,11 @@
"description": "Schema for embed topics requests received by RayServe",
"additionalProperties": False,
"definitions": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"description": "A unique identifier in the form of a UUID",
},
"title": {"type": "string", "description": "The title of the topic"},
"description": {
"type": "string",
Expand All @@ -36,7 +41,7 @@
"additionalProperties": False,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The ID of the topic content node on Studio",
},
"title": {"$ref": "#/definitions/title"},
Expand All @@ -57,11 +62,11 @@
"additionalProperties": False,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The ID of the topic content node on Studio",
},
"channel_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the channel that the topic belongs to",
},
"title": {"$ref": "#/definitions/title"},
Expand Down
11 changes: 0 additions & 11 deletions le_utils/resources/definitions-embed_common.json
View file
Open in desktop

This file was deleted.

Empty file removed le_utils/validators/__init__.py
View file
Open in desktop
Empty file.
22 changes: 0 additions & 22 deletions le_utils/validators/common.py
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions le_utils/validators/embed_content_request.py
View file
Open in desktop

This file was deleted.

14 changes: 0 additions & 14 deletions le_utils/validators/embed_topics_request.py
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
setup(
name="le-utils",
packages=find_packages(),
version="0.2.11",
version="0.2.12",
description="LE-Utils contains shared constants used in Kolibri, Ricecooker, and Kolibri Studio.",
long_description=long_description,
long_description_content_type="text/markdown",
Expand Down
11 changes: 8 additions & 3 deletions spec/schema-embed_content_request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
"description": "Schema for embed content requests received by RayServe",
"additionalProperties": false,
"definitions": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"description": "A unique identifier in the form of a UUID"
},
"language": {
"type": "string",
"description": "Language code from https://github.com/learningequality/le-utils/blob/main/le_utils/resources/languagelookup.json",
Expand Down Expand Up @@ -76,11 +81,11 @@
"additionalProperties": false,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the content resource"
},
"channel_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the channel that the content resource belongs to"
},
"title": {
Expand All @@ -106,7 +111,7 @@
}
},
"content_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the content resource(s)"
}
},
Expand Down
11 changes: 8 additions & 3 deletions spec/schema-embed_topics_request.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
"description": "Schema for embed topics requests received by RayServe",
"additionalProperties": false,
"definitions": {
"uuid": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
"description": "A unique identifier in the form of a UUID"
},
"title": {
"type": "string",
"description": "The title of the topic"
Expand All @@ -28,7 +33,7 @@
"additionalProperties": false,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The ID of the topic content node on Studio"
},
"title": {
Expand Down Expand Up @@ -64,11 +69,11 @@
"additionalProperties": false,
"properties": {
"id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The ID of the topic content node on Studio"
},
"channel_id": {
"$ref": "/schemas/common_embed_definitions#/definitions/uuid",
"$ref": "#/definitions/uuid",
"description": "The UUID of the channel that the topic belongs to"
},
"title": {
Expand Down
Loading
Loading