Bundle

Validate against: http://json-schema.org/draft-07/schema#

Schema ID: http://schemas.digitallinguistics.io/Bundle-3.2.0.json

Type: object

Description

A bundle is a collection of related resources and derivative products. For example, many field linguists will put all the data from a single day or elicitation session in one bundle, as well as any transcriptions and pedagogical outputs derived from that session. Bundles are purely organizational objects containing references to the included items.

Developer Notes

This is a top-level database object

Required Properties

  • name

Properties

The following properties are defined for this object:

  • Type: type

    Type: string

    Read-only: true

    Description

    The type of object. Must be set to Bundle.

    This item must have the following value:

    "Bundle"
  • ID: id

    Description

    A unique database identifier for this Bundle

  • Abbreviation: abbreviation

    Type: string

    Description

    An abbreviation for this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Abbreviation.json

  • Access Rights: access

    Type: object

    Description

    An object describing the acess rights for this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Access.json

  • Date Created: dateCreated

    Type: string

    Description

    The date and optionally time that this bundle was created

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • Date Modified: dateModified

    Type: string

    Description

    The date and optionally time that this bundle was last modified

    This item must also validate against exactly one of the following schemas:

    • Format: date

    • Format: date-time

  • Link: link

    Type: string

    Description

    A URL where a presentational format for this resource may be viewed

    Format: uri

  • Locations: locations

    Type: array

    Description

    An array of database references to locations included in this bundle (usually locations that were visited during a day or session)

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Location (Database Reference): locations

    Type: object

    Description

    A database reference pointing to a location associated with this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • Media: media

    Type: array

    Description

    An array of media files included in this bundle

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Media File (Database Reference): media

    Type: object

    Description

    A database reference that points to an object describing a media file in this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • Name: name

    Description

    A name for this bundle, optionally in multiple languages. There must be a name in at least one language.

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/MultiLangString.json

  • Notes: notes

    Type: array

    Description

    A collection of notes about this bundle

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Note: notes

    Type: object

    Description

    A note about this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Note.json

  • People: people

    Type: array

    Description

    An array of people associated with this bundle

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Person (Database Reference): people

    Type: object

    Description

    A database reference that points to a person associated with this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • Tags: tags

    Type: object

    Description

    A hash containing tags for this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/Tags.json

  • Texts: texts

    Type: array

    Description

    An array of texts included in this bundle.

    Items must be unique: true

    Items

    Each item in this array must adhere to the following schema:

    Text (Database Reference): texts

    Type: object

    Description

    A database reference that points to a text included in this bundle

    Referenced Schema

    This item must validate against the following schema:

    http://schemas.digitallinguistics.io/DatabaseReference.json

  • URL: url

    Type: string

    Description

    The URL where this bundle may be accessed

    Format: uri

Additional Properties

Any additional properties must adhere to the following schema:

This schema imposes no restrictions. All values are valid.

Examples

The following are example values for this schema:

  • {
      "abbreviation": "Day1",
      "access": {
        "ELAR": "Researcher"
      },
      "dateCreated": "2018-10-13T15:48:11.496Z",
      "dateModified": "2018-10-13T15:54:23.382Z",
      "id": "aea46597-be32-48bb-9cb5-862c4f0a2081",
      "link": "https://data.digitallinguistics.io/bundles/Day1",
      "locations": [
        {
          "key": "Kisii"
        },
        {
          "key": "KennedyFarm"
        }
      ],
      "media": [
        {
          "key": "Helen1"
        },
        {
          "key": "Helen2"
        }
      ],
      "name": "Gusii Recording Day 1",
      "notes": [
        {
          "text": "Texts recorded during the first day of recording in Kisii Town and Kennedy's farm."
        }
      ],
      "people": [
        {
          "key": "HM",
          "name": "Helen Makana"
        }
      ],
      "tags": {
        "analyze": true
      },
      "texts": [
        {
          "key": "Omoiseke",
          "name": "Ómoíséké ósokérété chíséese"
        },
        {
          "key": "Okando",
          "name": "Ókandó n'Ókanyang'aú"
        }
      ],
      "type": "Bundle",
      "url": "https://api.digitallinguistics.io/bundles/Day1"
    }
  • {
      "abbreviation": "Lexicon1",
      "access": {
        "AILLA": "public access"
      },
      "dateCreated": "2018-10-13T15:54:12.484Z",
      "dateModified": "2018-10-13T15:54:48.916Z",
      "id": "cd79381a-6a44-4c9a-a8c1-d33186c6d839",
      "link": "https://data.digitallinguistics.io/bundles/Lexicon1",
      "locations": [
        {
          "key": "Charenton"
        }
      ],
      "media": [
        {
          "key": "qasi1"
        },
        {
          "key": "qasi2"
        },
        {
          "key": "kici"
        }
      ],
      "name": {
        "eng": "Lexicon Recording Day 1"
      },
      "notes": [
        {
          "text": "First day of recording for the dictionary project."
        }
      ],
      "people": [
        {
          "key": "JMS",
          "name": "John M. Smith"
        },
        {
          "key": "CB",
          "name": "Chris Baker"
        }
      ],
      "tags": {
        "lexicon": true
      },
      "type": "Bundle",
      "url": "https://api.digitallinguistics.io/bundles/Lexicon1"
    }