@squidcloud/client
    Preparing search index...

    Interface GenerateAiDescriptionsForEndpointsRequest<SchemaType>

    Request for generating AI descriptions for API endpoints.

    interface GenerateAiDescriptionsForEndpointsRequest<
        SchemaType = Record<string, any>,
    > {
        endpoints?: string[];
        instructions?: string;
        schema: SchemaType;
    }

    Type Parameters

    • SchemaType = Record<string, any>
    Index

    Properties

    endpoints? instructions? schema

    Properties

    endpoints?: string[]

    List of endpoint IDs to generate descriptions for. If not provided or empty, descriptions will be generated for all endpoints.

    instructions?: string

    Optional instructions to guide the AI in generating descriptions.

    schema: SchemaType

    The current API schema containing endpoints.

    Settings

    Member Visibility

    On This Page

    Properties