@squidcloud/client
    Preparing search index...

    Interface ApiRequestField

    Describes a field included in an API request, including its location, optional description, and whether it is required.

    interface ApiRequestField {
        description?: string;
        location: ApiParameterLocation;
        required?: boolean;
    }
    Index

    Properties

    description?: string

    An optional description of the field's purpose or usage.

    The location of the field in the API request (e.g., query, body, header, path).

    required?: boolean

    Indicates whether the field is mandatory for the request.