@getanthill/datastore/dist/api/spec/components/index.d.ts

Event-Sourced Datastore

declare const components: {
    securitySchemes: {
        apiKey: {
            description: string;
            type: string;
            in: string;
            name: string;
        };
    };
    schemas: {
        error: {
            type: string;
            required: string[];
            properties: {
                status: {
                    type: string;
                    example: number;
                    description: string;
                };
                message: {
                    type: string;
                    example: string;
                    description: string;
                };
            };
        };
        object_id: {
            type: string;
            pattern: string;
            description: string;
            example: string;
        };
        'service-id': {
            type: string;
            description: string;
            example: string;
            minLength: number;
        };
        'request-id': {
            type: string;
            description: string;
            example: string;
        };
        page: {
            type: string;
            default: number;
            description: string;
        };
        page_size: {
            type: string;
            default: number;
            description: string;
        };
    };
    parameters: {
        page: {
            name: string;
            in: string;
            schema: {
                $ref: string;
            };
        };
        page_size: {
            name: string;
            in: string;
            schema: {
                $ref: string;
            };
        };
    };
    requestBodies: {};
    headers: {
        'pagination-count': {
            description: string;
            schema: {
                type: string;
            };
        };
        'pagination-page': {
            description: string;
            schema: {
                type: string;
                minimum: number;
                default: number;
            };
        };
        'pagination-size': {
            description: string;
            schema: {
                type: string;
                minimum: number;
                maximum: number;
                default: number;
            };
        };
        'request-id': {
            description: string;
            schema: {
                $ref: string;
            };
        };
        'service-id': {
            description: string;
            schema: {
                $ref: string;
            };
        };
    };
    examples: {};
    links: {};
    responses: {
        default: {
            description: string;
            content: {
                'application/json': {
                    example: {
                        status: number;
                        message: string;
                    };
                    schema: {
                        $ref: string;
                    };
                };
            };
        };
        400: {
            description: string;
            content: {
                'application/json': {
                    example: {
                        status: number;
                        message: string;
                    };
                    schema: {
                        $ref: string;
                    };
                };
            };
        };
        404: {
            description: string;
            content: {
                'application/json': {
                    example: {
                        status: number;
                        message: string;
                    };
                    schema: {
                        $ref: string;
                    };
                };
            };
        };
        409: {
            description: string;
            content: {
                'application/json': {
                    example: {
                        status: number;
                        message: string;
                    };
                    schema: {
                        $ref: string;
                    };
                };
            };
        };
        422: {
            description: string;
            content: {
                'application/json': {
                    example: {
                        status: number;
                        message: string;
                    };
                    schema: {
                        $ref: string;
                    };
                };
            };
        };
    };
};
export default components;