@appsemble/utils/api/index.d.ts

Utility functions used in Appsemble internally

import { type OpenAPIV3 } from 'openapi-types';
export * as schemas from './components/schemas/index.js';
interface APIParams {
    /**
     * The port on which the server runs.
     */
    port?: number;
    /**
     * The host on which the server is exposed.
     */
    host?: string;
    /**
     * Whether or not the API is served using SSL.
     */
    ssl?: boolean;
}
/**
 * Get the OpenAPI document for the Appsemble REST API.
 *
 * @param version The Appsemble version
 * @param argv The parsed command line arguments.
 * @returns The OpenAPI document for Appsemble.
 */
export declare function api(version: string, { port, ssl, host }?: APIParams): OpenAPIV3.Document;