signalk-server/dist/api/resources/asyncApi.d.ts

An implementation of a [Signal K](http://signalk.org) server for boats.

export declare const resourcesAsyncApiDoc: {
    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: {
        'resources.routes': {
            address: string;
            description: string;
            messages: {
                route: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        feature: import("@sinclair/typebox").TObject<{
                            type: import("@sinclair/typebox").TLiteral<"Feature">;
                            geometry: import("@sinclair/typebox").TObject<{
                                type: import("@sinclair/typebox").TLiteral<"LineString">;
                                coordinates: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>>;
                            }>;
                        }>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
        'resources.waypoints': {
            address: string;
            description: string;
            messages: {
                waypoint: {
                    name: string;
                    title: string;
                    summary: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        feature: import("@sinclair/typebox").TObject<{
                            type: import("@sinclair/typebox").TLiteral<"Feature">;
                            geometry: import("@sinclair/typebox").TObject<{
                                type: import("@sinclair/typebox").TLiteral<"Point">;
                                coordinates: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>;
                            }>;
                        }>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
        'resources.notes': {
            address: string;
            description: string;
            messages: {
                note: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        title: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        url: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                        mimeType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
        'resources.regions': {
            address: string;
            description: string;
            messages: {
                region: {
                    name: string;
                    title: string;
                    contentType: string;
                    payload: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TObject<{
                        feature: import("@sinclair/typebox").TObject<{
                            type: import("@sinclair/typebox").TLiteral<"Feature">;
                            geometry: import("@sinclair/typebox").TObject<{
                                type: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TLiteral<"Polygon">, import("@sinclair/typebox").TLiteral<"MultiPolygon">]>;
                            }>;
                        }>;
                    }>, import("@sinclair/typebox").TNull]>;
                };
            };
        };
    };
    operations: {
        receiveRouteChange: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
        receiveWaypointChange: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
        receiveNoteChange: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
        receiveRegionChange: {
            action: string;
            channel: {
                $ref: string;
            };
            summary: string;
        };
    };
};
//# sourceMappingURL=asyncApi.d.ts.map