@redocly/theme/lib/ext/configure.d.ts

Shared UI components lib

import type { UserClaims, OpenAPIServer } from '../core/types';
export type SecurityDetails = {
    password?: string;
    username?: string;
    token?: {
        token_type?: string;
        access_token: string;
    };
    client_id?: string;
    client_secret?: string;
    scopes?: string[];
};
export type ConfigureRequestValues = {
    headers?: Record<string, string>;
    body?: Record<string, any>;
    query?: Record<string, string>;
    path?: Record<string, string>;
    cookie?: Record<string, string>;
    security?: Record<string, SecurityDetails>;
    envVariables?: Record<string, string>;
    serverVariables?: Record<string, string>;
};
export type ConfigureServerRequestValues = {
    [serverUrl: string]: ConfigureRequestValues;
};
type Configure = {
    requestValues?: ConfigureRequestValues | ConfigureServerRequestValues;
};
type ContextProps = {
    userClaims?: UserClaims;
    operation: {
        name: string;
        path: string;
        operationId?: string;
        href?: string;
        method: string;
    };
    servers: OpenAPIServer[];
};
export declare function configure(_context: ContextProps): Configure;
export {};