@stackql/provider-utils/src/docgen/resource-content.js

Utilities for building StackQL providers from OpenAPI specifications.

// src/docgen/resource-content.js

import { createOverviewSection } from './resource/overview.js';
import { createFieldsSection } from './resource/fields.js';
import { createMethodsSection } from './resource/methods.js';
import { createParamsSection } from './resource/parameters.js';
import { createExamplesSection } from './resource/examples.js';
 
export async function createResourceIndexContent(
    providerName, 
    serviceName, 
    resourceName, 
    resourceData, 
    dereferencedAPI,
) {
    // Generate each section of the documentation
    const overviewContent = createOverviewSection(resourceName, providerName, serviceName);
    const fieldsContent = createFieldsSection(resourceData, dereferencedAPI);
    const methodsContent = createMethodsSection(resourceData, dereferencedAPI);
    const paramsContent = createParamsSection(resourceData, dereferencedAPI);
    const examplesContent = createExamplesSection(providerName, serviceName, resourceName, resourceData, dereferencedAPI);

    // Combine all sections into the final content
    return `${overviewContent}${fieldsContent}${methodsContent}${paramsContent}${examplesContent}`;
}