@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, 
    resource,
) {
    // Generate each section of the documentation
    const overviewContent = createOverviewSection(resource.name, resource.type, resource.description, providerName, serviceName);
    const fieldsContent = createFieldsSection(resource.type, resource.resourceData, resource.dereferencedAPI);
    const methodsContent = resource.type === 'Resource' ? createMethodsSection(resource.resourceData, resource.dereferencedAPI) : '';
    const paramsContent = resource.type === 'Resource' ? createParamsSection(resource.resourceData, resource.dereferencedAPI) : '';
    const examplesContent = resource.type === 'Resource' ? createExamplesSection(providerName, serviceName, resource.name, resource.resourceData, resource.dereferencedAPI) : '';

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