dino-express/dist/openapi/filesystem.descriptor.provider.d.ts

DinO enabled REST framework based on express

import { type EnvironmentConfiguration } from 'dino-core';
import { DescriptorProvider } from './descriptor.provider';
/**
 * File system OpenAPI descriptor provider.
 * @typedef FilesystemDescriptorProvider
 */
export declare class FilesystemDescriptorProvider extends DescriptorProvider {
    private readonly environment;
    constructor(environment: EnvironmentConfiguration);
    /**
     * Provide a reference to an OpenAPI descriptor stored on the local file-system, the location
     * of the descriptor can be provided using any of the `dino:openapi:descriptor`,
     * `dino_openapi_descriptor` or `DINO_OPENAPI_DESCRIPTOR` configuration variables,
     * if the configuration is not provided the default `src/main/resources/routes.yml` path will
     * be used.
     * @returns {string} the path of the OpenAPI descriptor file.
     */
    provide(): Promise<string>;
}