@scalar/api-client
Version:
the open source API testing client
23 lines • 1.19 kB
TypeScript
/**
* Converts a Postman collection JSON string to an OpenAPI specification document.
*
* This function transforms a Postman collection into a valid OpenAPI 3.1 document
* that can be used throughout the application. The convert function handles parsing
* and transformation internally.
*
* Returns null if the conversion fails due to invalid Postman collection structure
*/
export declare const getOpenApiFromPostman: (postmanJson: string) => (Omit<Omit<import("@scalar/openapi-types").OpenAPIV3.Document<{}>, "components" | "paths">, keyof {
[customExtension: `x-${string}`]: any;
[key: string]: any;
}> & {
openapi?: "3.1.0" | "3.1.1" | "3.1.2";
swagger?: never;
info?: import("@scalar/openapi-types").OpenAPIV3_1.InfoObject;
jsonSchemaDialect?: string;
servers?: import("@scalar/openapi-types").OpenAPIV3_1.ServerObject[];
} & Pick<import("@scalar/openapi-types").OpenAPIV3_1.PathsWebhooksComponents<{}>, "paths"> & Omit<Partial<import("@scalar/openapi-types").OpenAPIV3_1.PathsWebhooksComponents<{}>>, "paths"> & {
[customExtension: `x-${string}`]: any;
[key: string]: any;
}) | null;
//# sourceMappingURL=get-openapi-from-postman.d.ts.map