@gitbook/react-openapi 1.1.9 → 1.2.0

package/dist/OpenAPISpec.jsx

@@ -3,13 +3,15 @@ import { OpenAPIResponses } from './OpenAPIResponses';
 import { OpenAPISchemaProperties } from './OpenAPISchemaServer';
 import { OpenAPISecurities } from './OpenAPISecurities';
 import { StaticSection } from './StaticSection';
+import { tString } from './translate';
 import { parameterToProperty } from './utils';
 export function OpenAPISpec(props) {
     var _a;
     var data = props.data, context = props.context;
-    var operation = data.operation, securities = data.securities;
+    var operation = data.operation;
     var parameters = (_a = operation.parameters) !== null && _a !== void 0 ? _a : [];
-    var parameterGroups = groupParameters(parameters);
+    var parameterGroups = groupParameters(parameters, context);
+    var securities = 'securities' in data ? data.securities : [];
     return (<>
             {securities.length > 0 ? (<OpenAPISecurities key="securities" securities={securities} context={context}/>) : null}
 
@@ -19,18 +21,18 @@ export function OpenAPISpec(props) {
                     </StaticSection>);
         })}
 
-            {operation.requestBody ? (<OpenAPIRequestBody key="body" requestBody={operation.requestBody} context={context}/>) : null}
+            {operation.requestBody ? (<OpenAPIRequestBody key="body" requestBody={operation.requestBody} context={context} data={data}/>) : null}
             {operation.responses ? (<OpenAPIResponses key="responses" responses={operation.responses} context={context}/>) : null}
         </>);
 }
-function groupParameters(parameters) {
+function groupParameters(parameters, context) {
     var sorted = ['path', 'query', 'header'];
     var groups = [];
     parameters
         .filter(function (parameter) { return parameter.in; })
         .forEach(function (parameter) {
         var key = parameter.in;
-        var label = getParameterGroupName(parameter.in);
+        var label = getParameterGroupName(parameter.in, context);
         var group = groups.find(function (group) { return group.key === key; });
         if (group) {
             group.parameters.push(parameter);
@@ -46,14 +48,14 @@ function groupParameters(parameters) {
     groups.sort(function (a, b) { return sorted.indexOf(a.key) - sorted.indexOf(b.key); });
     return groups;
 }
-function getParameterGroupName(paramIn) {
+function getParameterGroupName(paramIn, context) {
     switch (paramIn) {
         case 'path':
-            return 'Path parameters';
+            return tString(context.translation, 'path_parameters');
         case 'query':
-            return 'Query parameters';
+            return tString(context.translation, 'query_parameters');
         case 'header':
-            return 'Header parameters';
+            return tString(context.translation, 'header_parameters');
         default:
             return paramIn;
     }

package/dist/OpenAPITabs.jsx

@@ -2,7 +2,7 @@
 import { createContext, useContext, useEffect, useMemo, useRef, useState } from 'react';
 import { Tab, TabList, TabPanel, Tabs } from 'react-aria-components';
 import { useEventCallback } from 'usehooks-ts';
-import { getOrCreateTabStoreByKey } from './useSyncedTabsGlobalState';
+import { getOrCreateStoreByKey } from './getOrCreateStoreByKey';
 var OpenAPITabsContext = createContext(null);
 function useOpenAPITabsContext() {
     var context = useContext(OpenAPITabsContext);
@@ -20,8 +20,8 @@ export function OpenAPITabs(props) {
     var _c = useState(function () {
         var _a, _b;
         if (stateKey && typeof window !== 'undefined') {
-            var store = getOrCreateTabStoreByKey(stateKey);
-            var tabKey_1 = store.getState().tabKey;
+            var store = getOrCreateStoreByKey(stateKey);
+            var tabKey_1 = store.getState().key;
             if (tabKey_1) {
                 return tabKey_1;
             }
@@ -44,11 +44,11 @@ export function OpenAPITabs(props) {
         if (!stateKey) {
             return undefined;
         }
-        var store = getOrCreateTabStoreByKey(stateKey);
+        var store = getOrCreateStoreByKey(stateKey);
         return store.subscribe(function (state) {
             var _a;
             (_a = cancelDeferRef.current) === null || _a === void 0 ? void 0 : _a.call(cancelDeferRef);
-            cancelDeferRef.current = defer(function () { return selectTab(state.tabKey); });
+            cancelDeferRef.current = defer(function () { return selectTab(state.key); });
         });
     }, [stateKey, selectTab]);
     useEffect(function () {
@@ -59,8 +59,8 @@ export function OpenAPITabs(props) {
             <Tabs className="openapi-tabs" onSelectionChange={function (tabKey) {
             selectTab(tabKey);
             if (stateKey) {
-                var store = getOrCreateTabStoreByKey(stateKey);
-                store.setState({ tabKey: tabKey });
+                var store = getOrCreateStoreByKey(stateKey);
+                store.setState({ key: tabKey });
             }
         }} selectedKey={tabKey}>
                 {children}
@@ -103,7 +103,7 @@ export function OpenAPITabsPanels() {
     }
     var key = selectedTab.key.toString();
     return (<TabPanel id={key} className="openapi-tabs-panel">
-            <div className="openapi-tabs-body">{selectedTab.body}</div>
-            {selectedTab.footer ? (<div className="openapi-tabs-footer">{selectedTab.footer}</div>) : null}
+            <div className="openapi-panel-body">{selectedTab.body}</div>
+            {selectedTab.footer ? (<div className="openapi-panel-footer">{selectedTab.footer}</div>) : null}
         </TabPanel>);
 }

package/dist/OpenAPIWebhook.d.ts

@@ -0,0 +1,10 @@
+import { type OpenAPIContextInput } from './context';
+import type { OpenAPIWebhookData } from './types';
+/**
+ * Display an interactive OpenAPI webhook.
+ */
+export declare function OpenAPIWebhook(props: {
+    className?: string;
+    data: OpenAPIWebhookData;
+    context: OpenAPIContextInput;
+}): import("react").JSX.Element;

package/dist/OpenAPIWebhook.jsx

@@ -0,0 +1,23 @@
+import clsx from 'clsx';
+import { OpenAPIWebhookExample } from './OpenAPIWebhookExample';
+import { OpenAPIColumnSpec } from './common/OpenAPIColumnSpec';
+import { OpenAPISummary } from './common/OpenAPISummary';
+import { resolveOpenAPIContext } from './context';
+/**
+ * Display an interactive OpenAPI webhook.
+ */
+export function OpenAPIWebhook(props) {
+    var className = props.className, data = props.data, contextInput = props.context;
+    var context = resolveOpenAPIContext(contextInput);
+    return (<div className={clsx('openapi-webhook', className)}>
+            <OpenAPISummary data={data} context={context}/>
+            <div className="openapi-columns">
+                <OpenAPIColumnSpec data={data} context={context}/>
+                <div className="openapi-column-preview">
+                    <div className="openapi-column-preview-body">
+                        <OpenAPIWebhookExample data={data} context={context}/>
+                    </div>
+                </div>
+            </div>
+        </div>);
+}

package/dist/OpenAPIWebhookExample.d.ts

@@ -0,0 +1,6 @@
+import { type OpenAPIContext } from './context';
+import type { OpenAPIWebhookData } from './types';
+export declare function OpenAPIWebhookExample(props: {
+    data: OpenAPIWebhookData;
+    context: OpenAPIContext;
+}): import("react").JSX.Element;

package/dist/OpenAPIWebhookExample.jsx

@@ -0,0 +1,41 @@
+import { OpenAPIEmptyExample } from './OpenAPIExample';
+import { OpenAPIMediaTypeContent } from './OpenAPIMediaType';
+import { getOpenAPIClientContext } from './context';
+import { getExamples } from './util/example';
+import { createStateKey } from './utils';
+export function OpenAPIWebhookExample(props) {
+    var data = props.data, context = props.context;
+    var operation = data.operation;
+    var items = (function () {
+        if (!operation.requestBody) {
+            return [];
+        }
+        return Object.entries(operation.requestBody.content).map(function (_a) {
+            var key = _a[0], value = _a[1];
+            var schema = value.schema;
+            if (!schema) {
+                return {
+                    key: key,
+                    label: key,
+                    body: <OpenAPIEmptyExample context={context}/>,
+                };
+            }
+            return {
+                key: key,
+                label: key,
+                body: <></>,
+                examples: getExamples({
+                    mediaTypeObject: value,
+                    mediaType: key,
+                    context: context,
+                }),
+            };
+        });
+    })();
+    return (<div className="openapi-panel">
+            <h4 className="openapi-panel-heading">Payload</h4>
+            <div className="openapi-panel-body">
+                <OpenAPIMediaTypeContent selectIcon={context.icons.chevronDown} stateKey={createStateKey('request-body-media-type', context.blockKey)} items={items} context={getOpenAPIClientContext(context)}/>
+            </div>
+        </div>);
+}

package/dist/ScalarApiButton.d.ts

@@ -1,4 +1,5 @@
 import type { OpenAPIV3_1 } from '@gitbook/openapi-parser';
+import type { OpenAPIClientContext } from './context';
 /**
  * Button which launches the Scalar API Client
  */
@@ -6,4 +7,5 @@ export declare function ScalarApiButton(props: {
     method: OpenAPIV3_1.HttpMethods;
     path: string;
     specUrl: string;
+    context: OpenAPIClientContext;
 }): import("react").JSX.Element;

package/dist/ScalarApiButton.jsx

@@ -3,11 +3,12 @@ import { ApiClientModalProvider, useApiClientModal } from '@scalar/api-client-re
 import { useEffect, useImperativeHandle, useMemo, useRef, useState } from 'react';
 import { createPortal } from 'react-dom';
 import { useOpenAPIOperationContext } from './OpenAPIOperationContext';
+import { t } from './translate';
 /**
  * Button which launches the Scalar API Client
  */
 export function ScalarApiButton(props) {
-    var method = props.method, path = props.path, specUrl = props.specUrl;
+    var method = props.method, path = props.path, specUrl = props.specUrl, context = props.context;
     var _a = useState(false), isOpen = _a[0], setIsOpen = _a[1];
     var controllerRef = useRef(null);
     return (<div className="scalar scalar-activate">
@@ -16,7 +17,7 @@ export function ScalarApiButton(props) {
             (_b = (_a = controllerRef.current) === null || _a === void 0 ? void 0 : _a.openClient) === null || _b === void 0 ? void 0 : _b.call(_a);
             setIsOpen(true);
         }}>
-                Test it
+                {t(context.translation, 'test_it')}
                 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 10 12" fill="currentColor">
                     <path stroke="currentColor" strokeWidth="1.5" d="M1 10.05V1.43c0-.2.2-.31.37-.22l7.26 4.08c.17.1.17.33.01.43l-7.26 4.54a.25.25 0 0 1-.38-.21Z"/>
                 </svg>
@@ -28,7 +29,7 @@ export function ScalarApiButton(props) {
 }
 function ScalarModal(props) {
     var method = props.method, path = props.path, specUrl = props.specUrl, controllerRef = props.controllerRef;
-    return (<ApiClientModalProvider configuration={{ spec: { url: specUrl } }} initialRequest={{ method: method, path: path }}>
+    return (<ApiClientModalProvider configuration={{ url: specUrl }} initialRequest={{ method: method, path: path }}>
             <ScalarModalController method={method} path={path} controllerRef={controllerRef}/>
         </ApiClientModalProvider>);
 }

package/dist/StaticSection.d.ts

@@ -3,8 +3,11 @@ export declare function Section(props: ComponentPropsWithoutRef<'div'>): import(
 export declare function SectionHeader(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
 export declare function SectionHeaderContent(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
 export declare const SectionBody: import("react").ForwardRefExoticComponent<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & import("react").RefAttributes<HTMLDivElement>>;
+export declare function SectionFooter(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
+export declare function SectionFooterContent(props: ComponentPropsWithoutRef<'div'>): import("react").JSX.Element;
 export declare function StaticSection(props: {
     className: string;
-    header: React.ReactNode;
+    header?: React.ReactNode;
     children: React.ReactNode;
+    footer?: React.ReactNode;
 }): import("react").JSX.Element;

package/dist/StaticSection.jsx

@@ -12,12 +12,21 @@ export function SectionHeaderContent(props) {
 export var SectionBody = forwardRef(function SectionBody(props, ref) {
     return (<div ref={ref} {...props} className={clsx('openapi-section-body', props.className && "".concat(props.className, "-body"))}/>);
 });
+export function SectionFooter(props) {
+    return (<div {...props} className={clsx('openapi-section-footer', props.className && "".concat(props.className, "-footer"))}/>);
+}
+export function SectionFooterContent(props) {
+    return (<div {...props} className={clsx('openapi-section-footer-content', props.className && "".concat(props.className, "-footer-content"))}/>);
+}
 export function StaticSection(props) {
-    var className = props.className, header = props.header, children = props.children;
+    var className = props.className, header = props.header, children = props.children, footer = props.footer;
     return (<Section className={className}>
-            <SectionHeader className={className}>
-                <SectionHeaderContent className={className}>{header}</SectionHeaderContent>
-            </SectionHeader>
+            {header ? (<SectionHeader className={className}>
+                    <SectionHeaderContent className={className}>{header}</SectionHeaderContent>
+                </SectionHeader>) : null}
             <SectionBody className={className}>{children}</SectionBody>
+            {footer ? (<SectionFooter className={className}>
+                    <SectionFooterContent className={className}>{footer}</SectionFooterContent>
+                </SectionFooter>) : null}
         </Section>);
 }

package/dist/code-samples.js

@@ -9,10 +9,44 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-import { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isPDF, isPlainObject, isText, isXML, } from './contentTypeChecks';
+import { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isJSON, isPDF, isPlainObject, isText, isXML, } from './contentTypeChecks';
 import { json2xml } from './json2xml';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 export var codeSampleGenerators = [
+    {
+        id: 'http',
+        label: 'HTTP',
+        syntax: 'bash',
+        generate: function (_a) {
+            var method = _a.method, url = _a.url, _b = _a.headers, headers = _b === void 0 ? {} : _b, body = _a.body;
+            var _c = parseHostAndPath(url), host = _c.host, path = _c.path;
+            if (body) {
+                // if we had a body add a content length header
+                var bodyContent = body ? stringifyOpenAPI(body) : '';
+                // handle unicode chars with a text encoder
+                var encoder = new TextEncoder();
+                var bodyString_1 = BodyGenerators.getHTTPBody(body, headers);
+                if (bodyString_1) {
+                    body = bodyString_1;
+                }
+                headers = __assign(__assign({}, headers), { 'Content-Length': encoder.encode(bodyContent).length.toString() });
+            }
+            if (!headers.hasOwnProperty('Accept')) {
+                headers.Accept = '*/*';
+            }
+            var headerString = headers
+                ? "".concat(Object.entries(headers)
+                    .map(function (_a) {
+                    var key = _a[0], value = _a[1];
+                    return key.toLowerCase() !== 'host' ? "".concat(key, ": ").concat(value) : '';
+                })
+                    .join('\n'), "\n")
+                : '';
+            var bodyString = body ? "\n".concat(body) : '';
+            var httpRequest = "".concat(method.toUpperCase(), " ").concat(decodeURI(path), " HTTP/1.1\nHost: ").concat(host, "\n").concat(headerString).concat(bodyString);
+            return httpRequest;
+        },
+    },
     {
         id: 'curl',
         label: 'cURL',
@@ -98,12 +132,16 @@ export var codeSampleGenerators = [
             if (headers && Object.keys(headers).length > 0) {
                 code += indent("headers=".concat(stringifyOpenAPI(headers), ",\n"), 4);
             }
+            var contentType = headers === null || headers === void 0 ? void 0 : headers['Content-Type'];
             if (body) {
                 if (body === 'files') {
                     code += indent("files=".concat(body, "\n"), 4);
                 }
+                else if (isJSON(contentType)) {
+                    code += indent("data=json.dumps(".concat(body, ")\n"), 4);
+                }
                 else {
-                    code += indent("data=".concat(stringifyOpenAPI(body), "\n"), 4);
+                    code += indent("data=".concat(body, "\n"), 4);
                 }
             }
             code += ')\n\n';
@@ -111,40 +149,6 @@ export var codeSampleGenerators = [
             return code;
         },
     },
-    {
-        id: 'http',
-        label: 'HTTP',
-        syntax: 'bash',
-        generate: function (_a) {
-            var method = _a.method, url = _a.url, _b = _a.headers, headers = _b === void 0 ? {} : _b, body = _a.body;
-            var _c = parseHostAndPath(url), host = _c.host, path = _c.path;
-            if (body) {
-                // if we had a body add a content length header
-                var bodyContent = body ? stringifyOpenAPI(body) : '';
-                // handle unicode chars with a text encoder
-                var encoder = new TextEncoder();
-                var bodyString_1 = BodyGenerators.getHTTPBody(body, headers);
-                if (bodyString_1) {
-                    body = bodyString_1;
-                }
-                headers = __assign(__assign({}, headers), { 'Content-Length': encoder.encode(bodyContent).length.toString() });
-            }
-            if (!headers.hasOwnProperty('Accept')) {
-                headers.Accept = '*/*';
-            }
-            var headerString = headers
-                ? "".concat(Object.entries(headers)
-                    .map(function (_a) {
-                    var key = _a[0], value = _a[1];
-                    return key.toLowerCase() !== 'host' ? "".concat(key, ": ").concat(value) : '';
-                })
-                    .join('\n'), "\n")
-                : '';
-            var bodyString = body ? "\n".concat(body) : '';
-            var httpRequest = "".concat(method.toUpperCase(), " ").concat(decodeURI(path), " HTTP/1.1\nHost: ").concat(host, "\n").concat(headerString).concat(bodyString);
-            return httpRequest;
-        },
-    },
 ];
 function indent(code, spaces) {
     var indent = ' '.repeat(spaces);
@@ -319,15 +323,29 @@ var BodyGenerators = {
             code += '}\n\n';
             body = 'files';
         }
-        if (isPDF(contentType)) {
+        else if (isPDF(contentType)) {
             code += 'files = {\n';
             code += "".concat(indent("\"file\": \"".concat(body, "\","), 4), "\n");
             code += '}\n\n';
             body = 'files';
         }
-        if (isXML(contentType)) {
+        else if (isXML(contentType)) {
             // Convert JSON to XML if needed
-            body = convertBodyToXML(body);
+            body = JSON.stringify(convertBodyToXML(body));
+        }
+        else {
+            body = stringifyOpenAPI(body, function (_key, value) {
+                switch (value) {
+                    case true:
+                        return '$$__TRUE__$$';
+                    case false:
+                        return '$$__FALSE__$$';
+                    default:
+                        return value;
+                }
+            })
+                .replaceAll('"$$__TRUE__$$"', 'True')
+                .replaceAll('"$$__FALSE__$$"', 'False');
         }
         return { body: body, code: code, headers: headers };
     },

package/dist/common/OpenAPIColumnSpec.d.ts

@@ -0,0 +1,6 @@
+import { type OpenAPIContext } from '../context';
+import type { OpenAPIOperationData, OpenAPIWebhookData } from '../types';
+export declare function OpenAPIColumnSpec(props: {
+    data: OpenAPIOperationData | OpenAPIWebhookData;
+    context: OpenAPIContext;
+}): import("react").JSX.Element;

package/dist/common/OpenAPIColumnSpec.jsx

@@ -0,0 +1,20 @@
+import { OpenAPISpec } from '../OpenAPISpec';
+import { getOpenAPIClientContext } from '../context';
+import { t } from '../translate';
+import { OpenAPIOperationDescription } from './OpenAPIOperationDescription';
+export function OpenAPIColumnSpec(props) {
+    var data = props.data, context = props.context;
+    var operation = data.operation;
+    var clientContext = getOpenAPIClientContext(context);
+    return (<div className="openapi-column-spec">
+            {operation['x-deprecated-sunset'] ? (<div className="openapi-deprecated-sunset openapi-description openapi-markdown">
+                    {t(context.translation, 'deprecated_and_sunset_on', [
+                <span key="date" className="openapi-deprecated-sunset-date">
+                            {operation['x-deprecated-sunset']}
+                        </span>,
+            ])}
+                </div>) : null}
+            <OpenAPIOperationDescription operation={operation} context={context}/>
+            <OpenAPISpec data={data} context={clientContext}/>
+        </div>);
+}

package/dist/common/OpenAPIOperationDescription.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAPICustomOperationProperties, OpenAPIV3 } from '@gitbook/openapi-parser';
+import type { OpenAPIContext } from '../context';
+export declare function OpenAPIOperationDescription(props: {
+    operation: OpenAPIV3.OperationObject<OpenAPICustomOperationProperties>;
+    context: OpenAPIContext;
+}): import("react").JSX.Element | null;

package/dist/common/OpenAPIOperationDescription.jsx

@@ -0,0 +1,19 @@
+import { Markdown } from '../Markdown';
+import { resolveDescription } from '../utils';
+export function OpenAPIOperationDescription(props) {
+    var operation = props.operation;
+    if (operation['x-gitbook-description-document']) {
+        return (<div className="openapi-intro">
+                {props.context.renderDocument({
+                document: operation['x-gitbook-description-document'],
+            })}
+            </div>);
+    }
+    var description = resolveDescription(operation);
+    if (!description) {
+        return null;
+    }
+    return (<div className="openapi-intro">
+            <Markdown className="openapi-description" source={description}/>
+        </div>);
+}

package/dist/common/OpenAPIStability.d.ts

@@ -0,0 +1,4 @@
+import type { OpenAPIStability as OpenAPIStabilityType } from '@gitbook/openapi-parser';
+export declare function OpenAPIStability(props: {
+    stability: OpenAPIStabilityType;
+}): import("react").JSX.Element | null;

package/dist/common/OpenAPIStability.jsx

@@ -0,0 +1,15 @@
+var stabilityEnum = {
+    experimental: 'Experimental',
+    alpha: 'Alpha',
+    beta: 'Beta',
+};
+export function OpenAPIStability(props) {
+    var stability = props.stability;
+    var foundStability = stabilityEnum[stability];
+    if (!foundStability) {
+        return null;
+    }
+    return (<div className={"openapi-stability openapi-stability-".concat(foundStability.toLowerCase())}>
+            {foundStability}
+        </div>);
+}

package/dist/common/OpenAPISummary.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAPIContext } from '../context';
+import type { OpenAPIOperationData, OpenAPIWebhookData } from '../types';
+export declare function OpenAPISummary(props: {
+    data: OpenAPIOperationData | OpenAPIWebhookData;
+    context: OpenAPIContext;
+}): import("react").JSX.Element;

package/dist/common/OpenAPISummary.jsx

@@ -0,0 +1,30 @@
+import { OpenAPIPath } from '../OpenAPIPath';
+import { OpenAPIStability } from './OpenAPIStability';
+export function OpenAPISummary(props) {
+    var _a;
+    var data = props.data, context = props.context;
+    var operation = data.operation;
+    var title = (function () {
+        if (operation.summary) {
+            return operation.summary;
+        }
+        if ('name' in data) {
+            return data.name;
+        }
+        return undefined;
+    })();
+    return (<div className="openapi-summary" id={operation.summary ? undefined : context.id}>
+            {(operation.deprecated || operation['x-stability']) && (<div className="openapi-summary-tags">
+                    {operation.deprecated && <div className="openapi-deprecated">Deprecated</div>}
+                    {operation['x-stability'] && (<OpenAPIStability stability={operation['x-stability']}/>)}
+                </div>)}
+            {title
+            ? context.renderHeading({
+                deprecated: (_a = operation.deprecated) !== null && _a !== void 0 ? _a : false,
+                stability: operation['x-stability'],
+                title: title,
+            })
+            : null}
+            {'path' in data ? <OpenAPIPath data={data} context={context}/> : null}
+        </div>);
+}

package/dist/context.d.ts

@@ -0,0 +1,75 @@
+import { type Translation, type TranslationLocale } from './translations';
+export interface OpenAPIClientContext {
+    /**
+     * The translation language to use.
+     */
+    translation: Translation;
+    /**
+     * Icons used in the block.
+     */
+    icons: {
+        chevronDown: React.ReactNode;
+        chevronRight: React.ReactNode;
+        plus: React.ReactNode;
+    };
+    /**
+     * Force all sections to be opened by default.
+     * @default false
+     */
+    defaultInteractiveOpened?: boolean;
+    /**
+     * The key of the block
+     */
+    blockKey?: string;
+    /**
+     * Optional id attached to the heading and used as an anchor.
+     */
+    id?: string;
+    /**
+     * Mark the context as a client context.
+     */
+    $$isClientContext$$: true;
+}
+export interface OpenAPIContext extends Omit<OpenAPIClientContext, '$$isClientContext$$'> {
+    /**
+     * Render a code block.
+     */
+    renderCodeBlock: (props: {
+        code: string;
+        syntax: string;
+    }) => React.ReactNode;
+    /**
+     * Render the heading of the operation.
+     */
+    renderHeading: (props: {
+        deprecated: boolean;
+        title: string;
+        stability?: string;
+    }) => React.ReactNode;
+    /**
+     * Render the document of the operation.
+     */
+    renderDocument: (props: {
+        document: object;
+    }) => React.ReactNode;
+    /**
+     * Specification URL.
+     */
+    specUrl: string;
+}
+export type OpenAPIUniversalContext = OpenAPIClientContext | OpenAPIContext;
+export interface OpenAPIContextInput extends Omit<OpenAPIContext, 'translation'> {
+    /**
+     * The translation language to use.
+     * @default 'en'
+     */
+    locale?: TranslationLocale | undefined;
+}
+/**
+ * Resolve OpenAPI context from the input.
+ */
+export declare function resolveOpenAPIContext(context: OpenAPIContextInput): OpenAPIContext;
+/**
+ * Get the client context from the OpenAPI context.
+ */
+export declare function getOpenAPIClientContext(context: OpenAPIUniversalContext): OpenAPIClientContext;