Vue OpenAPI Query Documentation
    Preparing search index...

    Interface EndpointConfig

    Runtime configuration for a single endpoint. Passed directly to useEndpointQuery / useEndpointMutation by generated code.

    Created by the generated createApiClient factory and embedded per-operation in the generated api-client.ts.

    interface EndpointConfig {
        axios: AxiosInstance;
        queryClient: QueryClient;
        path: string;
        method: HttpMethod;
        listPath?: string | null;
        operationsRegistry?: Readonly<Record<string, { path: string }>>;
        operationId?: string;
    }
    Index

    Properties

    axios queryClient path method listPath? operationsRegistry? operationId?

    Properties

    axios: AxiosInstance
    queryClient: QueryClient
    path: string

    The OpenAPI path template, e.g. /pets/{petId}

    method: HttpMethod
    listPath?: string | null

    Pre-computed list path for cache invalidation after mutations. e.g. for updatePet at /pets/{petId}, this would be /pets. null means no list invalidation. Generated at code-gen time by the CLI.

    operationsRegistry?: Readonly<Record<string, { path: string }>>

    Registry of all operations' paths, used to resolve invalidateOperations option at mutation time. Generated and embedded by the CLI.

    operationId?: string

    The OpenAPI operationId for this operation. Provided by generated code; used to populate ApiErrorContext.operationId in the error policy. When absent, the policy falls back to "METHOD /path/template".

    Settings

    Member Visibility

    On This Page

    Properties