@furystack/rest
Version:
Generic REST package
20 lines • 828 B
TypeScript
import type { OpenApiDocument } from './openapi-document.js';
/**
* Resolves all internal `$ref` pointers in an OpenAPI document, inlining the referenced objects.
*
* Only internal references (`#/...`) are supported. External file references are left as-is.
* Circular references are broken by substituting an empty object `{}`.
*
* @param doc - The OpenAPI document with `$ref` pointers
* @returns A new OpenAPI document with all internal `$ref` pointers resolved
*
* @example
* ```typescript
* import { resolveOpenApiRefs } from '@furystack/rest'
*
* const resolved = resolveOpenApiRefs(myOpenApiDoc)
* // All $ref pointers have been replaced with the actual schemas
* ```
*/
export declare const resolveOpenApiRefs: (doc: OpenApiDocument) => OpenApiDocument;
//# sourceMappingURL=openapi-resolve-refs.d.ts.map