lif.schema

/*
 * The LAPPS Interchange Format.
 *
 * LAPPS web service exchange JSON data conforming to the LAPPS Interchange Format (LIF).
 * Each LIF object consists of some metadata, a text, and an ordered list of views, where
 * a view is a collection of annotations and (optionally) some metadata.
 *
 * Version 1.1.0
 *
 * This file is maintained with changelog and versioning information in the repository at
 * https://github.com/lapps/schemata.
 *
 */

title "LAPPS Interchange Format"
description "The JSON-LD objects exchanged by LAPPS web services."
type object
additionalProperties false
properties {
	'$schema' { $ref '#/definitions/uri' }
	'@context' {
		oneOf([
			{
				type object
				additionalProperties true
			},
			{
				type string
				format 'uri'
			}
		])
	}
	'@vocab' {
		type string
		format 'uri'
	}
    text {
        type object
        properties {
            '@value' { type string }
            '@language' { type string }
        }
        required '@value'
        additionalProperties false
    }
    metadata { $ref '#/definitions/map' }
    views {
        type array
        items { $ref '#/definitions/view' }
    }
}
required '$schema', 'text'

/*
 * Definitions of the object referenced above.
 */
definitions {
	// A string value formatted as a URI.
	uri {
		type string
		format 'uri'
	}
	
    // A HashMap. Used to store metadata at various levels.
    map {
        type object
        additionalProperties true
    }
    
    // A View contains an id, a list of annotations, and possibly 
    // some metadata.
    view {
		type object
		properties {
			id { type string }
			metadata { $ref '#/definitions/map' }
			annotations { $ref '#/definitions/annotations' }
		}
		additionalProperties false
		required 'id', 'annotations'
    }
    
    // An array of annotations.
    annotations {
        type array
        items { $ref '#/definitions/annotation' }
    }
    
    // A single annotation.
    annotation {
    	type object
    	properties {
			id { type string }
			'@type' { type string }
			label { type string }
			start { 
				type integer 
				minimum(-1) 
			}
			end { type integer; minimum(-1) }
			features { $ref '#/definitions/map' }
			metadata { $ref '#/definitions/map' }
		}
        required 'id', '@type'
        additionalProperties false
    }
}