Function OpenAPICodeSample

packages/react-openapi/src/OpenAPICodeSample.tsx:26–59

(props: {
    data: OpenAPIOperationData;
    context: OpenAPIContext;
})

 * It supports the Redocly custom syntax as well (https://redocly.com/docs/api-reference-docs/specification-extensions/x-code-samples/)
 */
export function OpenAPICodeSample(props: {
    data: OpenAPIOperationData;
    context: OpenAPIContext;
}) {
    const { data, context } = props;

    // If code samples are disabled at operation level, we don't display the code samples.
    if (data.operation['x-codeSamples'] === false) {
        return null;
    }

    const customCodeSamples = getCustomCodeSamples(props);

    // If code samples are disabled at the top-level and not custom code samples are defined,
    // we don't display the code samples.
    if (data['x-codeSamples'] === false && !customCodeSamples) {
        return null;
    }

    const samples = customCodeSamples ?? generateCodeSamples(props);

    if (samples.length === 0) {
        return null;
    }

    return (
        <OpenAPICodeSampleBody
            context={getOpenAPIClientContext(context)}
            data={data}
            items={samples}
            selectIcon={context.icons.chevronDown}
        />
    );
}

/**
 * Generate code samples for the operation.