@open-rpc/specification-extension-spec/dist/cjs/src/index.d.cts

OpenRPC Specification Extension Schema

import metaSchema from "./meta-schema.json";
declare const examples: {
    errorGroups: {
        openrpcExtension: string;
        name: string;
        version: string;
        description: string;
        summary: string;
        externalDocumentation: {
            description: string;
            url: string;
        };
        restricted: string[];
        schema: {
            type: string;
            items: {
                type: string;
                items: {
                    type: string;
                    properties: {
                        code: {
                            type: string;
                            description: string;
                        };
                        message: {
                            type: string;
                            description: string;
                        };
                        data: {
                            type: string;
                            description: string;
                        };
                    };
                    required: string[];
                };
            };
        };
    };
    notification: {
        $schema: string;
        openrpcExtension: string;
        name: string;
        version: string;
        description: string;
        summary: string;
        externalDocumentation: {
            description: string;
            url: string;
        };
        restricted: string[];
        schema: {
            type: string;
            description: string;
        };
    };
    transport: {
        $schema: string;
        openrpcExtension: string;
        name: string;
        version: string;
        description: string;
        summary: string;
        externalDocumentation: {
            description: string;
            url: string;
        };
        required: boolean;
        restricted: string[];
        schema: {
            oneOf: ({
                type: string;
                title: string;
                description: string;
                required: string[];
                properties: {
                    name: {
                        type: string;
                        const: string;
                    };
                    options: {
                        type: string;
                        properties: {
                            headers: {
                                patternProperties: {
                                    "": {
                                        type: string;
                                    };
                                };
                            };
                            credentials: {
                                type: string;
                                enum: string[];
                            };
                            top?: undefined;
                            left?: undefined;
                            height?: undefined;
                            width?: undefined;
                        };
                    };
                };
                examples: {
                    "x-transport": {
                        name: string;
                        options: {
                            headers: {
                                Bearer: string;
                            };
                        };
                    };
                }[];
            } | {
                type: string;
                title: string;
                description: string;
                required: string[];
                properties: {
                    name: {
                        type: string;
                        const: string;
                    };
                    options: {
                        type: string;
                        properties: {
                            top: {
                                type: string;
                                title: string;
                                description: string;
                            };
                            left: {
                                type: string;
                                title: string;
                                description: string;
                            };
                            height: {
                                type: string;
                                title: string;
                                description: string;
                            };
                            width: {
                                type: string;
                                title: string;
                                description: string;
                            };
                            headers?: undefined;
                            credentials?: undefined;
                        };
                    };
                };
                examples?: undefined;
            })[];
        };
    };
};
export { metaSchema, examples };
//# sourceMappingURL=index.d.cts.map