Libraries
    Preparing search index...

    Interface LinkDefinition<TResponse>

    A link from a response to a follow-up operation.

    https://spec.openapis.org/oas/v3.1.0#link-object

    interface LinkDefinition<TResponse = any> {
        description?: string;
        operationId: string;
        parameters?:
            | Record<string, string>
            | (
                (
                    response: TResponse extends ObjectSchemaBuilder<
                        any,
                        any,
                        any,
                        any,
                        any,
                        {},
                        [],
                    >
                        ? PropertyDescriptorTree<TResponse, TResponse>
                        : PropertyRefTree<any>,
                ) => Record<string, unknown>
            );
        requestBody?: string;
    }

    Type Parameters

    • TResponse = any
    Index

    Properties

    description? operationId parameters? requestBody?

    Properties

    description?: string

    Human-readable description of the link relationship.

    operationId: string

    operationId of the target operation.

    parameters?:
        | Record<string, string>
        | (
            (
                response: TResponse extends ObjectSchemaBuilder<
                    any,
                    any,
                    any,
                    any,
                    any,
                    {},
                    [],
                >
                    ? PropertyDescriptorTree<TResponse, TResponse>
                    : PropertyRefTree<any>,
            ) => Record<string, unknown>
        )

    Map of target parameter names to values.

    • Record<string, string> — raw OpenAPI runtime expressions such as '$response.body#/id'.
    • Callback (response: PropertyRefTree<TResponse>) => Record<string, unknown> — type-safe selector; properties accessed on response are converted to $response.body#/<pointer> expressions automatically.
    requestBody?: string

    Runtime expression or literal for the linked operation's request body.

    Settings

    Member Visibility

    On This Page

    Properties