Update `embed_content_request.json` schema - Githubissues

learningequality / le-utils

Utilities and constants shared across Kolibri, Ricecooker, and Kolibri Studio

MIT License

3 stars 31 forks source link

Update `embed_content_request.json` schema #122

Closed akolson closed 6 months ago

akolson commented 7 months ago

Overview

This task involves updating the embed_content_request.json schema to accept a list of files.

Description and outcomes

Modify the embed_content_request.json schema to accept a list of files.
- Name the property files of type array
- Each file in files is of type object
- file contains the following fields;
  - url of type string. The url should be a valid URL/URI and open to specific domains.
    - The GCP buckets domain
    - Localhost domains
  - preset of type enum. See format_presets.py for accepted list of options
  - language of type string. Use the language for this.
- files should be added to the resource property
- It is an optional property
Add additional tests to verify correctness of implementation

Acceptance Criteria

A new property files is added to the embed_content_request.json schema
Appropriate tests are added to verify correctness

Assumptions and Dependencies

Blocks
- https://github.com/learningequality/studio/issues/4455

Scope

The scope of this task is limited to;

Adding the files property to the embed_content_request.json schema.

Accessibility Requirements

NA

Resources