oceanum-js

@oceanum/datamesh


@oceanum/datamesh / index / Notice

Interface: Notice

Defined in: packages/datamesh/src/lib/notices.ts:15

A published, unexpired oceanum.io notice about a datasource, as returned by Connector.getNotices.

Properties

body

body: string

Defined in: packages/datamesh/src/lib/notices.ts:25

Notice body in markdown. Render it safely: never as raw HTML.


expires_at

expires_at: string | null

Defined in: packages/datamesh/src/lib/notices.ts:29

ISO 8601 time the notice expires, or null if it does not expire.


id

id: string

Defined in: packages/datamesh/src/lib/notices.ts:17

Notice ID (a UUID).


publish_at

publish_at: string

Defined in: packages/datamesh/src/lib/notices.ts:27

ISO 8601 time the notice was published.


severity

severity: NoticeSeverity

Defined in: packages/datamesh/src/lib/notices.ts:21

Notice severity.


title

title: string

Defined in: packages/datamesh/src/lib/notices.ts:23

Short title.


type

type: "datasource"

Defined in: packages/datamesh/src/lib/notices.ts:19

Kind of resource the notice is about: always “datasource” here.