4.4 KiB
@oceanprotocol/lib / Exports / Metadata
Interface: Metadata
Table of contents
Properties
- additionalInformation
- algorithm
- author
- categories
- contentLanguage
- copyrightHolder
- created
- description
- license
- links
- name
- tags
- type
- updated
Properties
additionalInformation
• Optional additionalInformation: any
Stores additional information, this is customizable by publisher
Defined in
algorithm
• Optional algorithm: MetadataAlgorithm
Information about asset of type algorithm. Required for algorithm assets.
Defined in
author
• author: string
Name of the entity generating this data (e.g. Tfl, Disney Corp, etc.).
Defined in
categories
• Optional categories: string[]
Array of categories associated to the asset. Note: recommended to use tags instead of this.
Defined in
contentLanguage
• Optional contentLanguage: string
The language of the content. Use one of the language codes from the IETF BCP 47 standard
Defined in
copyrightHolder
• Optional copyrightHolder: string
The party holding the legal copyright. Empty by default.
Defined in
created
• created: string
Contains the date of publishing in ISO Date Time
Defined in
description
• description: string
Details of what the resource is.
Defined in
license
• license: string
Short name referencing the license of the asset. If it’s not specified, the following value will be added: “No License Specified”.
Defined in
links
• Optional links: string[]
Mapping of URL strings for data samples, or links to find out more information. Links may be to either a URL or another asset.
Defined in
name
• name: string
Descriptive name or title of the asset.
Defined in
tags
• Optional tags: string[]
Array of keywords or tags used to describe this content. Empty by default.
Defined in
type
• type: "dataset" | "algorithm"
Asset type. Includes "dataset" (e.g. csv file), "algorithm" (e.g. Python script). Each type needs a different subset of metadata attributes.
Defined in
updated
• updated: string
Contains the the date of last update in ISO Date Time