Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp
1.2 KB
Raw Blame
// SPDX-License-Identifier: AGPL-3.0-or-later
import type {OpenAPIDocument} from '@fluxer/openapi/src/OpenAPITypes';
export type OpenAPIRouteScope = 'all' | 'admin' | 'public';
export type OpenAPISchemaTarget = 'draft-2020-12' | 'openapi-3.0';
export interface OpenAPIGeneratorOptions {
	readonly basePath: string;
	readonly title?: string;
	readonly version?: string;
	readonly description?: string;
	readonly serverUrl?: string;
	readonly routeScope?: OpenAPIRouteScope;
	readonly schemaTarget?: OpenAPISchemaTarget;
}
export interface SkippedRoute {
	readonly method: string;
	readonly path: string;
	readonly source: string;
	readonly reason: string;
}
export interface OpenAPIGenerationStats {
	readonly controllerCount: number;
	readonly routeCount: number;
	readonly operationCount: number;
	readonly skippedRouteCount: number;
	readonly skippedRoutes: ReadonlyArray<SkippedRoute>;
	readonly untemplatableRoutes: ReadonlyArray<SkippedRoute>;
	readonly registeredSchemaCount: number;
	readonly publishedSchemaCount: number;
	readonly tagCount: number;
}
export interface OpenAPIGenerationResult {
	readonly document: OpenAPIDocument;
	readonly stats: OpenAPIGenerationStats;
}