Schemas

Download schema

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.

textapiType

string · const

MUST be TextApiAgent.

Const value: TextApiAgent

Default: TextApiAgent

Asset

Metadata about an external asset used by the text resource.

contentType

string · required

The MIME type for the resource.

id

string · uri · required

URL pointing to the resource.

textapiType

string · const

Const value: TextApiAsset

Default: TextApiAsset

Information on data integrity.

Content

A content representation associated with a TextAPI item.

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

ValidationError[]

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 · required

URL pointing to the image or, in case of IIIF, to an info.json document.

required

The expected mimetype of the resource at id. Most likely either starting with image/ or, in case of IIIF, application/ld+json;profile="http://iiif.io/api/image/3/context.json".

license

string · required

The license applied to the image as SPDX license expression.

A copyright statement.

InputItem

An Item object as posted by the user on create.

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · 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).

Default: https://editions.sub.uni-goettingen.de/context.json

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

Default: 2.0.0

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object.

The time this Item Object was created

The time this Item Object was modified

InputManifest

A Manifest object as posted by the user on create.

titles

string[] · minItems: 1 · required

Human-readable name(s) or title(s).

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).

Additional information about the manifest.

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.

Default: https://editions.sub.uni-goettingen.de/context.json

The TextAPI version covered by the implementation

Default: 2.0.0

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.

The time this Manifest Object was created

The time this Manifest Object was modified

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

textapiType

string · const

MUST be TextApiIntegrity.

Const value: TextApiIntegrity

Default: TextApiIntegrity

Item

Item output class.

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

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

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

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).

textapiVersion

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

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

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.

titles

string[] · minItems: 1 · required

Human-readable name(s) or title(s).

license

string · required

The license applied to the manifest as SPDX license expression.

textapiVersion

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

The TextAPI version covered by the implementation

id

string · uri · 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.

created

string · required

The time this Manifest Object was created.

modified

string · required

The time this Manifest Object was modified.

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).

Additional information about the manifest.

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.

Default: https://editions.sub.uni-goettingen.de/context.json

textapiType

string · const

MUST be TextApiManifest.

Const value: TextApiManifest

Default: TextApiManifest

Items belonging to this manifest.

Metadata-Input

Metadata key-value information for a text resource.

key

string · required

a label for the metadata

required

the content of the metadata. Can either be a string or another Metadata object

textapiType

string

Default: TextApiMetadata

Metadata-Output

Metadata key-value information for a text resource.

key

string · required

a label for the metadata

required

the content of the metadata. Can either be a string or another Metadata object

textapiType

string

Default: TextApiMetadata

Repository

Metadata about the hosting institution of a text resource.

id

string · uri · required

URL pointing to the website of the institution.

required

The identifier at the hosting institution. SHOULD be an IRI pointing to the digital object or catalogue entry. Can be any other form of identification if an IRI is not available.

The label as given by the hosting institution.

textapiType

string · const

Const value: TextApiRepository

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 or other collections.

titles

string[] · minItems: 1 · required

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

Agent[] · required

Personal entities responsible for the collection

required

textapiVersion

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

modified

string · required

The time this Collection Object was modified.

id

string · uri · required

IRI pointing to this collection

textapiType

string · const · required

MUST be TextApiCollection.

Const value: TextApiCollection

total

integer · min: 0 · required

Total number of collections or manifests included in this collection

revision

string · required

The revision of this Collection Object

Personal entities responsible for the edition

Entities (e.g. organizations or individual persons) 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, hold its former ID

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 in the array is the main title

Agent[] · required

Personal entities responsible for the collection

Personal entities responsible for the edition

Entities (e.g. organizations or individual persons) 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, hold its former ID

Previous revision of this collection (slug)

Default: https://editions.sub.uni-goettingen.de/context.json

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 collections or manifests 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.

The time this Collection Object was created

The time this Collection Object was modified

TextItemType

string · enum

Enum values:

fragment

section

page

full

Supported item granularity types in TextAPI.

ValidationError

array · required

msg

string · required

type

string · required

input

ctx

object

TextAPI

Schemas

Download schema

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.

textapiType

string · const

MUST be TextApiAgent.

Const value: TextApiAgent

Default: TextApiAgent

Asset

Metadata about an external asset used by the text resource.

contentType

string · required

The MIME type for the resource.

id

string · uri · required

URL pointing to the resource.

textapiType

string · const

Const value: TextApiAsset

Default: TextApiAsset

Information on data integrity.

Content

A content representation associated with a TextAPI item.

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

ValidationError[]

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 · required

URL pointing to the image or, in case of IIIF, to an info.json document.

required

The expected mimetype of the resource at id. Most likely either starting with image/ or, in case of IIIF, application/ld+json;profile="http://iiif.io/api/image/3/context.json".

license

string · required

The license applied to the image as SPDX license expression.

A copyright statement.

InputItem

An Item object as posted by the user on create.

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · 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).

Default: https://editions.sub.uni-goettingen.de/context.json

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

Default: 2.0.0

IRI pointing to this item

Default: TextApiItem

The revision of this Item Object.

The time this Item Object was created

The time this Item Object was modified

InputManifest

A Manifest object as posted by the user on create.

titles

string[] · minItems: 1 · required

Human-readable name(s) or title(s).

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).

Additional information about the manifest.

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.

Default: https://editions.sub.uni-goettingen.de/context.json

The TextAPI version covered by the implementation

Default: 2.0.0

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.

The time this Manifest Object was created

The time this Manifest Object was modified

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

textapiType

string · const

MUST be TextApiIntegrity.

Const value: TextApiIntegrity

Default: TextApiIntegrity

Item

Item output class.

textItemType

TextItemType · enum · required

The type of this item

Enum values:

fragment

section

page

full

languages

string[] · required

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

Enum values:

aaa

aab

aac

aad

aae

aaf

aag

aah

Content[] · required

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

id

string · uri · required

IRI pointing to this item.

required

revision

string · required

The revision of this Item Object

created

string · required

The time this Item Object was created.

modified

string · required

The time this Item Object was modified.

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).

textapiVersion

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

The TextAPI version covered by the implementation.

Default: 2.0.0

textapiType

string · const

Const value: TextApiItem

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.

titles

string[] · minItems: 1 · required

Human-readable name(s) or title(s).

license

string · required

The license applied to the manifest as SPDX license expression.

textapiVersion

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

The TextAPI version covered by the implementation

id

string · uri · 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.

created

string · required

The time this Manifest Object was created.

modified

string · required

The time this Manifest Object was modified.

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).

Additional information about the manifest.

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.

Default: https://editions.sub.uni-goettingen.de/context.json

textapiType

string · const

MUST be TextApiManifest.

Const value: TextApiManifest

Default: TextApiManifest

Items belonging to this manifest.

Metadata-Input

Metadata key-value information for a text resource.

key

string · required

a label for the metadata

required

the content of the metadata. Can either be a string or another Metadata object

textapiType

string

Default: TextApiMetadata

Metadata-Output

Metadata key-value information for a text resource.

key

string · required

a label for the metadata

required

the content of the metadata. Can either be a string or another Metadata object

textapiType

string

Default: TextApiMetadata

Repository

Metadata about the hosting institution of a text resource.

id

string · uri · required

URL pointing to the website of the institution.

required

The identifier at the hosting institution. SHOULD be an IRI pointing to the digital object or catalogue entry. Can be any other form of identification if an IRI is not available.

The label as given by the hosting institution.

textapiType

string · const

Const value: TextApiRepository

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 or other collections.

titles

string[] · minItems: 1 · required

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

Agent[] · required

Personal entities responsible for the collection

required

textapiVersion

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

modified

string · required

The time this Collection Object was modified.

id

string · uri · required

IRI pointing to this collection

textapiType

string · const · required

MUST be TextApiCollection.

Const value: TextApiCollection

total

integer · min: 0 · required

Total number of collections or manifests included in this collection

revision

string · required

The revision of this Collection Object

Personal entities responsible for the edition

Entities (e.g. organizations or individual persons) 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, hold its former ID

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 in the array is the main title

Agent[] · required

Personal entities responsible for the collection

Personal entities responsible for the edition

Entities (e.g. organizations or individual persons) 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, hold its former ID

Previous revision of this collection (slug)

Default: https://editions.sub.uni-goettingen.de/context.json

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 collections or manifests 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.

The time this Collection Object was created

The time this Collection Object was modified

TextItemType

string · enum

Enum values:

fragment

section

page

full

Supported item granularity types in TextAPI.

ValidationError

array · required

msg

string · required

type

string · required

input

ctx

object