Skip to main content

AdditionalInformation

@nevermined-io/sdk - v3.0.44 / AdditionalInformation

Interface: AdditionalInformation

Additional Information of Assets Metadata.

See

https://github.com/nevermined-io/docs/blob/master/docs/architecture/specs/metadata/README.md#additional-attributes

Table of contents​

Properties​

Properties​

categories​

• Optional categories: string[]

Categories used to describe this content. Empty by default.

Example

;['Economy', 'Data Science']

Defined in​

src/types/DDOTypes.ts:471

cipher​

• Optional cipher: string

Defined in​

src/types/DDOTypes.ts:505

copyrightHolder​

• Optional copyrightHolder: string

The party holding the legal copyright. Empty by default.

Example

'Met Office'

Defined in​

src/types/DDOTypes.ts:431

customData​

• Optional customData: Object

A dynamic field containing marketplace specific data. Can be used to store any non-default data, needs to be checked

Index signature​

▪ [key: string]: any

Defined in​

src/types/DDOTypes.ts:500

description​

• Optional description: string

Details of what the resource is. For a dataset, this attribute explains what the data represents and what it can be used for.

Example

'Weather information of UK including temperature and humidity'

Defined in​

src/types/DDOTypes.ts:425

inLanguage​

• Optional inLanguage: string

The language of the content. Please use one of the language codes from the IETF BCP 47 standard.

Example

'en'

Defined in​

src/types/DDOTypes.ts:465

• Optional links: { [name: string]: string; }[]

Mapping of links for data samples, or links to find out more information. Links may be to either a URL or another Asset. We expect marketplaces to converge on agreements of typical formats for linked data: Nevermined itself does not mandate any specific formats as these requirements are likely to be domain-specific.

Example

;[
  {
    anotherSample:
      'http://data.ceda.ac.uk/badc/ukcp09/data/gridded-land-obs/gridded-land-obs-daily/',
  },
  {
    fieldsDescription: 'http://data.ceda.ac.uk/badc/ukcp09/',
  },
]

Defined in​

src/types/DDOTypes.ts:458

poseidonHash​

• Optional poseidonHash: string

Defined in​

src/types/DDOTypes.ts:504

priceHighestDenomination​

• Optional priceHighestDenomination: number

Price store in the highest denomination and stored as a number on elastic search

Remarks

We currently do this because elasticsearch does not support BigNumbers

Defined in​

src/types/DDOTypes.ts:525

providerKey​

• Optional providerKey: Object

Type declaration​

NameType
xstring
ystring

Defined in​

src/types/DDOTypes.ts:507

secretId​

• Optional secretId: Object

Type declaration​

NameType
xstring
ystring

Defined in​

src/types/DDOTypes.ts:512

structuredMarkup​

• Optional structuredMarkup: { mediaType: string ; uri: string }[]

A link to machine-readable structured markup (such as ttl/json-ld/rdf) describing the dataset.

Defined in​

src/types/DDOTypes.ts:491

tags​

• Optional tags: string[]

Keywords or tags used to describe this content. Empty by default.

Example

;['weather', 'uk', '2011', 'temperature', 'humidity']

Defined in​

src/types/DDOTypes.ts:477

updateFrequency​

• Optional updateFrequency: string

An indication of update latency - i.e. How often are updates expected (seldom, annually, quarterly, etc.), or is the resource static that is never expected to get updated.

Example

'yearly'

Defined in​

src/types/DDOTypes.ts:485

workExample​

• Optional workExample: string

Example of the concept of this asset. This example is part of the metadata, not an external link.

Example

'423432fsd,51.509865,-0.118092,2011-01-01T10:55:11+00:00,7.2,68'

Defined in​

src/types/DDOTypes.ts:438