@furystack/rest-service
Version:
Repository implementation for FuryStack
14 lines • 834 B
TypeScript
import { type ApiEndpointDefinition, type SwaggerDocument } from '@furystack/rest';
import type { RestApiImplementation } from '../api-manager.js';
import { type RequestAction } from '../request-action-implementation.js';
export type GetSchemaResult = Record<string, ApiEndpointDefinition>;
/**
* Generates a RequestAction that retrieves the Swagger JSON schema from a FuryStack API implementation.
*
* @param api - The API implementation from which to extract the schema.
* @returns A RequestAction that handles the GET request for the schema.
*/
export declare const CreateGetSwaggerJsonAction: <T extends RestApiImplementation<any>>(api: T, name?: string, description?: string, version?: string) => RequestAction<{
result: GetSchemaResult | SwaggerDocument;
}>;
//# sourceMappingURL=create-get-swagger-json-action.d.ts.map