TextAPI

Schemas

Agent

roles

string[] · minItems: 1 · required

The role of an entity in relation to the parent object

name

string · required

The principal name of the entity

Internal identifier

Authoritative identifier of the enitity

Asset

assetType

string · enum · required

one of font or css

Enum values:

font

css

contentType

string · required

the MIME type for the resource

id

string · uri · minLength: 1 · maxLength: 2083 · required

URL pointing to the resource

type

string

Default: TextApiAsset

information on data integrity

Content

id

string · required

URL pointing to the content

contentType

string · pattern: ^(application|audio|… · required

a MIME type. If several Content Objects with the same MIME type are provided, these SHOULD be distinguished with a MIME type parameter where the key is type and the value can be freely chosen, e.g. text/html;type=transcription.

information on data integrity

ErrorMessage

An Error message.

detail

string · required

HTTPValidationError

object[]

Image

An image representing the source or its provider. It is recommended that a IIIF Image API service is available for this image for manipulations such as resizing.

id

string · uri · minLength: 1 · maxLength: 2083 · required

URL pointing to the image.

license

string · required

The license applied to the image as SPDX license expression.

Default: TextApiImage

URL pointing to the image’s manifest object.

A copyright statement.

InputItem

An Item object as posted by the user on create.

textItemType

required

languages

string[] · required

Languages present in this item as ISO 639-3 language codes

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

IRI of the previous revision of this item

The title(s) of the item

The division label for this item

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni)

A short description of the item

Image(s) representing the item

IRI pointing to an Annotation Collection for this item

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s)

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object

InputManifest

A Manifest object as posted by the user on create.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

If created from an existing collection, save its previous id to via.

IRI pointing to this manifest

Default: TextApiManifest

The revision of this Item Object

Total number of items in items

Default: 0

Items belonging to this manifest

Integrity

Contains information regarding data integrity (checksum) of the referenced resources.

algorithm

string · minLength: 1 · required

Algorithm to calculate checksum (e.g. MD5, SHA-256)

checksum

string · minLength: 1 · required

The checksum

Item

Item output class.

textItemType

required

languages

string[] · required

Languages present in this item as ISO 639-3 language codes

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

IRI of the previous revision of this item

The title(s) of the item

The division label for this item

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni)

A short description of the item

Image(s) representing the item

IRI pointing to an Annotation Collection for this item

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s)

type

string

Default: TextApiItem

Manifest

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

If created from an existing collection, save its previous id to via.

type

string

Default: TextApiManifest

Items belonging to this manifest

Repository

id

string · uri · minLength: 1 · maxLength: 2083 · required

URL pointing to the website of the institution

required

the identifier at the hosting institution

the label as given by the hosting institution

type

string

Default: TextApiRepository

the country in which the repository is located

the name of a settlement, e.g. city or village, in which the repository in focus is located

TextApiCollection

A collection contains a curated list of texts.

titles

string[] · minItems: 1 · required

The title(s) of the collection. First item im array is the main title.

object[] · required

Personal entities responsible for the collection

required

textapi

string · pattern: ^(0|[1-9]\d*)\.(0|[1… · required

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

created

string · required

The time this Collection Object was created

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this collection

type

string · required

MUST be TextApiCollection.

total

integer · min: 0 · required

Total number of collection or manifests or collections included in this collection

revision

string · required

The revision of this Collection Object

Personal entities responsible for the edition

an entity responsible for funding the project in which the text(s) in focus is/are edited

IRI(s) / ID(s) of holding collection(s)

Human readable description of the collection

IRI pointing to an Annotation Collection for the complete collection

If created from an existing collection, save its previous id to via.

previous revision of this collection (slug)

A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.

A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.

TextApiInputCollection

A collection object as posted by the user on create.

titles

string[] · minItems: 1 · required

The title(s) of the collection. First item im array is the main title.

object[] · required

Personal entities responsible for the collection

Personal entities responsible for the edition

an entity responsible for funding the project in which the text(s) in focus is/are edited

IRI(s) / ID(s) of holding collection(s)

Human readable description of the collection

IRI pointing to an Annotation Collection for the complete collection

If created from an existing collection, save its previous id to via.

previous revision of this collection (slug)

Default: https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

Default: 2.0.0

IRI pointing to this collection

The revision of this Collection Object

Default: TextApiCollection

Total number of collection or manifests or collections included in this collection

Default: 0

A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.

A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.

TypeEnum

string · enum

Enum values:

font

css

ValidationError

array · required

msg

string · required

type

string · required

TextAPI

Schemas

Agent

roles

string[] · minItems: 1 · required

The role of an entity in relation to the parent object

name

string · required

The principal name of the entity

Internal identifier

Authoritative identifier of the enitity

Asset

assetType

string · enum · required

one of font or css

Enum values:

font

css

contentType

string · required

the MIME type for the resource

id

string · uri · minLength: 1 · maxLength: 2083 · required

URL pointing to the resource

type

string

Default: TextApiAsset

information on data integrity

Content

id

string · required

URL pointing to the content

contentType

string · pattern: ^(application|audio|… · required

information on data integrity

ErrorMessage

An Error message.

detail

string · required

HTTPValidationError

object[]

Image

An image representing the source or its provider. It is recommended that a IIIF Image API service is available for this image for manipulations such as resizing.

id

string · uri · minLength: 1 · maxLength: 2083 · required

URL pointing to the image.

license

string · required

The license applied to the image as SPDX license expression.

Default: TextApiImage

URL pointing to the image’s manifest object.

A copyright statement.

InputItem

An Item object as posted by the user on create.

textItemType

required

languages

string[] · required

Languages present in this item as ISO 639-3 language codes

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

IRI of the previous revision of this item

The title(s) of the item

The division label for this item

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni)

A short description of the item

Image(s) representing the item

IRI pointing to an Annotation Collection for this item

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s)

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object

InputManifest

A Manifest object as posted by the user on create.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

If created from an existing collection, save its previous id to via.

IRI pointing to this manifest

Default: TextApiManifest

The revision of this Item Object

Total number of items in items

Default: 0

Items belonging to this manifest

Integrity

Contains information regarding data integrity (checksum) of the referenced resources.

algorithm

string · minLength: 1 · required

Algorithm to calculate checksum (e.g. MD5, SHA-256)

checksum

string · minLength: 1 · required

The checksum

Item

Item output class.

textItemType

required

languages

string[] · required

Languages present in this item as ISO 639-3 language codes

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

object[] · required

Different serializations of the item, e.g. HTML, plain text, XML.

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this item

revision

string · required

The revision of this Item Object

IRI of the previous revision of this item

The title(s) of the item

The division label for this item

Alternative language name or code (when there is no ISO 639-3 code available, e.g. karshuni)

A short description of the item

Image(s) representing the item

IRI pointing to an Annotation Collection for this item

If created from an existing collection, save its previous id to via.

IRI(s) / ID(s) of holding manifest(s)

type

string

Default: TextApiItem

Manifest

This is the main object in the schema to represent a single text, its derivatives (e.g. HTML) and therefore contains the text's metadata.

label

string · required

Human-readable name or title

license

string · required

The license applied to the manifest as SPDX license expression.

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this manifest

revision

string · required

The current revision of this manifest, e.g. a hash, date, etc.

total

integer · min: 0 · required

Total number of items in items

Personal entities involved in or related to this manifest.

IRI pointing to an Annotation Collection for the complete manifest.

Additional files necessary for rendering the manifest correctly in some client.

A short description of the object

An image representing the resources (e.g. thumbnail or logo)

IRI(s) / ID(s) of holding collection(s)

IRI of the preceding revision of this manifest

Information about the holding repository

the origin of the manuscript. MAY also comprise full provenence information.

the identifier of the manuscript, e.g. a shelfmark

a term classifying the text’s genre(s) or category/categories, preferably taken from a controlled vocabulary

If created from an existing collection, save its previous id to via.

type

string

Default: TextApiManifest

Items belonging to this manifest

Repository

id

string · uri · minLength: 1 · maxLength: 2083 · required

URL pointing to the website of the institution

required

the identifier at the hosting institution

the label as given by the hosting institution

type

string

Default: TextApiRepository

the country in which the repository is located

the name of a settlement, e.g. city or village, in which the repository in focus is located

TextApiCollection

A collection contains a curated list of texts.

titles

string[] · minItems: 1 · required

The title(s) of the collection. First item im array is the main title.

object[] · required

Personal entities responsible for the collection

required

textapi

string · pattern: ^(0|[1-9]\d*)\.(0|[1… · required

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

created

string · required

The time this Collection Object was created

id

string · uri · minLength: 1 · maxLength: 2083 · required

IRI pointing to this collection

type

string · required

MUST be TextApiCollection.

total

integer · min: 0 · required

Total number of collection or manifests or collections included in this collection

revision

string · required

The revision of this Collection Object

Personal entities responsible for the edition

an entity responsible for funding the project in which the text(s) in focus is/are edited

IRI(s) / ID(s) of holding collection(s)

Human readable description of the collection

IRI pointing to an Annotation Collection for the complete collection

If created from an existing collection, save its previous id to via.

previous revision of this collection (slug)

A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.

A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.

TextApiInputCollection

A collection object as posted by the user on create.

titles

string[] · minItems: 1 · required

The title(s) of the collection. First item im array is the main title.

object[] · required

Personal entities responsible for the collection

Personal entities responsible for the edition

an entity responsible for funding the project in which the text(s) in focus is/are edited

IRI(s) / ID(s) of holding collection(s)

Human readable description of the collection

IRI pointing to an Annotation Collection for the complete collection

If created from an existing collection, save its previous id to via.

previous revision of this collection (slug)

Default: https://gitlab.gwdg.de/subugoe/textapi/specs/-/raw/main/jsonld/v2.jsonld

The TextAPI version covered by the implementation. MUST be at least 2.0.0.

Default: 2.0.0

IRI pointing to this collection

The revision of this Collection Object

Default: TextApiCollection

Total number of collection or manifests or collections included in this collection

Default: 0

A set of collections included in this collection. If collections is set, the holding collection MUST NOT contain manifests.

A set of manifests included in this collection. If manifests is set, the holding collection MUST NOT contain collections.

TypeEnum

string · enum

Enum values:

font

css

ValidationError

array · required

msg

string · required

type

string · required