signalk-server
Version:
An implementation of a [Signal K](http://signalk.org) server for boats.
64 lines • 3.09 kB
TypeScript
export declare const notificationsAsyncApiDoc: {
asyncapi: string;
info: {
title: string;
version: string;
description: string;
license: {
name: string;
url: string;
};
};
servers: {
signalk: {
host: string;
protocol: string;
description: string;
pathname: string;
};
};
channels: {
notifications: {
address: string;
description: string;
messages: {
notification: {
name: string;
title: string;
summary: string;
contentType: string;
payload: import("@sinclair/typebox").TObject<{
state: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"nominal">, import("@sinclair/typebox").TLiteral<"normal">, import("@sinclair/typebox").TLiteral<"alert">, import("@sinclair/typebox").TLiteral<"warn">, import("@sinclair/typebox").TLiteral<"alarm">, import("@sinclair/typebox").TLiteral<"emergency">]>;
method: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"visual">, import("@sinclair/typebox").TLiteral<"sound">]>>;
message: import("@sinclair/typebox").TString;
status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
silenced: import("@sinclair/typebox").TBoolean;
acknowledged: import("@sinclair/typebox").TBoolean;
canSilence: import("@sinclair/typebox").TBoolean;
canAcknowledge: import("@sinclair/typebox").TBoolean;
canClear: import("@sinclair/typebox").TBoolean;
}>>;
id: import("@sinclair/typebox").TString;
position: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
latitude: import("@sinclair/typebox").TNumber;
longitude: import("@sinclair/typebox").TNumber;
altitude: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
}>, import("@sinclair/typebox").TNull]>>;
createdAt: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
data: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>>;
}>;
};
};
};
};
operations: {
receiveNotification: {
action: string;
channel: {
$ref: string;
};
summary: string;
};
};
};
//# sourceMappingURL=asyncApi.d.ts.map