https://github.com/rusticisoftware/tincanschema

JSON Schema for Tin Can Structures
https://github.com/rusticisoftware/tincanschema

Last synced: 5 months ago
JSON representation

JSON Schema for Tin Can Structures

• Host: GitHub
• URL: https://github.com/rusticisoftware/tincanschema
• Owner: RusticiSoftware
• License: apache-2.0
• Created: 2014-08-13T13:30:51.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-05-26T20:25:46.000Z (almost 4 years ago)
• Last Synced: 2025-10-05T22:32:59.685Z (6 months ago)
• Language: JavaScript
• Size: 73.2 KB
• Stars: 17
• Watchers: 32
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Tin Can Schema

==============

The folder(s) here contain JSON schema for Tin Can API objects. They are

used to validate objects against the

[Tin Can API specification](https://github.com/adlnet/xAPI-Spec).

The schema are designed to be language-independent; the only requirements are

1. That the validator must

   [support draft-4](http://www.json-schema.org/implementations.html) JSON

   schema, and

2. That the validator has some way of registering Regular Expressions to

   support the `format` field. This is not a hard requirement, but without this

   support, strings will not be verified for their format.

We are testing the schema using

[Tin Can Validator](https://github.com/RusticiSoftware/TinCanValidator).

Structure

---------

Each directory contains a complete set of parts that can be easily assembled

into a complete schema file.

A `formats` sub-directory may be present. This contains Regular Expression

strings in JSON format to validate special strings like UUIDs, version numbers

and URIs. These are not part of the schema itself, but must be registered with

the schema validator to enable string format checking.

### Build the schema (automatic)

You can use

[Tin Can Validator](https://github.com/RusticiSoftware/TinCanValidator) to do

this for you:

    git clone https://github.com/RusticiSoftware/TinCanValidator

    cd TinCanValidator

    ./joinSchema.js path/to/TinCanSchema/ result.json

### Build the schema (manual)

If you don't want to use that, follow these instructions:

    // 1. Make a skeleton:

    result = {

        "$schema": "http://json-schema.org/draft-04/schema#",

        "type": "object",

        "additionalProperties": false,

        "properties": {}

    }

    // 2. For each JSON file:

    files = [ "account.json", "..." ]

    for (var i=0; i", result);

    // 4. Now to register the formats. Load and validate formats/formats.json:

    try {

        stringData = readFile("formats/formats.json");

        data = JSON.parse(stringData);

    } catch (err) {

        // handle the error

    }

    // 5. For each item in the data, make the Regex and register it with your validator:

    for (item in data.keys()) {

        rgx = new RegExp(data[item]);

        YourValidator.addFormat(item, rgx);

    }

    // 6. Now you can validate stuff!

    function validateAs(obj, id) {

        schema = { "$ref": "tcapi:#" + id };

        YourValidator.validate(obj, schema);

    }