Function fetchOpenAPIFilesystem

packages/gitbook/src/lib/openapi/fetch.ts:27–54

(
    args: ResolveOpenAPIBlockArgs<AnyOpenAPIBlock>
)

 * Fetch OpenAPI block.
 */
export async function fetchOpenAPIFilesystem(
    args: ResolveOpenAPIBlockArgs<AnyOpenAPIBlock>
): Promise<FetchOpenAPIFilesystemResult> {
    const { context, block } = args;

    const ref = block.data.ref;
    const resolved = ref ? await resolveContentRef(ref, context) : null;

    if (!resolved) {
        return { filesystem: null, specUrl: null };
    }

    const result = await (() => {
        // If the reference is a new OpenAPI reference, we return it.
        if (ref.kind === 'openapi') {
            assert(resolved.openAPIFilesystem);
            return resolved.openAPIFilesystem;
        }
        // For legacy blocks ("swagger"), we need to fetch the file system.
        return fetchFilesystem(resolved.href, context.space.id);
    })();

    if ('error' in result) {
        throw new OpenAPIParseError(result.error.message, { code: result.error.code });
    }

    return { filesystem: result, specUrl: resolved.href };
}

/**
 * Fetch the filesystem from the URL.