nexus-agents - v2.80.0
    Preparing search index...

    Interface ApiEndpoint

    API endpoint documentation.

    interface ApiEndpoint {
        name: string;
        description: string;
        parameters: {
            name: string;
            type: string;
            description: string;
            required: boolean;
        }[];
        returns: { type: string; description: string };
        example?: string;
    }
    Index

    Properties

    name: string

    Endpoint name

    description: string

    Description

    parameters: {
        name: string;
        type: string;
        description: string;
        required: boolean;
    }[]

    Parameters

    returns: { type: string; description: string }

    Return type

    example?: string

    Example usage